Releasing Kward
Release steps that can be completed before publishing:
- Update
CHANGELOG.mdfor the version. - Update
Kward::VERSIONinlib/kward/version.rb. - Run the test suite:
bundle exec rake test
- Generate documentation:
bundle exec rake rdoc
bundle exec yard doc
- Build the gem locally:
gem build kward.gemspec
- Inspect the packaged files and confirm no local config, sessions, logs, or secrets are included.
- Install the built gem locally and smoke test the
kwardexecutable.
RubyGems setup before the first public release:
- Create or sign in to a RubyGems.org account.
- Enable multi-factor authentication for the account.
- Confirm the
kwardgem name is available. - Add final homepage, source code, changelog, documentation, and bug tracker metadata to
kward.gemspeconce the public repository URLs are final. - Prefer RubyGems trusted publishing for automated releases so long-lived API keys do not need to be stored in CI secrets.
- Push the built gem or publish through the trusted publishing workflow.