feat(release): credit external contributors in release notes (#975)

This commit is contained in:
Carlos Florêncio
2026-05-22 14:34:29 +01:00
committed by GitHub
parent e85c340797
commit 2430d351e6
2 changed files with 15 additions and 4 deletions
+8 -4
View File
@@ -75,12 +75,13 @@ jobs:
- name: Install git-cliff - name: Install git-cliff
env: env:
# Pinned to v2.6.1. To bump, also update the sha512 below — fetch the # Pinned to v2.13.1 to match git-cliff-action@v4's default runtime.
# To bump, also update the sha512 below — fetch the
# new one from: # new one from:
# https://github.com/orhun/git-cliff/releases/download/<tag>/<asset>.sha512 # https://github.com/orhun/git-cliff/releases/download/<tag>/<asset>.sha512
CLIFF_VERSION: "2.6.1" CLIFF_VERSION: "2.13.1"
CLIFF_ASSET: "git-cliff-2.6.1-x86_64-unknown-linux-gnu.tar.gz" CLIFF_ASSET: "git-cliff-2.13.1-x86_64-unknown-linux-gnu.tar.gz"
CLIFF_SHA512: "b1e7a6b70fc794accdccd9717eff5a8bf8b507f0308da44d837d935be31b18b19db3758d1a9bb4975fbca7d01ddaae251229a753ae2cd2ecc24845cfc50d067f" CLIFF_SHA512: "e716cce3a07dda41b1e370d6afbd7a59eb3d4739509fb7856aeec8da2be28c0396584e29e106141c1a1c535c1827dbc1f60417524f5cfb1da9e11f700bd00f30"
run: | run: |
set -euo pipefail set -euo pipefail
curl -sSL "https://github.com/orhun/git-cliff/releases/download/v${CLIFF_VERSION}/${CLIFF_ASSET}" -o /tmp/git-cliff.tar.gz curl -sSL "https://github.com/orhun/git-cliff/releases/download/v${CLIFF_VERSION}/${CLIFF_ASSET}" -o /tmp/git-cliff.tar.gz
@@ -164,6 +165,7 @@ jobs:
env: env:
NEXT: ${{ steps.compute.outputs.version }} NEXT: ${{ steps.compute.outputs.version }}
TAG: ${{ steps.compute.outputs.tag }} TAG: ${{ steps.compute.outputs.tag }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: | run: |
set -euo pipefail set -euo pipefail
# Bump only the main package version. optionalDependencies stay # Bump only the main package version. optionalDependencies stay
@@ -235,6 +237,7 @@ jobs:
env: env:
NEXT: ${{ steps.compute.outputs.version }} NEXT: ${{ steps.compute.outputs.version }}
TAG: ${{ steps.compute.outputs.tag }} TAG: ${{ steps.compute.outputs.tag }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: | run: |
# In dry-run we still bump + run git-cliff locally so the maintainer # In dry-run we still bump + run git-cliff locally so the maintainer
# can verify the computed version + changelog look right, but nothing # can verify the computed version + changelog look right, but nothing
@@ -794,6 +797,7 @@ jobs:
args: --latest --strip header args: --latest --strip header
env: env:
OUTPUT: RELEASE_NOTES.md OUTPUT: RELEASE_NOTES.md
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/download-artifact@v5 - uses: actions/download-artifact@v5
with: with:
+7
View File
@@ -7,6 +7,8 @@ header = """# Changelog
All notable changes to Kandev.\n All notable changes to Kandev.\n
""" """
body = """ body = """
{# Update when team changes — must match GitHub login (lowercased). Check repo admins at https://github.com/orgs/kdlbs/people #}\
{% set maintainers = ["carlosflorencio", "jcfs", "zeval", "nnobre"] %}\
{% if version %}\ {% if version %}\
## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }} ## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\ {% else %}\
@@ -16,12 +18,17 @@ body = """
### {{ group | striptags | trim | upper_first }} ### {{ group | striptags | trim | upper_first }}
{% for commit in commits %} {% for commit in commits %}
- {{ commit.message }}\ - {{ commit.message }}\
{% if commit.remote.username and commit.remote.username | lower not in maintainers %} by @{{ commit.remote.username }}{% endif %}\
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
trim = true trim = true
footer = "" footer = ""
[remote.github]
owner = "kdlbs"
repo = "kandev"
[git] [git]
conventional_commits = true conventional_commits = true
filter_unconventional = false filter_unconventional = false