From 3bdf6bef1174f471331017117cbcdc830e004a3a Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 11:14:37 +0100 Subject: [PATCH 01/34] feat: add changeset-check workflow --- .../workflows/template_changeset_check.yml | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/workflows/template_changeset_check.yml diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml new file mode 100644 index 0000000..bf6684f --- /dev/null +++ b/.github/workflows/template_changeset_check.yml @@ -0,0 +1,46 @@ +name: Changeset Check + +on: workflow_call + +jobs: + changeset-check: + name: changeset-check + runs-on: ubuntu-24.04 + steps: + - name: Check for changeset file + id: checkfile + run: echo "{changeset}={$(git diff --name-only origin/main... | grep -c '.changeset/.*\.md$')} >> $GITHUB_OUTPUT" + + - name: Find existing comment + uses: peter-evans/find-comment@v3.1.0 + id: find_comment + with: + issue-number: ${{ github.event.pull_request.number }} + comment-author: "github-actions[bot]" + body-includes: + + - name: Update comment for found changeset + uses: peter-evans/create-or-update-comment@v4.0.0 + if: steps.checkfile.outputs.changeset != '0' + with: + comment-id: ${{ steps.find_comment.outputs.comment-id }} + issue-number: ${{ github.event.pull_request.number }} + body: | + + ## 🦋 Changeset file found + + Good job! A changeset file has been added in this PR. Your changes will be included in the next release. + edit-mode: replace + + - name: Update comment for missing changeset + uses: peter-evans/create-or-update-comment@v4.0.0 + if: steps.checkfile.outputs.changeset == '0' + with: + comment-id: ${{ steps.find_comment.outputs.comment-id }} + issue-number: ${{ github.event.pull_request.number }} + body: | + + ## ⚠️ Changeset file missing + + No changeset file has been added in this PR. Please consider adding one if this PR contains user-facing changes. + edit-mode: replace From 53405984aa896311dd5a6260f72267f82088ccc9 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 11:25:42 +0100 Subject: [PATCH 02/34] feat: add changeset release workflow --- .../workflows/template_changeset_release.yml | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/workflows/template_changeset_release.yml diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml new file mode 100644 index 0000000..04aa4d1 --- /dev/null +++ b/.github/workflows/template_changeset_release.yml @@ -0,0 +1,51 @@ +name: Changeset Release + +on: + workflow_call: + inputs: + commit-msg: + required: false + type: string + default: "chore(release): Bump package version" + pr-title: + required: false + type: string + default: "📦 Release" + publish-script: + required: true + type: string + version-script: + required: true + type: string + secrets: + npm_token: + required: false + app_id: + required: false + private_key: + required: false + +jobs: + changeset-release: + name: changeset-release + runs-on: ubuntu-24.04 + steps: + - name: Get App Token + uses: actions/create-github-app-token@v1.11.0 + id: get_token + with: + app-id: ${{ secrets.app_id }} + private-key: ${{ secrets.private_key }} + + - name: Publish release + uses: changesets/action@v1 + with: + commit: ${{ inputs.commit-msg }} + title: ${{ inputs.pr-title }} + setupGitUser: true + createGithubReleases: true + publish: ${{ inputs.publish-script }} + version: ${{ inputs.version-script}} + env: + GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} + NPM_TOKEN: ${{ secrets.npm_token }} From b5c2a3da715dcccaf4ec500503d61cc1ea07970c Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 11:43:59 +0100 Subject: [PATCH 03/34] docs: add docs for changeset check workflow --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index dfce92a..2f916db 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,24 @@ jobs: +### Changeset Check + +
+The action can be used to check a PR for the existance of changeset files. It will then add/update a comment on the PR. + +```yml +name: Changeset Check +on: + pull_request: + types: [opened, reopened, synchronize] + +jobs: + changeset-check: + uses: Staffbase/gha-workflows/.github/workflows/tempalte_changeset_check@v7.1.0 +``` + +
+ ### GitOps
From 90b2b8cdc8166002c4d94de5469a4e5134fb0242 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 11:45:46 +0100 Subject: [PATCH 04/34] docs: update readme versions --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2f916db..7bbe3fb 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ on: jobs: : - uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.1.0 with: ... ``` @@ -43,7 +43,7 @@ on: jobs: dependabot: - uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.1.0 with: # optional: ⚠️ only enable the force merge if you want to do the merge just now force: true @@ -78,7 +78,7 @@ on: jobs: autodev: - uses: Staffbase/gha-workflows/.github/workflows/template_autodev.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_autodev.yml@v7.1.0 with: # optional: base branch from which the history originates, default: main base: master @@ -138,7 +138,7 @@ on: [ push ] jobs: gitops: - uses: Staffbase/gha-workflows/.github/workflows/template_gitops.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_gitops.yml@v7.1.0 with: # optional: host of the docker registry, default: "staffbase.jfrog.io" docker-registry: "" @@ -219,7 +219,7 @@ on: jobs: jira_annotate: - uses: Staffbase/gha-workflows/.github/workflows/template_jira_tagging.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_jira_tagging.yml@v7.1.0 with: # optional: name of the service to add as label, default: name of the repository name: 'component name' @@ -252,7 +252,7 @@ on: jobs: ld_code_references: - uses: Staffbase/gha-workflows/.github/workflows/template_launchdarkly_code_references.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_launchdarkly_code_references.yml@v7.1.0 with: # optional: key of the LD project, default: default project-key: 'my-project' @@ -277,7 +277,7 @@ on: jobs: block: - uses: Staffbase/gha-workflows/.github/workflows/template_merge_block.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_merge_block.yml@v7.1.0 with: # optional: name of the label if the PR should not be merged, default: do not merge label: merge block @@ -305,7 +305,7 @@ on: jobs: update_release_draft: - uses: Staffbase/gha-workflows/.github/workflows/template_release_drafter.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_release_drafter.yml@v7.1.0 with: # optional: name of the release name: Version X.Y.Z @@ -344,7 +344,7 @@ on: jobs: new_version: - uses: Staffbase/gha-workflows/.github/workflows/template_release_version.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_release_version.yml@v7.1.0 with: # optional: format of the version, default: weekly format: 'quarterly' @@ -375,7 +375,7 @@ on: [pull_request] jobs: trufflehog: - uses: Staffbase/gha-workflows/.github/workflows/template_secret_scan.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_secret_scan.yml@v7.1.0 ```
@@ -394,7 +394,7 @@ on: jobs: stale: - uses: Staffbase/gha-workflows/.github/workflows/template_stale.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_stale.yml@v7.1.0 with: # optional: comment on the stale pull request while closed, default: This stale PR was closed because there was no activity. close-pr-message: your message @@ -431,7 +431,7 @@ on: jobs: techdocs: - uses: Staffbase/gha-workflows/.github/workflows/template_techdocs.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_techdocs.yml@v7.1.0 with: # optional: kind of the Backstage entity, default: Component # ref: https://backstage.io/docs/features/software-catalog/descriptor-format#contents @@ -463,7 +463,7 @@ on: jobs: trigger-testio-test: - uses: Staffbase/gha-workflows/.github/workflows/template_testio_trigger_test.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_testio_trigger_test.yml@v7.1.0 with: # optional: the slug you received from TestIO, defaults to 'staffbase' testio-slug: your TestIO slug @@ -495,7 +495,7 @@ on: jobs: yamllint: - uses: Staffbase/gha-workflows/.github/workflows/template_yaml.yml@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_yaml.yml@v7.1.0 with: # optional: name of the running action, default: yamllint / yamllint action-name: your name From 6e41aff30d6bcda786ee3141cba6d2bb0a00b174 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 11:46:37 +0100 Subject: [PATCH 05/34] docs: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bbe3fb..3783657 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ on: jobs: changeset-check: - uses: Staffbase/gha-workflows/.github/workflows/tempalte_changeset_check@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.1.0 ``` From 8f06aa9b229c5a22168588ccebb0b3308b759334 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 12:18:01 +0100 Subject: [PATCH 06/34] fix: add checkout action to changeset check --- .github/workflows/template_changeset_check.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index bf6684f..3d8fca6 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -7,6 +7,9 @@ jobs: name: changeset-check runs-on: ubuntu-24.04 steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Check for changeset file id: checkfile run: echo "{changeset}={$(git diff --name-only origin/main... | grep -c '.changeset/.*\.md$')} >> $GITHUB_OUTPUT" From f27c3e53d36f7e720d033f3096a8ec936a338bd0 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 14:52:17 +0100 Subject: [PATCH 07/34] fix: fetch and use pr base for diff --- .github/workflows/template_changeset_check.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index 3d8fca6..25cb4d3 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -10,9 +10,12 @@ jobs: - name: Checkout code uses: actions/checkout@v4 + - name: Fetch base + run: git fetch ${{ github.event.pull_request.base.ref }} + - name: Check for changeset file id: checkfile - run: echo "{changeset}={$(git diff --name-only origin/main... | grep -c '.changeset/.*\.md$')} >> $GITHUB_OUTPUT" + run: echo "{changeset}={$(git diff --name-only ${{ github.event.pull_request.base.ref }} | grep -c '.changeset/.*\.md$')} >> $GITHUB_OUTPUT" - name: Find existing comment uses: peter-evans/find-comment@v3.1.0 From 87cc068c343aefd54254c5ae246bfba313216c83 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 14:57:52 +0100 Subject: [PATCH 08/34] fix: add origin --- .github/workflows/template_changeset_check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index 25cb4d3..8d4b00a 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -11,7 +11,7 @@ jobs: uses: actions/checkout@v4 - name: Fetch base - run: git fetch ${{ github.event.pull_request.base.ref }} + run: git fetch origin ${{ github.event.pull_request.base.ref }} - name: Check for changeset file id: checkfile From 915f5484f07b649b5a92e5f7f3ee8719a026213e Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Tue, 21 Jan 2025 18:06:31 +0100 Subject: [PATCH 09/34] fix: use changed files action to get changesets --- .github/workflows/template_changeset_check.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index 8d4b00a..5ad9423 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -10,12 +10,12 @@ jobs: - name: Checkout code uses: actions/checkout@v4 - - name: Fetch base - run: git fetch origin ${{ github.event.pull_request.base.ref }} - - - name: Check for changeset file - id: checkfile - run: echo "{changeset}={$(git diff --name-only ${{ github.event.pull_request.base.ref }} | grep -c '.changeset/.*\.md$')} >> $GITHUB_OUTPUT" + - name: Check for changesets + id: changeset-files + uses: tj-actions/changed-files@v45.0.6 + with: + files: .changeset/*.md + base_sha: ${{ github.event.pull_request.base.sha }} - name: Find existing comment uses: peter-evans/find-comment@v3.1.0 @@ -27,7 +27,7 @@ jobs: - name: Update comment for found changeset uses: peter-evans/create-or-update-comment@v4.0.0 - if: steps.checkfile.outputs.changeset != '0' + if: steps.changeset-files.outputs.any_changed == 'true' with: comment-id: ${{ steps.find_comment.outputs.comment-id }} issue-number: ${{ github.event.pull_request.number }} @@ -40,7 +40,7 @@ jobs: - name: Update comment for missing changeset uses: peter-evans/create-or-update-comment@v4.0.0 - if: steps.checkfile.outputs.changeset == '0' + if: steps.changeset-files.outputs.any_changed != 'true' with: comment-id: ${{ steps.find_comment.outputs.comment-id }} issue-number: ${{ github.event.pull_request.number }} From 1441be8f387241d8fd3c21b8c205cec09e1ba375 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 09:59:37 +0100 Subject: [PATCH 10/34] chore: remove changeset release workflow --- .../workflows/template_changeset_release.yml | 51 ------------------- 1 file changed, 51 deletions(-) delete mode 100644 .github/workflows/template_changeset_release.yml diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml deleted file mode 100644 index 04aa4d1..0000000 --- a/.github/workflows/template_changeset_release.yml +++ /dev/null @@ -1,51 +0,0 @@ -name: Changeset Release - -on: - workflow_call: - inputs: - commit-msg: - required: false - type: string - default: "chore(release): Bump package version" - pr-title: - required: false - type: string - default: "📦 Release" - publish-script: - required: true - type: string - version-script: - required: true - type: string - secrets: - npm_token: - required: false - app_id: - required: false - private_key: - required: false - -jobs: - changeset-release: - name: changeset-release - runs-on: ubuntu-24.04 - steps: - - name: Get App Token - uses: actions/create-github-app-token@v1.11.0 - id: get_token - with: - app-id: ${{ secrets.app_id }} - private-key: ${{ secrets.private_key }} - - - name: Publish release - uses: changesets/action@v1 - with: - commit: ${{ inputs.commit-msg }} - title: ${{ inputs.pr-title }} - setupGitUser: true - createGithubReleases: true - publish: ${{ inputs.publish-script }} - version: ${{ inputs.version-script}} - env: - GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} - NPM_TOKEN: ${{ secrets.npm_token }} From f36e2bd693b6588b8226c4587bd2231a54eae494 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 10:01:06 +0100 Subject: [PATCH 11/34] chore: undo version bumps --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3783657..2fc5e77 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ on: jobs: : - uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.0.0 with: ... ``` @@ -43,7 +43,7 @@ on: jobs: dependabot: - uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.0.0 with: # optional: ⚠️ only enable the force merge if you want to do the merge just now force: true @@ -78,7 +78,7 @@ on: jobs: autodev: - uses: Staffbase/gha-workflows/.github/workflows/template_autodev.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_autodev.yml@v7.0.0 with: # optional: base branch from which the history originates, default: main base: master @@ -122,7 +122,7 @@ on: jobs: changeset-check: - uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.0.0 ``` @@ -138,7 +138,7 @@ on: [ push ] jobs: gitops: - uses: Staffbase/gha-workflows/.github/workflows/template_gitops.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_gitops.yml@v7.0.0 with: # optional: host of the docker registry, default: "staffbase.jfrog.io" docker-registry: "" @@ -219,7 +219,7 @@ on: jobs: jira_annotate: - uses: Staffbase/gha-workflows/.github/workflows/template_jira_tagging.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_jira_tagging.yml@v7.0.0 with: # optional: name of the service to add as label, default: name of the repository name: 'component name' @@ -252,7 +252,7 @@ on: jobs: ld_code_references: - uses: Staffbase/gha-workflows/.github/workflows/template_launchdarkly_code_references.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_launchdarkly_code_references.yml@v7.0.0 with: # optional: key of the LD project, default: default project-key: 'my-project' @@ -277,7 +277,7 @@ on: jobs: block: - uses: Staffbase/gha-workflows/.github/workflows/template_merge_block.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_merge_block.yml@v7.0.0 with: # optional: name of the label if the PR should not be merged, default: do not merge label: merge block @@ -305,7 +305,7 @@ on: jobs: update_release_draft: - uses: Staffbase/gha-workflows/.github/workflows/template_release_drafter.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_release_drafter.yml@v7.0.0 with: # optional: name of the release name: Version X.Y.Z @@ -344,7 +344,7 @@ on: jobs: new_version: - uses: Staffbase/gha-workflows/.github/workflows/template_release_version.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_release_version.yml@v7.0.0 with: # optional: format of the version, default: weekly format: 'quarterly' @@ -375,7 +375,7 @@ on: [pull_request] jobs: trufflehog: - uses: Staffbase/gha-workflows/.github/workflows/template_secret_scan.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_secret_scan.yml@v7.0.0 ``` @@ -394,7 +394,7 @@ on: jobs: stale: - uses: Staffbase/gha-workflows/.github/workflows/template_stale.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_stale.yml@v7.0.0 with: # optional: comment on the stale pull request while closed, default: This stale PR was closed because there was no activity. close-pr-message: your message @@ -431,7 +431,7 @@ on: jobs: techdocs: - uses: Staffbase/gha-workflows/.github/workflows/template_techdocs.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_techdocs.yml@v7.0.0 with: # optional: kind of the Backstage entity, default: Component # ref: https://backstage.io/docs/features/software-catalog/descriptor-format#contents @@ -463,7 +463,7 @@ on: jobs: trigger-testio-test: - uses: Staffbase/gha-workflows/.github/workflows/template_testio_trigger_test.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_testio_trigger_test.yml@v7.0.0 with: # optional: the slug you received from TestIO, defaults to 'staffbase' testio-slug: your TestIO slug @@ -495,7 +495,7 @@ on: jobs: yamllint: - uses: Staffbase/gha-workflows/.github/workflows/template_yaml.yml@v7.1.0 + uses: Staffbase/gha-workflows/.github/workflows/template_yaml.yml@v7.0.0 with: # optional: name of the running action, default: yamllint / yamllint action-name: your name From 0e29d34710d118fa1ccb134bc0ecb34d234afc1b Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 10:02:53 +0100 Subject: [PATCH 12/34] chore: remove trailing space --- .github/workflows/template_changeset_check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index 5ad9423..08abc06 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -14,7 +14,7 @@ jobs: id: changeset-files uses: tj-actions/changed-files@v45.0.6 with: - files: .changeset/*.md + files: .changeset/*.md base_sha: ${{ github.event.pull_request.base.sha }} - name: Find existing comment From 83455cac9824fc67e4fcfd20270550b280c00e38 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:39:03 +0100 Subject: [PATCH 13/34] feat: re-add release workflow --- .../workflows/template_changeset_check.yml | 2 +- README.md | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index 08abc06..c17f0a5 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-24.04 steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v4.2.2 - name: Check for changesets id: changeset-files diff --git a/README.md b/README.md index 2fc5e77..f8f02a8 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,27 @@ jobs: +### Changeset Release + +
+The action can be used to create release PR and publish releases for repos using PNPM and changesets. + +> [!NOTE] +> Make sure you have `@changesets/cli` installed as a dev-dependency in your project! + +```yml +name: Changeset Check +on: + pull_request: + types: [opened, reopened, synchronize] + +jobs: + changeset-check: + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.0.0 +``` + +
+ ### GitOps
From 18046aafa6d7f1d60d80bb6aa72884e83008087e Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:39:11 +0100 Subject: [PATCH 14/34] feat: re-add release workflow --- .../workflows/template_changeset_release.yml | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/workflows/template_changeset_release.yml diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml new file mode 100644 index 0000000..b2911b6 --- /dev/null +++ b/.github/workflows/template_changeset_release.yml @@ -0,0 +1,57 @@ +name: Changeset Release + +on: + workflow_call: + inputs: + node-version-file: + description: "The file containing the Node.js version to use, defaults to .nvmrc" + default: '.nvrmc' + required: false + type: string + publish-script: + description: "The file script to run on publish. Defaults to `pnpm release`" + default: 'pnpm release' + required: false + type: string + version-script: + description: "The file script to run vor bumping the package versions. Defaults to `pnpm changeset version`" + default: 'pnpm changeset version' + required: false + type: string + +jobs: + release: + name: changeset-release + runs-on: ubuntu-24.04 + steps: + - name: Checkout + uses: actions/checkout@v4.2.2 + + - name: Setup PNPM + uses: pnpm/action-setup@v4.0.0 + + - name: Setup Node + uses: actions/setup-node@v4.1.0 + with: + node-version-file: ${{ inputs.node-version-file }} + cache: 'pnpm' + registry-url: 'https://npm.pkg.github.com/' + scope: '@staffbase' + + - name: Install Dependencies + run: pnpm install --frozen-lockfile --ignore-scripts + env: + NODE_AUTH_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} + + - name: Create Release Pull Request + id: changesets + uses: changesets/action@v1.4.9 + with: + commit: 'chore(release): Bump package version' + title: '📦 Release' + setupGitUser: true + createGithubReleases: true + publish: ${{ inputs.publish-script }} + version: ${{inputs.version-script}} + env: + GITHUB_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} From 32b5a5ce798f40c070e81f4527c6a013c38008bf Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:44:01 +0100 Subject: [PATCH 15/34] docs: improve release docs --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f8f02a8..e28acc8 100644 --- a/README.md +++ b/README.md @@ -132,18 +132,26 @@ jobs:
The action can be used to create release PR and publish releases for repos using PNPM and changesets. -> [!NOTE] -> Make sure you have `@changesets/cli` installed as a dev-dependency in your project! +⚠️ Make sure you have `@changesets/cli` installed as a dev-dependency in your project! ```yml -name: Changeset Check +name: Release + on: - pull_request: - types: [opened, reopened, synchronize] + push: + branches: + - main jobs: changeset-check: - uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release@v7.0.0 + with: + # optional, defaults to `.nvmrc` + node-version-file: '.node-version' + # optional, defaults to `pnpm release` + publish-script: 'pnpm publish' + # optional, defaults to `pnpm changeset version` + version-script: 'pnpm version' ```
From 6ae02b6fbe00208871f941c34bc17304d8842ee7 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:46:33 +0100 Subject: [PATCH 16/34] docs: fix job name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e28acc8..d9df2d7 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ on: - main jobs: - changeset-check: + changeset-release: uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release@v7.0.0 with: # optional, defaults to `.nvmrc` From 5d410f851a4db7748f8917defad7a56bc5cbffe9 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:47:32 +0100 Subject: [PATCH 17/34] docs: add file extensions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d9df2d7..9b6dae8 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ on: jobs: changeset-check: - uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check.yml@v7.0.0 ```
@@ -144,7 +144,7 @@ on: jobs: changeset-release: - uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release@v7.0.0 + uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release.yml@v7.0.0 with: # optional, defaults to `.nvmrc` node-version-file: '.node-version' From 922201b08ba4bf9f130749ddccfded6861346132 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:55:10 +0100 Subject: [PATCH 18/34] fix: use correct tokens --- .github/workflows/template_changeset_release.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index b2911b6..b27e746 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -54,4 +54,5 @@ jobs: publish: ${{ inputs.publish-script }} version: ${{inputs.version-script}} env: - GITHUB_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} From f26571abe09187cc4f8b325290cc792690425535 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 11:56:10 +0100 Subject: [PATCH 19/34] fix: fix typo in filename --- .github/workflows/template_changeset_release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index b27e746..94b30c9 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -5,7 +5,7 @@ on: inputs: node-version-file: description: "The file containing the Node.js version to use, defaults to .nvmrc" - default: '.nvrmc' + default: '.nvmrc' required: false type: string publish-script: From 136c626c0768211deeb8d51c1c885f879916f6ef Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 12:09:28 +0100 Subject: [PATCH 20/34] fix: use app token --- .github/workflows/template_changeset_release.yml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 94b30c9..a07a004 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -18,12 +18,24 @@ on: default: 'pnpm changeset version' required: false type: string + secrets: + app_id: + required: true + private_key: + required: true jobs: release: name: changeset-release runs-on: ubuntu-24.04 steps: + - name: Get App Token + uses: actions/create-github-app-token@v1.11.0 + id: get_token + with: + app-id: ${{ secrets.app_id }} + private-key: ${{ secrets.private_key }} + - name: Checkout uses: actions/checkout@v4.2.2 @@ -54,5 +66,5 @@ jobs: publish: ${{ inputs.publish-script }} version: ${{inputs.version-script}} env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} NPM_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} From b759d7d2e491b4609e67c7d235b9f1d2e9d96840 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 14:09:27 +0100 Subject: [PATCH 21/34] fix: use app token for checkout --- .github/workflows/template_changeset_release.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index a07a004..9dfbff9 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -38,6 +38,8 @@ jobs: - name: Checkout uses: actions/checkout@v4.2.2 + with: + token: ${{ steps.get_token.outputs.token }} - name: Setup PNPM uses: pnpm/action-setup@v4.0.0 @@ -61,7 +63,6 @@ jobs: with: commit: 'chore(release): Bump package version' title: '📦 Release' - setupGitUser: true createGithubReleases: true publish: ${{ inputs.publish-script }} version: ${{inputs.version-script}} From 2e201b7d45caa9ced039e15627b57e1b81bacf9e Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 14:23:55 +0100 Subject: [PATCH 22/34] fix: pass npm token correctly --- .github/workflows/template_changeset_release.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 9dfbff9..be970fc 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -23,6 +23,8 @@ on: required: true private_key: required: true + npm-token: + required: true jobs: release: @@ -55,7 +57,7 @@ jobs: - name: Install Dependencies run: pnpm install --frozen-lockfile --ignore-scripts env: - NODE_AUTH_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} + NODE_AUTH_TOKEN: ${{ secrets.npm-token }} - name: Create Release Pull Request id: changesets @@ -68,4 +70,4 @@ jobs: version: ${{inputs.version-script}} env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} - NPM_TOKEN: ${{ secrets.STAFFBOT_NPM_WRITE }} + NPM_TOKEN: ${{ secrets.npm-token }} From 12fff0095e164f361fb2e331d136f2556aa7d057 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 14:27:32 +0100 Subject: [PATCH 23/34] fix: don't trigger changeset checks for bot PRs --- .github/workflows/template_changeset_check.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/template_changeset_check.yml b/.github/workflows/template_changeset_check.yml index c17f0a5..4bc2745 100644 --- a/.github/workflows/template_changeset_check.yml +++ b/.github/workflows/template_changeset_check.yml @@ -5,6 +5,7 @@ on: workflow_call jobs: changeset-check: name: changeset-check + if: (!contains(github.event.pull_request.user.login , '[bot]')) runs-on: ubuntu-24.04 steps: - name: Checkout code From 7493145d744c23b1ce84dd854e9a03920c1f29ea Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 14:53:12 +0100 Subject: [PATCH 24/34] ci: debug log npmrc --- .github/workflows/template_changeset_release.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index be970fc..7177556 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -59,6 +59,9 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.npm-token }} + - name: Creating .npmrc + run: cat "$HOME/.npmrc" + - name: Create Release Pull Request id: changesets uses: changesets/action@v1.4.9 From fc31429d1bad009881f3901ce7e677ae16b3a4f6 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 14:59:50 +0100 Subject: [PATCH 25/34] fix: use pnpm for publishing --- .github/workflows/template_changeset_release.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 7177556..d35f1f6 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -69,8 +69,13 @@ jobs: commit: 'chore(release): Bump package version' title: '📦 Release' createGithubReleases: true - publish: ${{ inputs.publish-script }} version: ${{inputs.version-script}} env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} - NPM_TOKEN: ${{ secrets.npm-token }} + + - name: Publish + if: steps.changesets.outputs.hasChangesets == 'false' + run: pnpm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.npm-token }} + From 6c398d86db2b85ad778d3e1a37930cc0cc67940e Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 15:01:34 +0100 Subject: [PATCH 26/34] fix: remove cat --- .github/workflows/template_changeset_release.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index d35f1f6..07317b4 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -59,9 +59,6 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.npm-token }} - - name: Creating .npmrc - run: cat "$HOME/.npmrc" - - name: Create Release Pull Request id: changesets uses: changesets/action@v1.4.9 From 986a8576d48e3bbabae63f36043fa0c1ed7840ff Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 16:59:23 +0100 Subject: [PATCH 27/34] fix: copy npmrc --- .github/workflows/template_changeset_release.yml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 07317b4..fd317cd 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -59,6 +59,9 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.npm-token }} + - name: copy npmrc + run: cp $NPM_CONFIG_USERCONFIG .npmrc + - name: Create Release Pull Request id: changesets uses: changesets/action@v1.4.9 @@ -67,12 +70,6 @@ jobs: title: '📦 Release' createGithubReleases: true version: ${{inputs.version-script}} + publish: ${{inputs.publish-script}} env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} - - - name: Publish - if: steps.changesets.outputs.hasChangesets == 'false' - run: pnpm publish - env: - NODE_AUTH_TOKEN: ${{ secrets.npm-token }} - From b501df5501cd5e8ff5607e78fd8e80031b47109d Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 17:09:10 +0100 Subject: [PATCH 28/34] fix: add debug output --- .github/workflows/template_changeset_release.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index fd317cd..56a7b14 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -60,7 +60,10 @@ jobs: NODE_AUTH_TOKEN: ${{ secrets.npm-token }} - name: copy npmrc - run: cp $NPM_CONFIG_USERCONFIG .npmrc + run: | + cp $NPM_CONFIG_USERCONFIG $HOME/.npmrc + echo $HOME + ls $HOME - name: Create Release Pull Request id: changesets From 728e201958c85bb1ace533ff05db758172b83885 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 17:10:32 +0100 Subject: [PATCH 29/34] fix: set home env var --- .github/workflows/template_changeset_release.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 56a7b14..3dc8649 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -64,6 +64,7 @@ jobs: cp $NPM_CONFIG_USERCONFIG $HOME/.npmrc echo $HOME ls $HOME + echo ${{ github.workspace}} - name: Create Release Pull Request id: changesets @@ -76,3 +77,4 @@ jobs: publish: ${{inputs.publish-script}} env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} + HOME: ${{ github.workspace }} From 4bad81096e15e584e3bd73c70ecb6832fff3cf35 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 17:11:51 +0100 Subject: [PATCH 30/34] fix: add node auth token --- .github/workflows/template_changeset_release.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 3dc8649..14b006e 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -59,13 +59,6 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.npm-token }} - - name: copy npmrc - run: | - cp $NPM_CONFIG_USERCONFIG $HOME/.npmrc - echo $HOME - ls $HOME - echo ${{ github.workspace}} - - name: Create Release Pull Request id: changesets uses: changesets/action@v1.4.9 @@ -78,3 +71,4 @@ jobs: env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} HOME: ${{ github.workspace }} + NODE_AUTH_TOKEN: ${{ secrets.npm-token }} From e442ee7a0e8fa720415fdb8e94740135880c8dd5 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Wed, 22 Jan 2025 17:20:00 +0100 Subject: [PATCH 31/34] chore: review feedback --- .github/workflows/template_changeset_release.yml | 8 ++++---- README.md | 9 ++++++++- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 14b006e..35aa2ad 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -14,7 +14,7 @@ on: required: false type: string version-script: - description: "The file script to run vor bumping the package versions. Defaults to `pnpm changeset version`" + description: "The file script to run for bumping the package versions. Defaults to `pnpm changeset version`" default: 'pnpm changeset version' required: false type: string @@ -64,10 +64,10 @@ jobs: uses: changesets/action@v1.4.9 with: commit: 'chore(release): Bump package version' - title: '📦 Release' + title: '📦 Release New Version' createGithubReleases: true - version: ${{inputs.version-script}} - publish: ${{inputs.publish-script}} + version: ${{ inputs.version-script }} + publish: ${{ inputs.publish-script }} env: GITHUB_TOKEN: ${{ steps.get_token.outputs.token }} HOME: ${{ github.workspace }} diff --git a/README.md b/README.md index 9b6dae8..4f59c7d 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ jobs: ⚠️ Make sure you have `@changesets/cli` installed as a dev-dependency in your project! ```yml -name: Release +name: Release Changesets on: push: @@ -152,6 +152,13 @@ jobs: publish-script: 'pnpm publish' # optional, defaults to `pnpm changeset version` version-script: 'pnpm version' + secrets: + # identifier of the GitHub App for authentication + app-id: ${{ }} + # private key of the GitHub App + private-key: ${{ }} + # needs write:packages rights + npm-token ${{ }} ``` From d8346def6069532685e909dbc28dccd6e5e697b4 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Thu, 23 Jan 2025 14:01:53 +0100 Subject: [PATCH 32/34] fix: final review feedback --- .github/workflows/template_changeset_release.yml | 16 ++++++++++++---- README.md | 6 +++--- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 35aa2ad..6bff8f1 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -9,15 +9,23 @@ on: required: false type: string publish-script: - description: "The file script to run on publish. Defaults to `pnpm release`" + description: "The script to run on publish. Defaults to `pnpm release`" default: 'pnpm release' required: false type: string version-script: - description: "The file script to run for bumping the package versions. Defaults to `pnpm changeset version`" + description: "The script to run for bumping the package versions. Defaults to `pnpm changeset version`" default: 'pnpm changeset version' required: false type: string + node-registry: + description: "The registry to use for Node.js packages." + required: false + type: string + node-registry-scope: + description: "The scope to use for Node.js packages." + required: false + type: string secrets: app_id: required: true @@ -51,8 +59,8 @@ jobs: with: node-version-file: ${{ inputs.node-version-file }} cache: 'pnpm' - registry-url: 'https://npm.pkg.github.com/' - scope: '@staffbase' + registry-url: ${{ inputs.node-registry }} + scope: ${{ inputs.node-registry-scope }} - name: Install Dependencies run: pnpm install --frozen-lockfile --ignore-scripts diff --git a/README.md b/README.md index 4f59c7d..3271d7e 100644 --- a/README.md +++ b/README.md @@ -146,11 +146,11 @@ jobs: changeset-release: uses: Staffbase/gha-workflows/.github/workflows/template_changeset_release.yml@v7.0.0 with: - # optional, defaults to `.nvmrc` + # optional: The file containing the Node.js version to use, defaults to .nvmrc node-version-file: '.node-version' - # optional, defaults to `pnpm release` + # optional: The script to run on publish. Defaults to `pnpm release` publish-script: 'pnpm publish' - # optional, defaults to `pnpm changeset version` + # optional: The script to run for bumping the package versions. Defaults to `pnpm changeset version` version-script: 'pnpm version' secrets: # identifier of the GitHub App for authentication From 950c92b1150c4c36e628010b16e6561c4e023064 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Thu, 23 Jan 2025 14:05:58 +0100 Subject: [PATCH 33/34] docs: add descriptions to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3271d7e..d9dc4c2 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,10 @@ jobs: publish-script: 'pnpm publish' # optional: The script to run for bumping the package versions. Defaults to `pnpm changeset version` version-script: 'pnpm version' + # optional: The registry to use for Node.js packages. + node-registry: 'https://npm.pkg.github.com/' + # optional: The scope to use for Node.js packages. + node-registry-scope: '@staffbase' secrets: # identifier of the GitHub App for authentication app-id: ${{ }} From b0e4c468393799ca89918c6fc7e63ce9ea53cd55 Mon Sep 17 00:00:00 2001 From: Alexander Gierlicki Date: Thu, 23 Jan 2025 14:06:48 +0100 Subject: [PATCH 34/34] chore: remove input descriptions --- .github/workflows/template_changeset_release.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/template_changeset_release.yml b/.github/workflows/template_changeset_release.yml index 6bff8f1..aff7809 100644 --- a/.github/workflows/template_changeset_release.yml +++ b/.github/workflows/template_changeset_release.yml @@ -4,26 +4,21 @@ on: workflow_call: inputs: node-version-file: - description: "The file containing the Node.js version to use, defaults to .nvmrc" default: '.nvmrc' required: false type: string publish-script: - description: "The script to run on publish. Defaults to `pnpm release`" default: 'pnpm release' required: false type: string version-script: - description: "The script to run for bumping the package versions. Defaults to `pnpm changeset version`" default: 'pnpm changeset version' required: false type: string node-registry: - description: "The registry to use for Node.js packages." required: false type: string node-registry-scope: - description: "The scope to use for Node.js packages." required: false type: string secrets: