@@ -17,7 +17,8 @@ Bootstrap a new Ruby gem in five minutes or less.
1717- [ Standard] Ruby style guide, linter, and formatter.
1818- Productive and fun testing with [ RSpec] .
1919- Code coverage reporting with [ SimpleCov] .
20- - Continuous testing and gem publishing with [ GitHub Actions] .
20+ - Fully automated version management and package publishing with [ semantic-release] .
21+ - Continuous checks and tests with [ GitHub Actions] .
2122- [ Keep a CHANGELOG] .
2223- Consistent coding with [ EditorConfig] .
2324- Badges from [ Shields.io] .
@@ -32,6 +33,7 @@ Bootstrap a new Ruby gem in five minutes or less.
3233[ rspec ] : https://rspec.info/
3334[ ruby ] : https://www.ruby-lang.org/
3435[ rubygems.org ] : https://rubygems.org/
36+ [ semantic-release ] : https://semantic-release.gitbook.io/semantic-release/
3537[ shields.io ] : https://shields.io/
3638[ simplecov ] : https://github.com/simplecov-ruby/simplecov
3739[ standard ] : https://github.com/testdouble/standard
@@ -173,12 +175,30 @@ $ bundle install
173175
174176### Publishing
175177
178+ #### Automatic
179+
180+ New versions are released automatically with [ semantic-release]
181+ as long as commits follow the [ Angular Commit Message Conventions] .
182+
183+ [ Angular Commit Message Conventions ] : https://semantic-release.gitbook.io/semantic-release/#commit-message-format
184+ [ semantic-release ] : https://semantic-release.gitbook.io/
185+
186+ #### Manual
187+
176188Use [ gem release] to release a new version.
177189
178- Publishing may be triggered using a [ workflow_dispatch on GitHub Actions] .
190+ Publish a new version by triggering a [ version workflow_dispatch on GitHub Actions] .
191+ The ` version ` input will be passed as the first argument to [ npm-version] .
192+
193+ This may be done on the web or using the [ GitHub CLI] with
194+
195+ ```
196+ $ gh workflow run version.yml --raw-field version=<version>
197+ ```
179198
180199[ gem release ] : https://github.com/svenfuchs/gem-release
181- [ workflow_dispatch on github actions ] : https://github.com/makenew/rbgem/actions?query=workflow%3Aversion
200+ [ GitHub CLI ] : https://cli.github.com/
201+ [ version workflow_dispatch on GitHub Actions ] : https://github.com/seamapi/javascript-http/actions?query=workflow%3Aversion
182202
183203## GitHub Actions
184204
@@ -192,7 +212,7 @@ These must be set manually.
192212
193213### Secrets for Optional GitHub Actions
194214
195- The version and format GitHub actions
215+ The version, format, generate, and semantic-release GitHub actions
196216require a user with write access to the repository.
197217Set these additional secrets to enable the action:
198218
0 commit comments