your-repository/
└── .github/
├── scripts/
│ ├── utils/
│ │ └── utils.py
│ ├── pr_validator.py
│ └── releaser.py
├── workflows/
│ ├── initiate-release.yaml
│ ├── pr-validator.yaml
│ └── releaser.yaml
├── pull_request_template.md
├── release_template.md
└── release.yml
Label | Description |
---|---|
help |
Request for help on slack |
ignore |
No need to include these pull requests in the GitHub release |
release |
Automated pull request for a new release |
type/breaking |
Pull Requests that mention breaking changes or deprecations |
type/bugfix |
Pull requests for addressing a fix for a bug |
type/chore |
Pull requests for addressing refactoring, documentation, etc |
type/enhancement |
Pull requests suggesting improvements to an existing feature |
type/feature |
Pull requests proposing the addition of a new feature |
- Clone this repository
$ git clone https://github.com/chandratop/release-note-generator.git
- Store the path to this repo in a variable
export RNG="/path/to/release-note-generator/.github/"
- Navigate to your repository
$ cd /path/to/your-repository
- Copy the necessary artifacts in your repository
rsync -av $RNG .github/
- To clone all the labels, first delete all the existing labels from the destination repo. Then run the following script which we copied in the previous step.
cd .github/scripts/
chmod +x copy-labels.sh
./copy-labels.sh <destination-repo-name> <destination-repo-name>
If you would like to perform additional tag replacements, go to .github/scripts/releaser.py
and search for the following section and edit it.
#TODO: update any additional files with the new release tag
additional_files = ["releases.yaml"]