@@ -20,12 +20,14 @@ Bootstrap a new TypeScript module in five minutes or less.
2020- [ Prettier] code.
2121- Futuristic debuggable unit testing with [ AVA] .
2222- Code coverage reporting with [ Istanbul] and [ c8] .
23+ - Fully automated version management and package publishing with [ semantic-release] and [ Conventional Commits] .
2324- Continuous testing and package publishing with [ GitHub Actions] .
2425- Consistent coding with [ EditorConfig] .
2526- Get PR reviews directly from [ code owners] .
2627
2728[ AVA ] : https://github.com/avajs/ava
2829[ code owners ] : https://github.blog/2017-07-06-introducing-code-owners/
30+ [ Conventional Commits ] : https://www.conventionalcommits.org/
2931[ ECMAScript module ] : https://nodejs.org/api/esm.html
3032[ ESLint ] : https://eslint.org/
3133[ EditorConfig ] : https://editorconfig.org/
@@ -35,6 +37,7 @@ Bootstrap a new TypeScript module in five minutes or less.
3537[ JavaScript Standard Style ] : https://standardjs.com/
3638[ Node.js ] : https://nodejs.org/
3739[ Prettier ] : https://prettier.io/
40+ [ semantic-release ] : https://semantic-release.gitbook.io/
3841[ TypeScript ] : https://www.typescriptlang.org/
3942[ c8 ] : https://github.com/bcoe/c8
4043[ landlubber ] : https://github.com/razor-x/landlubber
@@ -172,6 +175,16 @@ $ npm install
172175
173176### Publishing
174177
178+ #### Automatic
179+
180+ New versions are released automatically with [ semantic-release] .
181+ as long as commits follow the [ Conventional Commits] specification.
182+
183+ [ Conventional Commits ] : https://www.conventionalcommits.org/
184+ [ semantic-release ] : https://semantic-release.gitbook.io/
185+
186+ #### Manual
187+
175188Publish a new version by triggering a [ version workflow_dispatch on GitHub Actions] .
176189The ` version ` input will be passed as the first argument to [ npm-version] .
177190
@@ -203,6 +216,9 @@ The following repository secrets must be set on [GitHub Actions]:
203216
204217## Contributing
205218
219+ > If using squash merge, edit and ensure the commit message follows the [ Conventional Commits] specification.
220+ > Otherwise, each individual commit must follow the [ Conventional Commits] specification.
221+
2062221 . Create your feature branch (` git checkout -b my-new-feature ` ).
2072232 . Make changes.
2082243 . Commit your changes (` git commit -am 'Add some feature' ` ).
@@ -213,6 +229,8 @@ The following repository secrets must be set on [GitHub Actions]:
2132298 . Wait for the required approval from the code owners.
2142309 . Merge when ready.
215231
232+ [ Conventional Commits ] : https://www.conventionalcommits.org/
233+
216234## License
217235
218236This npm package is Copyright (c) 2021-2023 Seam Labs, Inc.
0 commit comments