Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
3bdf6be
feat: add changeset-check workflow
agierlicki Jan 21, 2025
5340598
feat: add changeset release workflow
agierlicki Jan 21, 2025
b5c2a3d
docs: add docs for changeset check workflow
agierlicki Jan 21, 2025
90b2b8c
docs: update readme versions
agierlicki Jan 21, 2025
6e41aff
docs: typo
agierlicki Jan 21, 2025
8f06aa9
fix: add checkout action to changeset check
agierlicki Jan 21, 2025
f27c3e5
fix: fetch and use pr base for diff
agierlicki Jan 21, 2025
87cc068
fix: add origin
agierlicki Jan 21, 2025
915f548
fix: use changed files action to get changesets
agierlicki Jan 21, 2025
1441be8
chore: remove changeset release workflow
agierlicki Jan 22, 2025
f36e2bd
chore: undo version bumps
agierlicki Jan 22, 2025
0e29d34
chore: remove trailing space
agierlicki Jan 22, 2025
83455ca
feat: re-add release workflow
agierlicki Jan 22, 2025
18046aa
feat: re-add release workflow
agierlicki Jan 22, 2025
32b5a5c
docs: improve release docs
agierlicki Jan 22, 2025
6ae02b6
docs: fix job name
agierlicki Jan 22, 2025
5d410f8
docs: add file extensions
agierlicki Jan 22, 2025
922201b
fix: use correct tokens
agierlicki Jan 22, 2025
f26571a
fix: fix typo in filename
agierlicki Jan 22, 2025
136c626
fix: use app token
agierlicki Jan 22, 2025
b759d7d
fix: use app token for checkout
agierlicki Jan 22, 2025
2e201b7
fix: pass npm token correctly
agierlicki Jan 22, 2025
12fff00
fix: don't trigger changeset checks for bot PRs
agierlicki Jan 22, 2025
7493145
ci: debug log npmrc
agierlicki Jan 22, 2025
fc31429
fix: use pnpm for publishing
agierlicki Jan 22, 2025
6c398d8
fix: remove cat
agierlicki Jan 22, 2025
986a857
fix: copy npmrc
agierlicki Jan 22, 2025
b501df5
fix: add debug output
agierlicki Jan 22, 2025
728e201
fix: set home env var
agierlicki Jan 22, 2025
4bad810
fix: add node auth token
agierlicki Jan 22, 2025
e442ee7
chore: review feedback
agierlicki Jan 22, 2025
d8346de
fix: final review feedback
agierlicki Jan 23, 2025
950c92b
docs: add descriptions to readme
agierlicki Jan 23, 2025
b0e4c46
chore: remove input descriptions
agierlicki Jan 23, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/template_changeset_check.yml
Original file line number Diff line number Diff line change
@@ -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: <!-- changeset-check -->

- 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-check -->
## 🦋 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-check -->
## ⚠️ 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
51 changes: 51 additions & 0 deletions .github/workflows/template_changeset_release.yml
Original file line number Diff line number Diff line change
@@ -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 }}
46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ on:

jobs:
<action name>:
uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.0.0
uses: Staffbase/gha-workflows/.github/workflows/template_*.yml@v7.1.0
with:
...
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -109,6 +109,24 @@ jobs:

</details>

### Changeset Check

<details>
<summary>The action can be used to check a PR for the existance of <a href="https://github.com/changesets/changesets">changeset</a> files. It will then add/update a comment on the PR.</summary>

```yml
name: Changeset Check
on:
pull_request:
types: [opened, reopened, synchronize]

jobs:
changeset-check:
uses: Staffbase/gha-workflows/.github/workflows/template_changeset_check@v7.1.0
```

</details>

### GitOps

<details>
Expand All @@ -120,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: "<your-registry>"
Expand Down Expand Up @@ -201,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'
Expand Down Expand Up @@ -234,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'
Expand All @@ -259,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
Expand Down Expand Up @@ -287,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
Expand Down Expand Up @@ -326,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'
Expand Down Expand Up @@ -357,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
```

</details>
Expand All @@ -376,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
Expand Down Expand Up @@ -413,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
Expand Down Expand Up @@ -445,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
Expand Down Expand Up @@ -477,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
Expand Down