Skip to content

Commit 3065cc7

Browse files
committed
feat(readme): add release instructions
cc @beyang @sqs
1 parent e6ef3b0 commit 3065cc7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/cli.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,11 @@ async function main(): Promise<void> {
360360
'',
361361
...(hasTests ? ['## Test', '```', 'npm test', '```'] : []),
362362
'',
363+
'## Release',
364+
'Releases are done automatically in CI when commits are merged into master by analyzing [Conventional Commit Messages](https://conventionalcommits.org/).',
365+
'After running `npm install`, commit messages will be linted automatically when committing though a git hook.',
366+
"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`.",
367+
'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.',
363368
].join('\n')
364369
await writeFile('README.md', readme)
365370
}

0 commit comments

Comments
 (0)