Python CLI to generate release notes by scanning a repo's pull requests descriptions.
Expects PR descriptions to have format specified in the pull_request_template.md
file
in this repo.
Must have Python and pip installed.
It is recommended to install this tool globally, rather than in each virtualenv. So run this with system-wide pip:
pip install --user --editable git+https://github.com/uc-cdis/release-helper.git@master#egg=gen3git
You may need to add the bin
directory under "user base" to your PATH
, for example:
echo "export PATH=\"`python -m site --user-base`/bin:\$PATH\"" >> ~/.bash_profile
(Or alternatively, you may use sudo pip install
without --user
and PATH trouble)
Then you are ready to create auto-annotated tags:
gen3git tag 2.1.3
Or generate release notes into files (this example generates all supported outputs):
gen3git gen --html --markdown --text
It also works as a Travis after-deploy hook to update release notes into the GitHub release that triggered the deploy:
deploy:
on:
tags: true
env:
global:
secure: encrypted GH_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN here
after_deploy:
- gen3git release
More options are available for the gen3git
CLI.
gen3git --help
You only need access token for private repos or workaround GitHub rate limit. The token should be provided by setting GH_TOKEN
or GITHUB_TOKEN
. This script should be able to read from public repos without it.