Skip to content

Commit

Permalink
feat(readme): add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfbecker committed Sep 10, 2018
1 parent e6ef3b0 commit 3065cc7
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,11 @@ async function main(): Promise<void> {
'',
...(hasTests ? ['## Test', '```', 'npm test', '```'] : []),
'',
'## Release',
'Releases are done automatically in CI when commits are merged into master by analyzing [Conventional Commit Messages](https://conventionalcommits.org/).',
'After running `npm install`, commit messages will be linted automatically when committing though a git hook.',
"The git hook can be circumvented for fixup commits with [git's `fixup!` autosquash feature](https://fle.github.io/git-tip-keep-your-branch-clean-with-fixup-and-autosquash.html), or by passing `--no-verify` to `git commit`.",
'You may have to rebase a branch before merging to ensure it has a proper commit history, or squash merge with a manually edited commit message that conforms to the convention.',
].join('\n')
await writeFile('README.md', readme)
}
Expand Down

0 comments on commit 3065cc7

Please sign in to comment.