From e92d85a420d703b2ac7ae547bacbc45608e0d5fa Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 14:59:37 -0400 Subject: [PATCH 01/11] release-drafter automatically grabs tag number from package.json --- .github/release-drafter.yml | 4 +--- .github/workflows/release-drafter.yml | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 7895c4162..9dbb2a978 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,5 +1,3 @@ -name-template: 'v$NEXT_PATCH_VERSION' -tag-template: 'v$NEXT_PATCH_VERSION' categories: - title: '🚀 Features' label: 'Feature 🎁' @@ -18,6 +16,6 @@ template: | Install with NPM: https://www.npmjs.com/package/vanilla-framework Visit the documentation at https://vanillaframework.io/docs - ## New in Vanilla v$NEXT_PATCH_VERSION + ## New in Vanilla $version $CHANGES diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 55af979a2..cb5ad7823 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -4,12 +4,33 @@ on: push: branches: - main + # temporary to allow testing the release drafter action + pull_request: + branches: + - main jobs: update_release_draft: runs-on: ubuntu-latest steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + # Only need package.json as it is used by the get_version step to pass tag number into release-drafter + sparse-checkout: package.json + + - name: Get version number from package.json + id: get_version + run: | + set -e + echo "::set-output name=version_number::$(jq -r '.version' package.json)" + - name: Draft release notes uses: release-drafter/release-drafter@v6 + with: + # Setting tag and name override the name-template and tag-template. + # See https://github.com/release-drafter/release-drafter?tab=readme-ov-file#action-inputs for more + tag: v${{ steps.get_version.outputs.version_number }} + name: v${{ steps.get_version.outputs.version_number }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 8fbe562fe2c99567ce67ddf79160c7a7325a4972 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 16:32:21 -0400 Subject: [PATCH 02/11] test in fork --- .github/release-drafter.yml | 9 ++++++--- .github/workflows/release-drafter.yml | 28 +++++++++++++++++++++++++-- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 7895c4162..2f810ce20 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,5 +1,3 @@ -name-template: 'v$NEXT_PATCH_VERSION' -tag-template: 'v$NEXT_PATCH_VERSION' categories: - title: '🚀 Features' label: 'Feature 🎁' @@ -11,13 +9,18 @@ categories: label: 'Documentation 📝' - title: '🔨 Maintenance' label: 'Maintenance 🔨' +tag-template: 'some tag template $version' change-template: '- $TITLE by @$AUTHOR (#$NUMBER)' template: | ## Getting Vanilla Framework Install with NPM: https://www.npmjs.com/package/vanilla-framework Visit the documentation at https://vanillaframework.io/docs + + v: $RELEASE_VERSION + n: $RELEASE_NAME + t: $RELEASE_TAG - ## New in Vanilla v$NEXT_PATCH_VERSION + ## New in Vanilla $RELEASE_VERSION $CHANGES diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 55af979a2..a7f0b1a55 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -2,6 +2,10 @@ name: Release Drafter on: push: + branches: + - release-drafter-test-fork + # temporary to allow testing the release drafter action + pull_request: branches: - main @@ -9,7 +13,27 @@ jobs: update_release_draft: runs-on: ubuntu-latest steps: - - name: Draft release notes - uses: release-drafter/release-drafter@v6 + - name: Checkout repo + uses: actions/checkout@v4 + with: + # Only need package.json as it is used by the get_version step to pass tag number into release-drafter + sparse-checkout: package.json + + - name: Get version number from package.json + id: get_version + shell: bash + run: | + set -e + echo "version_number=$(jq -r '.version' package.json)" >> $GITHUB_OUTPUT + + - name: Draft release notes for v${{ steps.get_version.outputs.version_number }} + uses: jmuzina/release-drafter@master + with: + # Setting tag and name override the name-template and tag-template. + # See https://github.com/release-drafter/release-drafter?tab=readme-ov-file#action-inputs for more + tag: "v${{ steps.get_version.outputs.version_number }}" + name: "v${{ steps.get_version.outputs.version_number }}" + version: "v${{ steps.get_version.outputs.version_number }}" + commitish: some_branch env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From e81c2f907953d03c9a4bc9b6de92bf9273f45316 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 16:49:27 -0400 Subject: [PATCH 03/11] tweak --- .github/workflows/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index a7f0b1a55..d5913f7d0 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -34,6 +34,6 @@ jobs: tag: "v${{ steps.get_version.outputs.version_number }}" name: "v${{ steps.get_version.outputs.version_number }}" version: "v${{ steps.get_version.outputs.version_number }}" - commitish: some_branch + # commitish: release-drafter-test-fork env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From c4497dce308f432807570c78c03d88e5de142974 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 16:57:05 -0400 Subject: [PATCH 04/11] 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 d5913f7d0..e7e7773fc 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -16,6 +16,7 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 with: + ref: release-drafter-test-fork # Only need package.json as it is used by the get_version step to pass tag number into release-drafter sparse-checkout: package.json From 25b4d3983a34359e173e1a93292bde46ea8a96e7 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 16:57:55 -0400 Subject: [PATCH 05/11] test --- .github/workflows/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index e7e7773fc..575967a16 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -35,6 +35,6 @@ jobs: tag: "v${{ steps.get_version.outputs.version_number }}" name: "v${{ steps.get_version.outputs.version_number }}" version: "v${{ steps.get_version.outputs.version_number }}" - # commitish: release-drafter-test-fork + commitish: release-drafter-test-fork env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 09a36f82595cf088b90a79a8636c9763ade68a48 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 17:13:47 -0400 Subject: [PATCH 06/11] push main for test --- .github/workflows/release-drafter.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 575967a16..add97eced 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -4,6 +4,7 @@ on: push: branches: - release-drafter-test-fork + - main # temporary to allow testing the release drafter action pull_request: branches: @@ -16,7 +17,6 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 with: - ref: release-drafter-test-fork # Only need package.json as it is used by the get_version step to pass tag number into release-drafter sparse-checkout: package.json @@ -35,6 +35,5 @@ jobs: tag: "v${{ steps.get_version.outputs.version_number }}" name: "v${{ steps.get_version.outputs.version_number }}" version: "v${{ steps.get_version.outputs.version_number }}" - commitish: release-drafter-test-fork env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From d5d126e1192055a13fe066ba52281efceaaa656d Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 17:17:27 -0400 Subject: [PATCH 07/11] revert release drafter template changes --- .github/release-drafter.yml | 4 ---- .github/workflows/release-drafter.yml | 1 + 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 2f810ce20..389b4568b 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -16,10 +16,6 @@ template: | Install with NPM: https://www.npmjs.com/package/vanilla-framework Visit the documentation at https://vanillaframework.io/docs - - v: $RELEASE_VERSION - n: $RELEASE_NAME - t: $RELEASE_TAG ## New in Vanilla $RELEASE_VERSION diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index add97eced..0b7fbfdf0 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -35,5 +35,6 @@ jobs: tag: "v${{ steps.get_version.outputs.version_number }}" name: "v${{ steps.get_version.outputs.version_number }}" version: "v${{ steps.get_version.outputs.version_number }}" + commitish: main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 6766429932bcf0c5c7211c89d2330d658141f87a Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Tue, 7 May 2024 17:52:38 -0400 Subject: [PATCH 08/11] test with new template --- .github/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 389b4568b..b893d7169 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -17,6 +17,6 @@ template: | Install with NPM: https://www.npmjs.com/package/vanilla-framework Visit the documentation at https://vanillaframework.io/docs - ## New in Vanilla $RELEASE_VERSION + ## New in Vanilla $INPUT_VERSION $CHANGES From 2b57bba04951fabb2a8e7b20bc6bd4c3939feb88 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Wed, 8 May 2024 10:18:44 -0400 Subject: [PATCH 09/11] switch to use $INPUT_VERSION for template draft --- .github/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index b5b957628..934bb0c7b 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -16,6 +16,6 @@ template: | Install with NPM: https://www.npmjs.com/package/vanilla-framework Visit the documentation at https://vanillaframework.io/docs - ## New in Vanilla v$NEXT_PATCH_VERSION + ## New in Vanilla v$INPUT_VERSION $CHANGES From 19b6d3f45b36816efd16b8efb784621141759c57 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Wed, 8 May 2024 14:52:12 -0400 Subject: [PATCH 10/11] remove v from release drafter.version input --- .github/workflows/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 0cdf7f7f9..e82d6308d 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -29,7 +29,7 @@ jobs: # See https://github.com/release-drafter/release-drafter?tab=readme-ov-file#action-inputs for more tag: "v${{ steps.get_version.outputs.version_number }}" name: "v${{ steps.get_version.outputs.version_number }}" - version: "v${{ steps.get_version.outputs.version_number }}" + version: ${{ steps.get_version.outputs.version_number }} commitish: main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 6be9cc02071272c71551b98db5d594828726cfe3 Mon Sep 17 00:00:00 2001 From: Julie Muzina Date: Wed, 8 May 2024 15:05:42 -0400 Subject: [PATCH 11/11] remove drafter input.version --- .github/workflows/release-drafter.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index e82d6308d..b41328a2e 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -27,9 +27,8 @@ jobs: with: # Setting tag and name override the name-template and tag-template. # See https://github.com/release-drafter/release-drafter?tab=readme-ov-file#action-inputs for more - tag: "v${{ steps.get_version.outputs.version_number }}" - name: "v${{ steps.get_version.outputs.version_number }}" - version: ${{ steps.get_version.outputs.version_number }} + tag: v${{ steps.get_version.outputs.version_number }} + name: v${{ steps.get_version.outputs.version_number }} commitish: main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}