Labelling Issues and Pull Requests and Creating Release Notes

Issue and PR Labelling

The release notes for this project are generated using github-changelog-generator. To avoid duplicate entries in the changelog, we need to ignore PRs if there is a corresponding closed issue.

This cannot be done automatically, so we follow these steps:

• Check the issue links to the PR that closed it. This will happen automatically if the PR contains the right words in the commit message. Otherwise, add a
  comment linking to the PR.
• Label the PR with "has-matching-issue".

If the PR doesn't have a matching issue, ensure the PR has a suitable label (e.g. bug, enhancement).

Choice of Label

• Enhancement is reserved for new capabilities that the end user can enjoy.
• Bug is for everything else.

Generating Release Notes

Install the changelog generator (see link above) and run the following command, where v1.2.3 is the release you are about to tag:

github_changelog_generator -u ThalesIgnite -p crypto11 --exclude-labels "has issue" \
  --unreleased-only --future-release v1.2.3

This produces CHANGELOG.md in the current directory, which is then used as the release notes.