From 2ab94676d571e925416d818bc9177498df19f915 Mon Sep 17 00:00:00 2001 From: Claudemirovsky <63046606+Claudemirovsky@users.noreply.github.com> Date: Sun, 5 Feb 2023 21:49:20 -0300 Subject: [PATCH] CI: Implement git-cliff for autogenerated changelogs --- .github/workflows/cliff.toml | 76 +++++++++++++++++++++++++++++++++++ .github/workflows/release.yml | 50 +++++++++++++---------- 2 files changed, 105 insertions(+), 21 deletions(-) create mode 100644 .github/workflows/cliff.toml diff --git a/.github/workflows/cliff.toml b/.github/workflows/cliff.toml new file mode 100644 index 0000000..4c7eef9 --- /dev/null +++ b/.github/workflows/cliff.toml @@ -0,0 +1,76 @@ +# configuration file for git-cliff +# see https://github.com/orhun/git-cliff#configuration-file + +[changelog] +# changelog header +header = "" +# template for the changelog body +# https://tera.netlify.app/docs/#introduction +body = """ +{% if version %}\ + # [{{ version }}]\ + {% if previous %}\ + {% if previous.version %}\ + (https://github.com/Claudemirovsky/noveltomanga/compare/{{ previous.version }}...{{ version }})\ + {% else %}\ + (https://github.com/Claudemirovsky/noveltomanga/tree/{{ version }})\ + {% endif %}\ + {% endif %} \ + - ({{ timestamp | date(format="%Y-%m-%d") }}) +{% else %}\ + # [unreleased]\ +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# remove the leading and trailing whitespace from the template +trim = true +# changelog footer +footer = """ + +""" + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^doc", group = "Documentation"}, + { message = "^perf", group = "Performance"}, + { message = "^refactor", group = "Refactor"}, + { message = "^style", group = "Styling"}, + { message = "^test", group = "Testing"}, + { message = "^chore\\(release\\): prepare for", skip = true}, + { message = "^chore", group = "Miscellaneous Tasks"}, + { body = ".*security", group = "Security"}, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# glob pattern for matching git tags +tag_pattern = "v[0-9]*" +# regex for skipping tags +skip_tags = "v0.1.0-beta.1" +# regex for ignoring tags +ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" +# limit the number of commits included in the changelog. +# limit_commits = 42 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4212126..d8a1b93 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,13 +1,32 @@ name: Release on: - workflow_dispatch: - inputs: - tag: - description: 'Version/tag' - required: true + push: + tags: + - 'v*' jobs: + changelog: + name: Generate changelog + runs-on: ubuntu-latest + outputs: + release_body: ${{ steps.git-cliff.outputs.content }} + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Generate a changelog + uses: orhun/git-cliff-action@v2 + id: git-cliff + with: + config: .github/workflows/cliff.toml + args: -vv --latest + env: + OUTPUT: CHANGELOG.md + build: - name: Build library + name: Build and publish library + needs: changelog runs-on: ubuntu-latest steps: @@ -28,25 +47,14 @@ jobs: with: arguments: assembleRelease - - name: Prepare to release - run: | - set -e - mv lib/build/outputs/aar/lib-release.aar noveltomanga-${{ github.event.inputs.tag }}.aar - sha=`sha256sum noveltomanga-${{ github.event.inputs.tag }}.aar | awk '{ print $1 }'` - echo "RELEASE_HASH=$sha" >> $GITHUB_ENV + - run: mv lib/build/outputs/aar/lib-release.aar noveltomanga-${{ github.ref_name }}.aar - name: Create Release uses: softprops/action-gh-release@v1 with: - tag_name: ${{ github.event.inputs.tag }} - name: NovelToManga ${{ github.event.inputs.tag }} - body: | - --- - ### Checksum - | Variant | SHA-256 | - | ------- | ------- | - | Release | ${{ env.RELEASE_HASH }} - files: noveltomanga-${{ github.event.inputs.tag }}.aar + name: NovelToManga ${{ github.ref_name }} + body: ${{ needs.changelog.outputs.release_body }} + files: noveltomanga-${{ github.ref_name }}.aar draft: false prerelease: false env: