From 63f318aa5307cac6b533d98d1e1c2053370deb58 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Mon, 6 Jun 2022 20:20:26 -0400 Subject: [PATCH 1/3] :technologist: Draft release notes with GitHub Actions Automating the changelog writing with Release Drafter probot! Template and workflow based on PyGMT, but with emojis. --- .github/release-template.yml | 32 +++++++++++++++++++++++++++ .github/workflows/release-drafter.yml | 21 ++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 .github/release-template.yml create mode 100644 .github/workflows/release-drafter.yml diff --git a/.github/release-template.yml b/.github/release-template.yml new file mode 100644 index 0000000..cea16a9 --- /dev/null +++ b/.github/release-template.yml @@ -0,0 +1,32 @@ +name-template: 'v$RESOLVED_VERSION 🌈' +tag-template: 'v$RESOLVED_VERSION' +categories: + - title: '🚀 Features' + label: 'feature' + - title: '🐛 Bug Fixes' + label: 'bug' + - title: '📖 Documentation' + label: 'documentation' + - title: '🧰 Maintenance' + label: 'maintenance' +version-resolver: + minor: + labels: + - 'feature' + default: patch +exclude-labels: + - 'skip-changelog' +category-template: '### $TITLE' +change-template: '* $TITLE ([#$NUMBER]($URL))' +template: | + ## Release v$RESOLVED_VERSION (20YY/MM/DD) + + ### 💫 Highlights + + * + + $CHANGES + + ### 🧑‍🤝‍🧑 Contributors + + $CONTRIBUTORS diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml new file mode 100644 index 0000000..1188db2 --- /dev/null +++ b/.github/workflows/release-drafter.yml @@ -0,0 +1,21 @@ +name: Release Drafter + +on: + push: + branches: + - main + +permissions: + contents: read + +jobs: + update_release_draft: + runs-on: ubuntu-22.04 + steps: + # Drafts your next Release notes as Pull Requests are merged into "main" + - uses: release-drafter/release-drafter@v5.20.0 + with: + # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml + config-name: release-template.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From b1a0e243489a88fcad4ce9ac4179395b426dab95 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Mon, 6 Jun 2022 20:22:00 -0400 Subject: [PATCH 2/3] Temporarily trigger release drafter workflow as a test --- .github/workflows/release-drafter.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 1188db2..5941cd1 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -4,6 +4,7 @@ on: push: branches: - main + pull_request: permissions: contents: read From 4cd8c1eedcd42786b0808011649ffb0cf2aa5050 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Mon, 6 Jun 2022 20:22:00 -0400 Subject: [PATCH 3/3] Revert "Temporarily trigger release drafter workflow as a test" This reverts commit b1a0e243489a88fcad4ce9ac4179395b426dab95. --- .github/workflows/release-drafter.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 5941cd1..1188db2 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -4,7 +4,6 @@ on: push: branches: - main - pull_request: permissions: contents: read