release-helper
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.
Quickstart
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
Details
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.
1 maintainer
Metadata
1 maintainer
Release files for gen3git 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gen3git-0.8.1.tar.gz | 11.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gen3git-0.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.2 kB
Release files / gen3git-0.8.1.tar.gz
| Download URL | gen3git-0.8.1.tar.gz |
|---|---|
| Size | 11.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dee20df8c5bdc2b5599b969479cfb428355ebf3855aef43567b5c4f292922968
|
|
BLAKE2b-256 checksum How to use checksums |
8826cde54c06d50c1b586691461deeaa886b4b175bbb5a2781b6393dc162ac1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.13.11 Linux/6.11.0-1018-azure
|
Release files / gen3git-0.8.1-py3-none-any.whl
| Download URL | gen3git-0.8.1-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b6f0a79e84dc5799314d42a2e0ac7cc16639205135f8b14107790a3782835c8d
|
|
BLAKE2b-256 checksum How to use checksums |
2a532ff4161d11481f6ecf73be2e4379b65373804a399926873ad9be1f8c584f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.13.11 Linux/6.11.0-1018-azure
|
