From 563aaf674c2ec53545836537053073581d00b09d Mon Sep 17 00:00:00 2001 From: Nadeesha Cabral Date: Fri, 29 Nov 2024 06:36:17 +1100 Subject: [PATCH] chore: Automate changelog generation in CI workflow --- .github/workflows/publish.yml | 42 ++++++++++-- cliff.toml | 124 ++++++++++++++++++++++++++++++++++ 2 files changed, 160 insertions(+), 6 deletions(-) create mode 100644 cliff.toml diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 189496a8..4a97051f 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -44,10 +44,44 @@ jobs: bootstrap: - 'bootstrap*/**' + generate_changelog: + needs: [check_changes, publish-cli, publish-node, publish-react, publish-dotnet, publish-go, create-archives] + runs-on: ubuntu-latest + if: | + always() && ( + needs.check_changes.outputs.sdk_node == 'true' || + needs.check_changes.outputs.sdk_react == 'true' || + needs.check_changes.outputs.sdk_dotnet == 'true' || + needs.check_changes.outputs.sdk_go == 'true' || + needs.check_changes.outputs.cli == 'true' || + needs.check_changes.outputs.bootstrap == 'true' + ) + permissions: + contents: write + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Generate a changelog + uses: orhun/git-cliff-action@v3 + with: + config: cliff.toml + args: --verbose + env: + OUTPUT: CHANGELOG.md + GITHUB_REPO: ${{ github.repository }} + - name: Commit changelog + uses: EndBug/add-and-commit@v9 + with: + add: 'CHANGELOG.md' + message: '[skip ci] chore: Update changelog' + default_author: github_actions + push: true + github_token: ${{ secrets.GITHUB_TOKEN }} publish-cli: needs: check_changes - if: ${{ needs.check_changes.outputs.cli == 'true' }} runs-on: ubuntu-latest permissions: contents: write @@ -86,7 +120,6 @@ jobs: publish-node: needs: check_changes - if: ${{ needs.check_changes.outputs.sdk_node == 'true' }} runs-on: ubuntu-latest permissions: contents: write @@ -125,7 +158,6 @@ jobs: publish-react: needs: check_changes - if: ${{ needs.check_changes.outputs.sdk_react == 'true' }} runs-on: ubuntu-latest permissions: contents: write @@ -164,7 +196,6 @@ jobs: publish-dotnet: needs: check_changes - if: ${{ needs.check_changes.outputs.sdk_dotnet == 'true' }} runs-on: windows-latest permissions: contents: write @@ -231,7 +262,6 @@ jobs: publish-go: needs: check_changes - if: ${{ needs.check_changes.outputs.sdk_go == 'true' }} runs-on: ubuntu-latest permissions: contents: write @@ -278,8 +308,8 @@ jobs: git push origin sdk-go/v${{ steps.increment_version.outputs.new_version }} create-archives: + needs: [check_changes, generate_changelog] runs-on: ubuntu-latest - needs: check_changes if: ${{ needs.check_changes.outputs.bootstrap == 'true' }} permissions: contents: write diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 00000000..9b4325a2 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,124 @@ +# git-cliff ~ configuration file +# https://git-cliff.org/docs/configuration +# +# Lines starting with "#" are comments. +# Configuration options are organized into tables and keys. +# See documentation for more information on available options. + +[remote.github] +owner = "inferablehq" +repo = "inferable" + +[changelog] +# template for the changelog header +header = """ +# Inferable Changelog +""" +body = """ +{%- macro remote_url() -%} + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} + +{% macro print_commit(commit) -%} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }} - \ + ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ +{% endmacro -%} + +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}]\ + ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + ## [unreleased] +{% endif %}\ + +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits + | filter(attribute="scope") + | sort(attribute="scope") %} + {{ self::print_commit(commit=commit) }} + {%- endfor %} + {% for commit in commits %} + {%- if not commit.scope -%} + {{ self::print_commit(commit=commit) }} + {% endif -%} + {% endfor -%} +{% endfor -%} +{%- if github -%} +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} + ## New Contributors โค๏ธ +{% endif %}\ +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} + * @{{ contributor.username }} made their first contribution + {%- if contributor.pr_number %} in \ + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ + {%- endif %} +{%- endfor -%} +{%- endif %} + + +""" +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing whitespace from the templates +trim = true +# postprocessors +postprocessors = [ + { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL +] + +[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}](/issues/${2}))" }, + # Check spelling of the commit with https://github.com/crate-ci/typos + # If the spelling is incorrect, it will be automatically fixed. + # { pattern = '.*', replace_command = 'typos --write-changes -' }, +] +# 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\\(clippy\\)", skip = true }, + { message = "^refactor", group = "๐Ÿšœ Refactor" }, + { message = "^style", group = "๐ŸŽจ Styling" }, + { message = "^test", group = "๐Ÿงช Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore\\(npm\\).*yarn\\.lock", skip = true }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, +] +# 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 +# regex for matching git tags +tag_pattern = "v[0-9].*" +# regex for skipping tags +skip_tags = "beta|alpha" +# regex for ignoring tags +ignore_tags = "rc|v2.1.0|v2.1.1" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "newest"