This branch's sole purpose is to serve as Documentation for the Enceladus project.
- ruby >= 2.3.0
# In the root of the project
$> git checkout gh-pages
$> bundle install
$> bundle exec jekyll serve
# => Now browse to http://localhost:4000
ruby utils/create_docs.rb <version>
A Ruby script to generate release notes.
Usage: ruby utils/get_release_notes.rb VERSION [options]
Specific options:
--github-token TOKEN Github token. Can be specified using environment variable GITHUB_TOKEN or in get_release_notes.json in resources using github_token key
--zenhub-token TOKEN Zenhub token. This means we will use Release object for release notes. You don't have to use --use-zenhub in case you do this. Can be specified using environment variable ZENHUB_TOKEN or in get_release_notes.json in resources using zenhub_token key
-z, --use-zenhub Run using zenhub. It needs zenhub token set. If you use --zenhub-token option, you don't need to use this. This means we will use Release object for release notes.
--organization ORGANIZATION Github Organization
--repository REPOSITORY Github Repository name
--repository-id REPOSITORYID Zenhub Repository ID
--zenhub-url ZENURL Zenhub API URL
--github-url GITURL Github API URL
-p, --[no-]print-empty Should Issue with no release notes comment be included in the output file
--[no-]print-only-title Should Issue with no release notes comment be preceeded with 'Couldn't find comment'
-s, --[no-]strict Treats warnings as errors
-h, --help Show this message