From d65c0f5891b96f4916e9ec5f14d2f0c81b8f9dbd Mon Sep 17 00:00:00 2001 From: Jonathan Gray Date: Wed, 19 Jan 2022 12:12:20 +0000 Subject: [PATCH] Add automatic release notes (#23) --- .github/release.yml | 23 +++++++++++++++++++++++ .github/workflows/release.yml | 19 +++++++++++-------- CONTRIBUTING.md | 19 +++++++++++++++---- Cargo.lock | 2 +- node/Cargo.toml | 2 +- 5 files changed, 51 insertions(+), 14 deletions(-) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..19bd6267 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,23 @@ +changelog: + exclude: + labels: + - ignore-for-release + authors: + - octocat + categories: + - title: Breaking Changes 🛠 + labels: + - breaking-change + - title: Exciting New Features 🎉 + labels: + - enhancement + - feature + - title: Bug Fixes 🐛 + labels: + - bug + - title: Maintenance 🔧 + labels: + - chore + - title: Other Changes + labels: + - "*" \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7c9b1c06..32163704 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -112,23 +112,26 @@ jobs: pushd $TEMP/artefacts/ tar -czvf vitalam-node-${BUILD_VERSION}-x86_64-unknown-linux-gnu.tar.gz ./VERSION.txt ./vitalam-node ./vitalam-node.sha256 popd; + - name: Build release version - uses: "marvinpinto/action-automatic-releases@latest" + uses: softprops/action-gh-release@v1 with: - repo_token: "${{ secrets.GITHUB_TOKEN }}" - automatic_release_tag: ${{ needs.get-version.outputs.version }} - title: Release ${{ needs.get-version.outputs.version }} + token: "${{ secrets.GITHUB_TOKEN }}" + tag_name: ${{ needs.get-version.outputs.version }} + name: ${{ needs.get-version.outputs.version }} prerelease: ${{ needs.get-version.outputs.is_prerelease == 'true' }} + generate_release_notes: true files: | ${{ runner.temp }}/artefacts/vitalam-node-${{ needs.get-version.outputs.version }}-x86_64-unknown-linux-gnu.tar.gz - name: Build release latest if: ${{ needs.get-version.outputs.is_prerelease != 'true' }} - uses: "marvinpinto/action-automatic-releases@latest" + uses: softprops/action-gh-release@v1 with: - repo_token: "${{ secrets.GITHUB_TOKEN }}" - automatic_release_tag: latest - title: Latest Release ${{ needs.get-version.outputs.version }} + token: "${{ secrets.GITHUB_TOKEN }}" + tag_name: latest + name: Latest ${{ needs.get-version.outputs.version }} prerelease: false + generate_release_notes: true files: | ${{ runner.temp }}/artefacts/vitalam-node-${{ needs.get-version.outputs.version }}-x86_64-unknown-linux-gnu.tar.gz diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0442a93b..2637289e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,10 +20,7 @@ The following is a set of guidelines for contributing to VITALam and its package [Styleguides](#styleguides) - [Git Commit Messages](#git-commit-messages) - -[Additional Notes](#additional-notes) - -- [Issue and Pull Request Labels](#issue-and-pull-request-labels) +- [Pull Request Labels](#pull-request-labels) ## Code of Conduct @@ -138,3 +135,17 @@ While the prerequisites above must be satisfied prior to having your pull reques - :arrow_up: `:arrow_up:` when upgrading dependencies - :arrow_down: `:arrow_down:` when downgrading dependencies - :shirt: `:shirt:` when removing linter warnings + +### Pull Request Labels + +| Label name | :mag_right: | Description | +| ----------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------ | +| `breaking-change` | [search][search-digicat-label-breaking-change] | Pull requests that add functionality with incompatible API changes (MAJOR SemVer) | +| `feature ` | [search][search-digicat-label-feature] | Pull requests that add functionality with backwards compatibility (MINOR SemVer) | +| `chore` | [search][search-digicat-label-chore] | Simple changes or improvements to the code base so it can be worked with more easily | +| `bug` | [search][search-digicat-label-bug] | Pull requests that fix bugs | + +[search-digicat-label-breaking-change]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abreaking-change +[search-digicat-label-feature]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Afeature +[search-digicat-label-chore]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Achore +[search-digicat-label-bug]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abug diff --git a/Cargo.lock b/Cargo.lock index 357ec0d7..a7af9dd6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -7939,7 +7939,7 @@ checksum = "5fecdca9a5291cc2b8dcf7dc02453fee791a280f3743cb0905f8822ae463b3fe" [[package]] name = "vitalam-node" -version = "2.6.1" +version = "2.6.2" dependencies = [ "bs58", "frame-benchmarking", diff --git a/node/Cargo.toml b/node/Cargo.toml index 79b3219b..c79f67b2 100644 --- a/node/Cargo.toml +++ b/node/Cargo.toml @@ -6,7 +6,7 @@ edition = '2018' license = 'Apache-2.0' repository = 'https://github.com/digicatapult/vitalam-node/' name = 'vitalam-node' -version = '2.6.1' +version = '2.6.2' [[bin]] name = 'vitalam-node'