Documentation

CLI doc

See Usage.

Library doc

The output directory of the library documentation will be docs/yard.

You can consult it online on GitHub or on RubyDoc.

Building locally: for library users

For developers who only want to use the library.

bundle exec yard doc

Serve locally

Serve with live reload:

bundle exec yard server --reload

Documentation available at: http://localhost:8808/

Publishing

Check the linter:

bundle exec rubocop -a

Update the version in lib/adassault/version.rb.

Update the documentation, at least:

• README.md to add new features
• docs/CHANGELOG.md to document the changes
• docs/pages/usage.md adding examples of usage and explaining why implementing the command was necessary

On new release don't forget to rebuild the library documentation:

bundle exec yard doc

Create an annotated git tag:

git tag -a x.x.x

Push the changes including the tags:

git push --follow-tags

Build the gem:

gem build adassault.gemspec

Push the new gem release on RubyGems. See https://guides.rubygems.org/publishing/.

gem push adassault-x.x.x.gem