Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate release note #292

merged 7 commits into from Aug 8, 2019


Copy link

commented Aug 8, 2019

[UNVERSIONED] Auto-generate release note by @hanslovsky

Add a kscript that auto-generates release notes from pull request messages:

  1. Scan commits from current HEAD to tag with latest version smaller than current (SNAPSHOT) version.
  2. Filter all commit messages
  3. In each commit message, look for any of these tags, encapuslated in brackets [$TAG]:
    • BUGFIX

The script will suggest a new SemVer version based on the presence of these tags (UNVERSIONED will not increase the version). For example, if HEAD was on 8018669, the output would be:

$ ./create-changelog.kts
# Paintera 0.18.0
Previous release: 0.18.0

## Changelog

### Other
 - Merge pull request #290 from uschmidt83/patch-1: Typo in Readme

## Pull Requests

### #290
Merge pull request #290 from uschmidt83/patch-1

Typo in Readme

It is the maintainers' (@saalfeldlab/lab @saalfeldlab/paintera @saalfeldlab/paintera-admin ) responsibility to add appropriate tags to the commit message when clicking the merge button.

A good workflow to trigger a new Paintera release would then be:

git checkout master && git pull
./create-changelog.kts >
# modify if necessary
scijava-scripts/ # use version suggested by the changelog script if appropriate
# add changelog to release at
# modify generate-bash-completion.kts to use latest Paintera release
# upload paintera_completion to release at
# modify generate-bash-completion.kts to use current SNAPSHOT version (can push directly to master for that one)

hanslovsky added some commits Aug 7, 2019

@hanslovsky hanslovsky merged commit 570877a into master Aug 8, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed

@hanslovsky hanslovsky deleted the auto-generate-release-note branch Aug 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
1 participant
You can’t perform that action at this time.