@@ -20,12 +20,14 @@ Bootstrap a new TypeScript module in five minutes or less.
20
20
- [ Prettier] code.
21
21
- Futuristic debuggable unit testing with [ AVA] .
22
22
- Code coverage reporting with [ Istanbul] and [ c8] .
23
+ - Fully automated version management and package publishing with [ semantic-release] and [ Conventional Commits] .
23
24
- Continuous testing and package publishing with [ GitHub Actions] .
24
25
- Consistent coding with [ EditorConfig] .
25
26
- Get PR reviews directly from [ code owners] .
26
27
27
28
[ AVA ] : https://github.com/avajs/ava
28
29
[ code owners ] : https://github.blog/2017-07-06-introducing-code-owners/
30
+ [ Conventional Commits ] : https://www.conventionalcommits.org/
29
31
[ ECMAScript module ] : https://nodejs.org/api/esm.html
30
32
[ ESLint ] : https://eslint.org/
31
33
[ EditorConfig ] : https://editorconfig.org/
@@ -35,6 +37,7 @@ Bootstrap a new TypeScript module in five minutes or less.
35
37
[ JavaScript Standard Style ] : https://standardjs.com/
36
38
[ Node.js ] : https://nodejs.org/
37
39
[ Prettier ] : https://prettier.io/
40
+ [ semantic-release ] : https://semantic-release.gitbook.io/
38
41
[ TypeScript ] : https://www.typescriptlang.org/
39
42
[ c8 ] : https://github.com/bcoe/c8
40
43
[ landlubber ] : https://github.com/razor-x/landlubber
@@ -172,6 +175,16 @@ $ npm install
172
175
173
176
### Publishing
174
177
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
+
175
188
Publish a new version by triggering a [ version workflow_dispatch on GitHub Actions] .
176
189
The ` version ` input will be passed as the first argument to [ npm-version] .
177
190
@@ -203,6 +216,9 @@ The following repository secrets must be set on [GitHub Actions]:
203
216
204
217
## Contributing
205
218
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
+
206
222
1 . Create your feature branch (` git checkout -b my-new-feature ` ).
207
223
2 . Make changes.
208
224
3 . Commit your changes (` git commit -am 'Add some feature' ` ).
@@ -213,6 +229,8 @@ The following repository secrets must be set on [GitHub Actions]:
213
229
8 . Wait for the required approval from the code owners.
214
230
9 . Merge when ready.
215
231
232
+ [ Conventional Commits ] : https://www.conventionalcommits.org/
233
+
216
234
## License
217
235
218
236
This npm package is Copyright (c) 2021-2023 Seam Labs, Inc.
0 commit comments