Skip to content

Commit e525f14

Browse files
committed
Add note on automatic version publishing
1 parent d1fbf62 commit e525f14

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,13 +182,30 @@ $ npm install
182182

183183
### Publishing
184184

185-
Use the [`npm version`][npm-version] command to release a new version.
186-
This will push a new git tag which will trigger a GitHub action.
185+
New versions are created with [`npm version`][npm-version].
187186

188-
Publishing may be triggered using a [workflow_dispatch on GitHub Actions].
187+
#### Automatic
189188

189+
New versions are released automatically with [semantic-release]
190+
as long as commits follow the [Angular Commit Message Conventions].
191+
192+
[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
193+
[semantic-release]: https://semantic-release.gitbook.io/
194+
195+
#### Manual
196+
197+
Publish a new version by triggering a [version workflow_dispatch on GitHub Actions].
198+
The `version` input will be passed as the first argument to [npm-version].
199+
200+
This may be done on the web or using the [GitHub CLI] with
201+
202+
```
203+
$ gh workflow run version.yml --raw-field version=<version>
204+
```
205+
206+
[GitHub CLI]: https://cli.github.com/
190207
[npm-version]: https://docs.npmjs.com/cli/version
191-
[workflow_dispatch on GitHub Actions]: https://github.com/makenew/tsmodule/actions?query=workflow%3Aversion
208+
[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/javascript-http/actions?query=workflow%3Aversion
192209

193210
## GitHub Actions
194211

0 commit comments

Comments
 (0)