Skip to content
Kward

Releasing Kward

Release steps before publishing:

  1. Update CHANGELOG.md for the version.
  2. Update Kward::VERSION in lib/kward/version.rb.
  3. Run the test suite:
   bundle exec rake test
  1. Preview docs locally if you changed documentation or public APIs:
   bundle exec rake docs:serve

The preview builds _yardoc/, serves it with WEBrick, and rebuilds in a fresh process when documentation sources, library code, or templates change. Refresh your browser after rebuilds.

  1. Generate and check documentation:
   bundle exec rake rdoc
   bundle exec rake docs:build
   bundle exec rake docs:check

docs:check validates generated internal links, images, and scripts. Pushes to main deploy the generated YARD site to GitHub Pages.

  1. Build the gem locally:
   gem build kward.gemspec
  1. Inspect the packaged files and confirm no local config, sessions, logs, or secrets are included.
  2. Install the built gem locally and smoke test the kward executable.

Publish the built gem from the release checkout:

gem push kward-VERSION.gem

RubyGems MFA is required for publishing. Prefer RubyGems trusted publishing for automated releases if CI publishing is added later, so long-lived API keys do not need to be stored in CI secrets.