Compare commits

...
Author SHA1 Message Date
Mateusz Burzyński 79d401e0bd Staged publishing support 2026-07-23 13:21:42 +02:00
Mateusz Burzyński 5b307d3df2 Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to changesets/action@v1 (#699)
* Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`

* better spy/mocking

* fmt

* shuffle
2026-07-23 09:34:32 +00:00
Mateusz Burzyński 84d78c68f9 Allow custom publish scripts to complete without a Changesets output file (#697) 2026-07-22 06:31:15 +00:00
Tee Ming c6cc0d84cb Update README.md with input/output kebab-case naming convention (#691)
* Update README.md

* Apply suggestion from @teemingc
2026-07-05 17:43:21 +00:00
Mateusz Burzyński e3e2663c0e Add uncommitted .github/actions/setup-bot-auth (#687)
* Add uncommitted `.github/actions/setup-bot-auth`

* tweak codeowners
2026-07-01 13:52:58 +00:00
Mateusz Burzyński e43c867727 Setup git user in the release script (#686)
* Setup git user in the release script

* refactor stuff
2026-07-01 13:29:33 +00:00
changesets-org-version-bot[bot]andgithub-actions[bot] 4b6e1f1099 Version Packages (next) (#677)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-07-01 12:28:07 +00:00
Mateusz Burzyński cf45e93c21 Use split publishing workflow (#679)
* fix release line timing

* Use split publishing workflow

* remove release check, handle through publish plan

* remove unused script

* remove unused publish plan output

* fmt

* update a thing

* fmt

* simplify

* update pre

* update changesets cli
2026-07-01 12:24:41 +00:00
Bjorn Lu 73591071e6 Rename root action inputs and outputs (#681) 2026-07-01 12:08:50 +00:00
Mateusz Burzyński f71ae043ed Expect publish output to be shared through a file (#678)
* Expect publish output to be shared through a file

* throw at all times

* match latest changes

* fmt

* rename things

* update changesets

* add changeset
2026-07-01 09:08:14 +00:00
Bjorn Lu ca57073900 Split git tag and github release options (#680)
* Split git tag and github release options

* Rename to push-git-tags

* Validate inputs
2026-07-01 07:30:13 +00:00
Bjorn Lu 0eae789230 Rename to kebab-case for root action inputs and outputs (#668)
* Rename to kebab-case for root action inputs and outputs

* Throw on renamed inputs
2026-06-30 08:24:21 +00:00
Bjorn Lu 164652bdd6 Remove GITHUB_TOKEN env var support (#674) 2026-06-30 00:20:57 +00:00
Bjorn LuandMateusz Burzyński a35a66bd1e Update @changesets/ghcommit to v3 beta (#675)
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-06-25 11:01:17 +00:00
Bjorn LuandMateusz Burzyński 823cf741ca Update to changesets v3 packages (#673)
* Update to changesets v3 packages

* Dedupe

* Fix test

* Fix test 2

* update more

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-06-25 10:58:02 +00:00
changesets-org-version-bot[bot]andgithub-actions[bot] b12c36a7bf Version Packages (next) (#671)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-24 10:28:35 +00:00
Mateusz Burzyński 5a8b9b721b Avoid putting the github token in the global .netrc file (#670)
* Avoid putting the github token in the global `.netrc` file

* fix wording
2026-06-24 10:07:11 +00:00
changesets-org-version-bot[bot]andgithub-actions[bot] 0490518932 Version Packages (next) (#664)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-23 11:29:25 +00:00
Mateusz Burzyński dc29b738b5 Fix the /version subaction to not crash on missing pr-base-branch input (#666)
* use `getOptionalInput` consistently

* introduce `getRequiredInput`

* add changeset
2026-06-23 11:26:43 +00:00
Mateusz Burzyński ccb38113ea Fix the computed publish plan path passed internally to changeset pack by the /pack subaction (#663)
* Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction

* fix it
2026-06-23 10:00:39 +00:00
Mateusz Burzyński cf37561cd9 Fix description of the /version's script input (#665) 2026-06-23 09:55:13 +00:00
Mateusz Burzyński 5c88881fff Fixed usage of --from-publish-plan flag used by the /pack subaction (#662) 2026-06-23 09:25:48 +00:00
Mateusz Burzyński dad5baf18b Pass the publishing app token to the release step (#661) 2026-06-23 07:31:13 +00:00
5210f6da68 Version Packages (next) (#660)
* Version Packages (next)

* fmt

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-06-23 06:56:02 +00:00
Bjorn LuandMateusz Burzyński a12d90de83 Add select-mode, version, pack and publish sub-actions (#656)
* Add select-mode, version, and publish sub-actions

* Rename

* No github-token needed for select-mode for now

* extend select-mode with publish-plan check and upload

* Rename base-branch to pr-base-branch

* add `pack` subaction

* `--from-pack` support in the publish subaction

* rename CLI arg

* update rolldown config

* rename pack dir input/output

* tweak retendion days

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-06-23 06:42:37 +00:00
Bjorn Lu 5649ff41b8 Remove cwd option (#659) 2026-06-23 06:35:46 +00:00
Mateusz Burzyński 4f718b5921 Removed compatibility support for old Changesets v1 (#657) 2026-06-15 08:03:20 +00:00
Mateusz Burzyński 1bf7c2782b Enter pre mode (#652) 2026-06-10 08:23:13 +00:00
Mateusz Burzyński 310b913a84 Don't update main release lines for prerelease versions (#653) 2026-06-10 01:40:16 +00:00
dependabot[bot] 7e238815d9 Bump the github-actions group across 1 directory with 3 updates (#648)
Bumps the github-actions group with 3 updates in the / directory: [actions/checkout](https://github.com/actions/checkout), [zizmorcore/zizmor-action](https://github.com/zizmorcore/zizmor-action) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token).


Updates `actions/checkout` from 6.0.2 to 6.0.3
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/de0fac2e4500dabe0009e67214ff5f5447ce83dd...df4cb1c069e1874edd31b4311f1884172cec0e10)

Updates `zizmorcore/zizmor-action` from 0.5.3 to 0.5.6
- [Release notes](https://github.com/zizmorcore/zizmor-action/releases)
- [Commits](https://github.com/zizmorcore/zizmor-action/compare/b1d7e1fb5de872772f31590499237e7cce841e8e...5f14fd08f7cf1cb1609c1e344975f152c7ee938d)

Updates `actions/create-github-app-token` from 3.1.1 to 3.2.0
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Changelog](https://github.com/actions/create-github-app-token/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/create-github-app-token/compare/1b10c78c7865c340bc4f6099eb2f838309f1e8c3...bcd2ba49218906704ab6c1aa796996da409d3eb1)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
- dependency-name: actions/create-github-app-token
  dependency-version: 3.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions
- dependency-name: zizmorcore/zizmor-action
  dependency-version: 0.5.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-09 16:46:46 +00:00
dependabot[bot] c211f5efab Bump the production-dependencies group with 2 updates (#649)
Bumps the production-dependencies group with 2 updates: [semver](https://github.com/npm/node-semver) and [tinyexec](https://github.com/tinylibs/tinyexec).


Updates `semver` from 7.8.0 to 7.8.1
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/main/CHANGELOG.md)
- [Commits](https://github.com/npm/node-semver/compare/v7.8.0...v7.8.1)

Updates `tinyexec` from 1.1.2 to 1.2.4
- [Release notes](https://github.com/tinylibs/tinyexec/releases)
- [Commits](https://github.com/tinylibs/tinyexec/compare/1.1.2...1.2.4)

---
updated-dependencies:
- dependency-name: semver
  dependency-version: 7.8.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: production-dependencies
- dependency-name: tinyexec
  dependency-version: 1.2.4
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: production-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-09 16:45:27 +00:00
Bjorn LuandMateusz Burzyński 70a83f1bd1 Update CI for prerelease and backports (#646)
* Update CI for prerelease and backports

* Fix

* Update permissions

* Apply suggestions from code review

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>

* comment

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-06-09 09:45:37 +00:00
Bjorn Lu 5273feb188 Update dependabot config (#647) 2026-06-09 08:06:36 +00:00
Adam Haglundandbluwy 8b7799e7d8 update note regarding pull_request_target (#644)
* Update README with pull_request_target usage guidelines

Add caution and warning notes regarding the use of pull_request_target event.

* Update README with pull_request_target caution

Added caution about using pull_request_target and alternative options.

* update wording for executing untrusted code

* Format

---------

Co-authored-by: bluwy <bjornlu.dev@gmail.com>
2026-06-08 15:05:55 +00:00
65 changed files with 3586 additions and 1356 deletions
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Allow custom publish scripts to complete without a Changesets output file, warning that GitHub releases and git tags cannot be created when that file is missing.
+7
View File
@@ -0,0 +1,7 @@
---
"@changesets/action": major
---
Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
+7 -6
View File
@@ -1,13 +1,14 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.6.2/schema.json",
"changelog": [
"@changesets/changelog-github",
{ "repo": "changesets/action" }
],
"$schema": "https://unpkg.com/@changesets/config@4.0.0-next.6/schema.json",
"changelog": "@changesets/changelog-github",
"commit": false,
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
"ignore": [],
"privatePackages": {
"version": true,
"tag": true
}
}
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": minor
---
Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Removed compatibility support for old Changesets v1.
+17
View File
@@ -0,0 +1,17 @@
---
"@changesets/action": major
---
Rename the root action inputs and outputs to better match the sub-actions' conventions.
Inputs:
- `version` -> `version-script`
- `publish` -> `publish-script`
- `commit` -> `commit-message`
- `title` -> `pr-title`
- `branch` -> `pr-base-branch`
Outputs:
- `pull-request-number` -> `pr-number`
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
+20
View File
@@ -0,0 +1,20 @@
{
"mode": "pre",
"tag": "next",
"changesets": [
"all-cars-grin",
"chubby-geese-sink",
"eight-clocks-pull",
"eighty-doors-swim",
"eighty-parks-tickle",
"fiery-toes-vanish",
"git-cli-auth-header",
"git-cli-server-url",
"lemon-turtles-itch",
"ready-mangos-boil",
"shaky-rings-type",
"shy-months-crash",
"silent-tips-dance",
"yellow-roses-fix"
]
}
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Update to Changesets v3 packages
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": minor
---
Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
+7
View File
@@ -0,0 +1,7 @@
---
"@changesets/action": minor
---
Add staged publishing support to the publish action and a GitHub release action
that validates the staged handoff, verifies approved packages, and creates tags
and releases idempotently.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
+1 -1
View File
@@ -1,4 +1,4 @@
/.github/workflows/** @Andarist @bluwy @emmatown
/.github/** @Andarist @bluwy @emmatown
/action.yml @Andarist @bluwy @emmatown
/scripts/bump.ts @Andarist @bluwy @emmatown
/scripts/release.ts @Andarist @bluwy @emmatown
+44
View File
@@ -0,0 +1,44 @@
name: Setup bot auth
description: Create a GitHub App token and configure matching git identity
inputs:
client-id:
description: GitHub App client ID
required: true
private-key:
description: GitHub App private key
required: true
permission-contents:
description: Contents permission for the GitHub App token
required: false
default: write
permission-pull-requests:
description: Pull requests permission for the GitHub App token
required: false
outputs:
token:
description: GitHub App installation access token
value: ${{ steps.app-token.outputs.token }}
runs:
using: composite
steps:
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
id: app-token
with:
client-id: ${{ inputs.client-id }}
private-key: ${{ inputs.private-key }}
permission-contents: ${{ inputs.permission-contents }}
permission-pull-requests: ${{ inputs.permission-pull-requests }}
- name: Setup Git user
shell: bash
run: |
app_user="$APP_SLUG[bot]"
app_id="$(gh api "/users/$app_user" --jq .id)"
git config user.name "$app_user"
git config user.email "$app_id+$app_user@users.noreply.github.com"
env:
APP_SLUG: ${{ steps.app-token.outputs.app-slug }}
GH_TOKEN: ${{ steps.app-token.outputs.token }}
+27 -8
View File
@@ -1,13 +1,32 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
cooldown:
default-days: 7
open-pull-requests-limit: 10
versioning-strategy: increase
groups:
production-dependencies:
dependency-type: "production"
update-types:
- minor
- patch
development-dependencies:
dependency-type: "development"
update-types:
- minor
- patch
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
cooldown:
default-days: 7
open-pull-requests-limit: 5
groups:
github-actions:
patterns:
- "*"
+11 -11
View File
@@ -7,6 +7,9 @@ on:
merge_group:
branches:
- main
- next
# merge group rulesets don't allow wildcards so in settings each maintenance branch needs to be added separately
- "maintenance/v*" # branch rulesets don't support v[0-9]+
permissions:
contents: read
@@ -24,12 +27,12 @@ jobs:
security-events: write # allow writing security events
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- name: Run zizmor
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
uses: zizmorcore/zizmor-action@5f14fd08f7cf1cb1609c1e344975f152c7ee938d # v0.5.6
with:
persona: pedantic
annotations: true
@@ -37,12 +40,11 @@ jobs:
test:
name: Test
timeout-minutes: 20
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
@@ -53,12 +55,11 @@ jobs:
typecheck:
name: Typecheck
timeout-minutes: 20
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
@@ -69,12 +70,11 @@ jobs:
lint:
name: Lint
timeout-minutes: 20
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
+67 -39
View File
@@ -4,6 +4,8 @@ on:
push:
branches:
- main
- next
- "maintenance/v*" # branch rulesets don't support v[0-9]+
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
@@ -13,20 +15,17 @@ concurrency:
permissions: {} # each job should define its own permission explicitly
jobs:
version:
name: Version
select-mode:
name: Select mode
runs-on: ubuntu-latest
environment: version
timeout-minutes: 20
outputs:
hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
mode: ${{ steps.select-mode.outputs.mode }}
permissions:
contents: write # to create release (changesets/action)
issues: write # to post issue comments (changesets/action)
pull-requests: write # to create pull request (changesets/action)
contents: read # to check out repo (actions/checkout)
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
@@ -37,41 +36,24 @@ jobs:
- name: Build
run: pnpm build
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Select mode
id: select-mode
uses: ./select-mode
- name: Create or update release pull request
id: changesets
uses: ./
with:
github-token: ${{ steps.app-token.outputs.token }}
version: pnpm bump
publish:
name: Publish
if: needs.version.outputs.hasChangesets == 'false'
needs: version
version:
name: Version
if: needs.select-mode.outputs.mode == 'version'
needs: select-mode
runs-on: ubuntu-latest
environment: marketplace
environment: version
timeout-minutes: 20
permissions:
contents: write # to create release and have it authored by github-actions (changesets/action)
contents: read # to check out repo (actions/checkout)
steps:
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: true
# we need this token to bypass the branch and tag protection rules
token: ${{ steps.app-token.outputs.token }}
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
@@ -80,7 +62,53 @@ jobs:
- name: Build
run: pnpm build
- name: Publish to marketplace
uses: ./
- uses: ./.github/actions/setup-bot-auth
id: bot-auth
with:
publish: pnpm release
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to create version commits (changesets/action)
permission-pull-requests: write # to create pull request (changesets/action)
- name: Create or update release pull request
id: changesets
uses: ./version
with:
github-token: ${{ steps.bot-auth.outputs.token }}
setup-git-user: false
script: pnpm bump
publish:
name: Publish
if: needs.select-mode.outputs.mode == 'publish'
needs: select-mode
runs-on: ubuntu-latest
environment: marketplace
timeout-minutes: 20
permissions:
contents: write # to create release and have it authored by github-actions (changesets/action)
steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- uses: ./.github/actions/setup-bot-auth
id: bot-auth
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to bypass branch and tag protection rules (release.ts)
- name: Publish to marketplace
uses: ./publish
with:
github-token: ${{ steps.bot-auth.outputs.token }}
script: pnpm release
+9 -5
View File
@@ -123,7 +123,7 @@ jobs:
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
@@ -166,13 +166,17 @@ jobs:
- name: Build
run: pnpm build
- name: Setup Git user
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- uses: ./.github/actions/setup-bot-auth
id: bot-auth
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to push the release snapshot branch (release-pr.ts)
- name: Release snapshot version
run: pnpm release:pr
env:
GITHUB_TOKEN: ${{ steps.bot-auth.outputs.token }}
- name: Add success reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='rocket'
+60
View File
@@ -1,5 +1,65 @@
# @changesets/action
## 2.0.0-next.3
### Major Changes
- [#680](https://github.com/changesets/action/pull/680) [`ca57073`](https://github.com/changesets/action/commit/ca57073900dc678254406a052a03c0c8824e319d) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
- [#681](https://github.com/changesets/action/pull/681) [`7359107`](https://github.com/changesets/action/commit/73591071e61c7f61cf322dd7a6341dc29a8e1d4e) Thanks [@bluwy](https://github.com/bluwy)! - Rename the root action inputs and outputs to better match the sub-actions' conventions.
Inputs:
- `version` -> `version-script`
- `publish` -> `publish-script`
- `commit` -> `commit-message`
- `title` -> `pr-title`
- `branch` -> `pr-base-branch`
Outputs:
- `pull-request-number` -> `pr-number`
- [#674](https://github.com/changesets/action/pull/674) [`164652b`](https://github.com/changesets/action/commit/164652bdd60525670d95291addb8c6f92833ac60) Thanks [@bluwy](https://github.com/bluwy)! - Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
- [#673](https://github.com/changesets/action/pull/673) [`823cf74`](https://github.com/changesets/action/commit/823cf741ca57c5e22652123d3a847dfafcd77ca0) Thanks [@bluwy](https://github.com/bluwy)! - Update to Changesets v3 packages
- [#668](https://github.com/changesets/action/pull/668) [`0eae789`](https://github.com/changesets/action/commit/0eae789230defbc4ad287e9b476aba7e842e34e0) Thanks [@bluwy](https://github.com/bluwy)! - Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
### Minor Changes
- [#678](https://github.com/changesets/action/pull/678) [`f71ae04`](https://github.com/changesets/action/commit/f71ae043ed5deb17952900091e009a60edef9507) Thanks [@Andarist](https://github.com/Andarist)! - Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
## 2.0.0-next.2
### Patch Changes
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
## 2.0.0-next.1
### Patch Changes
- [#663](https://github.com/changesets/action/pull/663) [`ccb3811`](https://github.com/changesets/action/commit/ccb38113eaaa4a13eb6aabe09520e49cc8519b84) Thanks [@Andarist](https://github.com/Andarist)! - Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
- [#662](https://github.com/changesets/action/pull/662) [`5c88881`](https://github.com/changesets/action/commit/5c88881fff1f0d8b055d4a2d3a74a8ce843db6f3) Thanks [@Andarist](https://github.com/Andarist)! - Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
- [#666](https://github.com/changesets/action/pull/666) [`dc29b73`](https://github.com/changesets/action/commit/dc29b738b532d9e95f46b9bf493e2e3fdf48a7ed) Thanks [@Andarist](https://github.com/Andarist)! - Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
## 2.0.0-next.0
### Major Changes
- [#657](https://github.com/changesets/action/pull/657) [`4f718b5`](https://github.com/changesets/action/commit/4f718b5921490b1efeb015a81abb6a4633892851) Thanks [@Andarist](https://github.com/Andarist)! - Removed compatibility support for old Changesets v1.
- [#659](https://github.com/changesets/action/pull/659) [`5649ff4`](https://github.com/changesets/action/commit/5649ff41b8eb1b7a281011e45df781c6d4628fd0) Thanks [@bluwy](https://github.com/bluwy)! - Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
### Minor Changes
- [#656](https://github.com/changesets/action/pull/656) [`a12d90d`](https://github.com/changesets/action/commit/a12d90de8394e63c952622b2fd3f98c8729c48b0) Thanks [@bluwy](https://github.com/bluwy)! - Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
## 1.9.0
### Minor Changes
+23 -17
View File
@@ -1,5 +1,8 @@
# Changesets Release Action
> [!IMPORTANT]
> This is the development branch for `changesets/action` v2 compatible with Changesets v3. For the v1 code compatible with Changesets v2, check out the [`maintenance/v1`](https://github.com/changesets/action/tree/maintenance/v1) branch.
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details:
@@ -11,20 +14,23 @@ There are also sub-actions hosted in this repository. Check out their respective
### Inputs
- publish - The command to use to build and publish packages
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- commit - The commit message to use. Default to `Version Packages`
- title - The pull request title. Default to `Version Packages`
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
- publish-script - The command to use to build and publish packages
- version-script - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- commit-message - The commit message to use. Default to `Version Packages`
- pr-title - The pull request title. Default to `Version Packages`
- setup-git-user - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
- create-github-releases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- push-git-tags - A boolean value to indicate whether to create git tags after `publish` or not. Default to `true`
- commit-mode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
- pr-draft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode
- github-token - Passes a custom GitHub token
### Outputs
- published - A boolean value to indicate whether a publishing has happened or not
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
- published-packages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
- staged-release-artifact-id - The exact artifact id for staged packages emitted by a configured or custom publish command
### Example workflow
@@ -62,7 +68,7 @@ jobs:
run: pnpm install --frozen-lockfile
- name: Create Release Pull Request
uses: changesets/action@v1
uses: changesets/action@v2
```
#### With Publishing
@@ -100,10 +106,10 @@ jobs:
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
uses: changesets/action@v2
with:
# This expects you to have a script called release which does a build for your packages and calls changeset publish
publish: pnpm release
publish-script: pnpm release
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -167,7 +173,7 @@ jobs:
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
uses: changesets/action@v2
- name: Publish
if: steps.changesets.outputs.hasChangesets == 'false'
@@ -211,10 +217,10 @@ jobs:
run: pnpm install --frozen-lockfile
- name: Create Release Pull Request
uses: changesets/action@v1
uses: changesets/action@v2
with:
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
version: pnpm version
version-script: pnpm version
```
#### With Yarn 2 / Plug'n'Play
@@ -222,8 +228,8 @@ jobs:
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI:
```yaml
- uses: changesets/action@v1
- uses: changesets/action@v2
with:
version: yarn changeset version
version-script: yarn changeset version
# ...
```
+28 -22
View File
@@ -8,31 +8,37 @@ inputs:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
publish:
publish-script:
description: "The command to use to build and publish packages"
required: false
version:
version-script:
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
required: false
cwd:
description: Sets the cwd for the node process. Default to `process.cwd()`
commit-message:
description: "The commit message. Default to `Version Packages`"
required: false
commit:
description: |
The commit message. Default to `Version Packages`
default: "Version Packages"
pr-title:
description: "The pull request title. Default to `Version Packages`"
required: false
title:
description: The pull request title. Default to `Version Packages`
default: "Version Packages"
pr-draft:
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
required: false
setupGitUser:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false
create-github-releases:
description: "Whether to create Github releases after publish"
required: false
default: true
createGithubReleases:
description: "A boolean value to indicate whether to create Github releases after `publish` or not"
push-git-tags:
description: >
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
this option will also always be `true`.
required: false
default: true
commitMode:
commit-mode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
@@ -40,21 +46,21 @@ inputs:
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
branch:
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
required: false
prDraft:
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
setup-git-user:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
required: false
default: true
outputs:
published:
description: A boolean value to indicate whether a publishing is happened or not
publishedPackages:
published-packages:
description: >
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
hasChangesets:
staged-release-artifact-id:
description: Artifact id for a staged release handoff emitted by the publish script
has-changesets:
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
pullRequestNumber:
pr-number:
description: The pull request number that was created or updated
branding:
icon: "package"
+13
View File
@@ -0,0 +1,13 @@
# changesets/action/github-release
Finalizes packages produced by staged publishing. Pass the exact
`staged-release-artifact-id` output from `changesets/action/publish`.
By default the action waits up to two minutes for every approved package
version to become visible before creating any Git tag or GitHub Release.
Private registries therefore need read authentication configured before this
step. Set `verify-published: false` to skip that check.
The handoff is bound to the repository, workflow run, and commit. Tags and
releases are created idempotently; a tag that already points at another commit
is rejected.
+23
View File
@@ -0,0 +1,23 @@
name: Changesets - GitHub Release
description: Create Git tags and GitHub Releases after approving a staged publish
runs:
using: node24
main: ../dist/github-release.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
staged-release-artifact-id:
description: "The exact artifact id emitted by the publish action"
required: true
verify-published:
description: "Verify that every approved package is visible in its configured registry before creating tags and releases"
required: false
default: true
outputs:
released-packages:
description: "A JSON array of packages finalized by this action"
branding:
icon: package
color: blue
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/pack
TODO
+15
View File
@@ -0,0 +1,15 @@
name: Changesets - Pack
description: Pack publishable packages into tarballs
runs:
using: node24
main: ../dist/pack.js
inputs:
publish-plan-artifact-id:
description: "Artifact id for a publish plan generated by the select-mode subaction"
required: false
outputs:
pack-dir-artifact-id:
description: "Artifact id for the packed output directory"
branding:
icon: package
color: blue
+15 -13
View File
@@ -1,6 +1,7 @@
{
"name": "@changesets/action",
"version": "1.9.0",
"version": "2.0.0-next.3",
"private": true,
"license": "MIT",
"type": "module",
"main": "dist/index.js",
@@ -17,27 +18,28 @@
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts"
},
"dependencies": {
"@actions/artifact": "^6.2.1",
"@actions/core": "^3.0.1",
"@actions/exec": "^3.0.0",
"@actions/github": "^9.1.1",
"@changesets/get-release-plan": "^4.0.16",
"@changesets/ghcommit": "^2.1.1",
"@changesets/git": "^3.0.4",
"@changesets/pre": "^2.0.2",
"@changesets/read": "^0.6.7",
"@manypkg/get-packages": "^1.1.3",
"@changesets/get-release-plan": "^5.0.0-next.7",
"@changesets/ghcommit": "^3.0.0-next.1",
"@changesets/git": "^4.0.0-next.6",
"@changesets/pre": "^3.0.0-next.6",
"@changesets/read": "^1.0.0-next.7",
"@manypkg/get-packages": "^3.1.0",
"@octokit/core": "^7.0.6",
"@octokit/plugin-throttling": "^11.0.3",
"human-id": "^4.1.3",
"markdown-table": "^3.0.4",
"semver": "^7.8.0",
"tinyexec": "^1.1.2"
"semver": "^7.8.1",
"tinyexec": "^1.2.4"
},
"devDependencies": {
"@changesets/changelog-github": "^0.7.0",
"@changesets/cli": "^2.31.0",
"@changesets/types": "^6.1.0",
"@changesets/write": "^0.4.0",
"@changesets/changelog-github": "^1.0.0-next.6",
"@changesets/cli": "^3.0.0-next.8",
"@changesets/types": "^7.0.0-next.6",
"@changesets/write": "^1.0.0-next.6",
"@tsconfig/node24": "^24.0.4",
"@types/node": "^24.12.4",
"@types/semver": "^7.7.1",
+1131 -952
View File
File diff suppressed because it is too large Load Diff
+17 -1
View File
@@ -3,7 +3,23 @@ dedupePeers: true
dedupePeerDependents: true
minimumReleaseAge: 10080
minimumReleaseAgeExclude:
- "@changesets/ghcommit@2.1.1"
- "@changesets/apply-release-plan@8.0.0-next.7"
- "@changesets/assemble-release-plan@7.0.0-next.7"
- "@changesets/changelog-git@1.0.0-next.6"
- "@changesets/changelog-github@1.0.0-next.6"
- "@changesets/cli@3.0.0-next.8"
- "@changesets/config@4.0.0-next.6"
- "@changesets/get-dependents-graph@3.0.0-next.6"
- "@changesets/get-github-info@1.0.0-next.3"
- "@changesets/get-release-plan@5.0.0-next.7"
- "@changesets/ghcommit@3.0.0-next.1"
- "@changesets/git@4.0.0-next.6"
- "@changesets/parse@1.0.0-next.7"
- "@changesets/pre@3.0.0-next.6"
- "@changesets/read@1.0.0-next.7"
- "@changesets/should-skip-package@1.0.0-next.6"
- "@changesets/types@7.0.0-next.6"
- "@changesets/write@1.0.0-next.6"
overrides:
lightningcss: "-" # we do not bundle any css
+15 -5
View File
@@ -2,7 +2,18 @@
This action generates the changesets status in PRs, e.g. whether it has changeset files and which packages will be released if the PR is merged.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages. It also requires the [`pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) event to be triggered in order to have permissions to comment on the PR and to work in PRs from forks.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages.
See the [action metadata](action.yml) for details on the inputs and outputs.
> [!CAUTION]
> **This action uses `pull_request_target` by default to support PRs from forks.**
>
> **Do not run untrusted code** when using the `pull_request_target` event.
>
> The example below only **_checks out_** and **_reads_** code, and does not **_execute_** any code from the fork.
>
> Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs:
@@ -13,10 +24,7 @@ jobs:
# ...
```
See the [action metadata](action.yml) for details on the inputs and outputs.
> [!WARNING]
> **Do not run untrusted code** when using the `pull_request_target` event. The example below only checks out code and does not run any code from the PR. Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
You can also use the [Changesets Bot](https://github.com/apps/changeset-bot) if you don't want an extra action in your repo, or are worried about the `pull_request_target` event.
## Example setup
@@ -27,6 +35,8 @@ name: Comment Changesets status in PRs
on:
pull_request_target:
permissions: {} # require explicitly stating all permissions in each job
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
+24
View File
@@ -0,0 +1,24 @@
# changesets/action/publish
Publishes packages with Changesets.
Set the optional `stage` input to `true` or `false` to override
`stagedPublishing` from the Changesets config. The input is tri-state: omitting
it leaves the config in control. An explicit `stage` cannot be combined with a
custom `script`; configure the script itself instead.
When packages are staged, the action uploads a 30-day handoff and returns its
exact id as `staged-release-artifact-id`. It also prints a topologically
ordered approval command:
```sh
changeset stage approve <id...>
```
That command is only a convenience and uses the default registry. For custom
or multiple registries, split the IDs into correctly scoped commands and pass
`--registry` to each.
After approval, pass the artifact id to
`changesets/action/github-release` to verify publication and create Git tags
and GitHub Releases.
+43
View File
@@ -0,0 +1,43 @@
name: Changesets - Publish
description: Publish packages to npm
runs:
using: node24
main: ../dist/publish.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
script:
description: "The command to use to publish packages"
required: false
stage:
description: >
Whether to use staged publishing. Omit to use the Changesets config,
set to true for --stage, or false for --no-stage. Cannot be combined
with a custom script.
required: false
pack-dir-artifact-id:
description: "Artifact id for packed publish output generated by the pack subaction"
required: false
create-github-releases:
description: "Whether to create Github releases after publish"
required: false
default: true
push-git-tags:
description: >
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
this option will also always be `true`.
required: false
default: true
outputs:
published:
description: "A boolean value to indicate whether a publishing has happened or not"
published-packages:
description: >
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
staged-release-artifact-id:
description: "Artifact id for the staged release handoff"
branding:
icon: package
color: blue
+7 -2
View File
@@ -3,8 +3,13 @@ import { defineConfig } from "rolldown";
export default defineConfig({
input: {
index: "src/index.ts",
["pr-status"]: "src/pr-status/index.ts",
["pr-comment"]: "src/pr-comment/index.ts",
pack: "src/pack/index.ts",
"pr-status": "src/pr-status/index.ts",
"pr-comment": "src/pr-comment/index.ts",
"select-mode": "src/select-mode/index.ts",
version: "src/version/index.ts",
publish: "src/publish/index.ts",
"github-release": "src/github-release/index.ts",
},
output: {
dir: "dist",
+3 -1
View File
@@ -1,12 +1,14 @@
import fs from "node:fs";
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
process.chdir(path.join(import.meta.dirname, ".."));
await exec("changeset", ["version"]);
// read after versioning to get the new version
const pkgJson = (await import("../package.json", { with: { type: "json" } }))
.default;
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const readmePath = path.join(import.meta.dirname, "..", "README.md");
+19 -6
View File
@@ -1,9 +1,21 @@
import { Buffer } from "node:buffer";
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = "pr-release";
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, ".."));
@@ -11,9 +23,10 @@ await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("git", [
"push",
"--force",
"origin",
`HEAD:refs/heads/${releaseLine}`,
]);
await exec(
"git",
["push", "--force", "origin", `HEAD:refs/heads/${releaseLine}`],
{
env: gitEnv,
},
);
+36 -30
View File
@@ -1,41 +1,47 @@
import { Buffer } from "node:buffer";
import path from "node:path";
import { exec, getExecOutput } from "@actions/exec";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const isPrerelease = pkgJson.version.includes("-");
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, ".."));
(async () => {
const { exitCode, stderr } = await getExecOutput(
`git`,
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("changeset", ["git-tag"]);
if (isPrerelease) {
await exec("git", ["push", "origin", `refs/tags/${tag}`], {
env: gitEnv,
});
} else {
await exec(
"git",
[
"push",
"--force",
"--follow-tags",
"origin",
`HEAD:refs/heads/${releaseLine}`,
],
{
ignoreReturnCode: true,
env: gitEnv,
},
);
if (exitCode === 0) {
console.log(
`Action is not being published because version ${tag} is already published`,
);
return;
}
if (exitCode !== 2) {
throw new Error(`git ls-remote exited with ${exitCode}:\n${stderr}`);
}
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("changeset", ["tag"]);
await exec("git", [
"push",
"--force",
"--follow-tags",
"origin",
`HEAD:refs/heads/${releaseLine}`,
]);
})();
}
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/select-mode
TODO
+14
View File
@@ -0,0 +1,14 @@
name: Changesets - Select Mode
description: Whether to version or publish in the current repo state
runs:
using: node24
main: ../dist/select-mode.js
inputs: {}
outputs:
mode:
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
publish-plan-artifact-id:
description: "Artifact id for the generated publish plan when mode is `publish`"
branding:
icon: package
color: blue
+46
View File
@@ -0,0 +1,46 @@
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import {
downloadAndValidateStagedRelease,
finalizeStagedRelease,
} from "../staged-release.ts";
import { getOptionalBooleanInput, getRequiredInput } from "../utils.ts";
try {
await main();
} catch (error) {
core.setFailed((error as Error).message);
}
async function main() {
const cwd = process.cwd();
const github = new GitHub({
cwd,
githubToken: getRequiredInput("github-token"),
commitMode: "github-api",
});
const artifactId = Number(getRequiredInput("staged-release-artifact-id"));
const verify = getOptionalBooleanInput("verify-published") ?? true;
const { handoff, packagesByName } = await downloadAndValidateStagedRelease(
artifactId,
cwd,
);
await finalizeStagedRelease({
github,
handoff,
packagesByName,
cwd,
verify,
});
core.setOutput(
"released-packages",
JSON.stringify(
handoff.releases.map((release) => ({
name: release.packageName,
version: release.version,
})),
),
);
}
+71 -28
View File
@@ -1,11 +1,15 @@
import { Buffer } from "node:buffer";
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github";
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
import type { Octokit } from "./octokit.ts";
import { context } from "@actions/github";
import { commitChangesSinceBase } from "@changesets/ghcommit";
import { setupOctokit, type Octokit } from "./octokit.ts";
export type CommitMode = "git-cli" | "github-api";
type GitOptions = {
cwd: string;
env?: Record<string, string>;
};
const push = async (branch: string, options: GitOptions) => {
@@ -46,17 +50,51 @@ const checkIfClean = async (options: GitOptions): Promise<boolean> => {
return !stdout.length;
};
export class Git {
readonly octokit: Octokit | null;
export class GitHub {
readonly #githubToken: string;
readonly octokit: Octokit;
readonly cwd: string;
readonly commitMode: CommitMode;
constructor(args: { octokit?: Octokit; cwd: string }) {
this.octokit = args.octokit ?? null;
this.cwd = args.cwd;
constructor(options: {
githubToken: string;
cwd: string;
commitMode?: CommitMode;
}) {
this.#githubToken = options.githubToken;
this.cwd = options.cwd;
this.commitMode = options.commitMode ?? "git-cli";
this.octokit = setupOctokit(options.githubToken);
}
getToken() {
return this.#githubToken;
}
#getCliAuthEnv(): Record<string, string> {
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
"base64",
);
const serverUrl = (
context.serverUrl ??
process.env.GITHUB_SERVER_URL ??
"https://github.com"
).replace(/\/+$/, "");
const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0);
if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) {
throw new Error(
`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`,
);
}
return {
GIT_CONFIG_COUNT: String(gitConfigCount + 1),
[`GIT_CONFIG_KEY_${gitConfigCount}`]: `http.${serverUrl}/.extraheader`,
[`GIT_CONFIG_VALUE_${gitConfigCount}`]: `AUTHORIZATION: basic ${basic}`,
};
}
async setupUser() {
if (this.octokit) {
if (this.commitMode === "github-api") {
return;
}
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
@@ -76,54 +114,59 @@ export class Git {
}
async pushTag(tag: string) {
if (this.octokit) {
if (this.commitMode === "github-api") {
return this.octokit.rest.git
.createRef({
...github.context.repo,
...context.repo,
ref: `refs/tags/${tag}`,
sha: github.context.sha,
sha: context.sha,
})
.catch((err) => {
// Assuming tag was manually pushed in custom publish script
core.warning(`Failed to create tag ${tag}: ${err.message}`);
});
}
await exec("git", ["push", "origin", tag], { cwd: this.cwd });
await exec("git", ["push", "origin", tag], {
cwd: this.cwd,
env: {
...process.env,
...this.#getCliAuthEnv(),
} as Record<string, string>,
});
}
async prepareBranch(branch: string) {
if (this.octokit) {
if (this.commitMode === "github-api") {
// Preparing a new local branch is not necessary when using the API
return;
}
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(github.context.sha, { cwd: this.cwd });
await reset(context.sha, { cwd: this.cwd });
}
async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.octokit) {
/**
* Only add files form the current working directory
*
* This will emulate the behavior of `git add .`,
* used in {@link commitAll}.
*/
const addFromDirectory = this.cwd;
return commitChangesFromRepo({
if (this.commitMode === "github-api") {
await commitChangesSinceBase({
octokit: this.octokit,
...github.context.repo,
...context.repo,
branch,
message,
base: {
commit: github.context.sha,
commit: context.sha,
},
cwd: this.cwd,
force: true,
});
return;
}
if (!(await checkIfClean({ cwd: this.cwd }))) {
await commitAll(message, { cwd: this.cwd });
}
await push(branch, { cwd: this.cwd });
await push(branch, {
cwd: this.cwd,
env: {
...process.env,
...this.#getCliAuthEnv(),
} as Record<string, string>,
});
}
}
+71 -46
View File
@@ -1,59 +1,69 @@
import fs from "node:fs/promises";
import path from "node:path";
import * as core from "@actions/core";
import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import { GitHub } from "./github.ts";
import readChangesetState from "./readChangesetState.ts";
import { runPublish, runVersion } from "./run.ts";
import { fileExists } from "./utils.ts";
const getOptionalInput = (name: string) => core.getInput(name) || undefined;
import { uploadStagedRelease } from "./staged-release.ts";
import {
fileExists,
getOptionalInput,
getRequiredInput,
throwOnRenamedInputs,
validateChangesetsCliVersion,
} from "./utils.ts";
(async () => {
// to maintain compatibility with workflows created before github-token input was introduced
// it's important to prefer the explicitly set GITHUB_TOKEN over the default token coming from github.token
let githubToken = process.env.GITHUB_TOKEN || core.getInput("github-token");
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
await validateChangesetsCliVersion(cwd);
if (!githubToken) {
core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
return;
throwOnRenamedInputs({
publish: "publish-script",
version: "version-script",
commit: "commit-mesage",
title: "pr-title",
branch: "pr-base-branch",
prDraft: "pr-draft",
createGithubReleases: "create-github-releases",
commitMode: "commit-mode",
setupGitUser: "setup-git-user",
});
const githubToken = getRequiredInput("github-token");
if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) {
throw new Error(
'The GITHUB_TOKEN environment variable is set and does not match the "github-token" input. ' +
'Please pass the custom GitHub token to the "github-token" input and ' +
"remove the GITHUB_TOKEN environment variable to avoid conflicts.",
);
}
const cwd = path.resolve(getOptionalInput("cwd") ?? "");
core.info(`using resolved cwd: ${cwd}`);
const octokit = setupOctokit(githubToken);
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
const prDraft = getOptionalInput("prDraft");
const commitMode = getOptionalInput("commit-mode") ?? "git-cli";
const prDraft = getOptionalInput("pr-draft");
if (commitMode !== "git-cli" && commitMode !== "github-api") {
core.setFailed(`Invalid commit mode: ${commitMode}`);
return;
}
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid prDraft: ${prDraft}`);
core.setFailed(`Invalid pr-draft: ${prDraft}`);
return;
}
const git = new Git({
octokit: commitMode === "github-api" ? octokit : undefined,
const github = new GitHub({
cwd,
githubToken,
commitMode,
});
let setupGitUser = core.getBooleanInput("setupGitUser");
let setupGitUser = core.getBooleanInput("setup-git-user");
if (setupGitUser) {
core.info("setting git user");
await git.setupUser();
await github.setupUser();
}
core.info("setting GitHub credentials");
await fs.writeFile(
`${process.env.HOME}/.netrc`,
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`,
);
let { changesets } = await readChangesetState(cwd);
let publishScript = core.getInput("publish");
let publishScript = core.getInput("publish-script");
let hasChangesets = changesets.length !== 0;
const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0,
@@ -61,8 +71,8 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
let hasPublishScript = !!publishScript;
core.setOutput("published", "false");
core.setOutput("publishedPackages", "[]");
core.setOutput("hasChangesets", String(hasChangesets));
core.setOutput("published-packages", "[]");
core.setOutput("has-changesets", String(hasChangesets));
switch (true) {
case !hasChangesets && !hasPublishScript:
@@ -120,19 +130,37 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
);
}
const createGithubReleases = core.getBooleanInput(
"create-github-releases",
);
const pushGitTags = core.getBooleanInput("push-git-tags");
if (createGithubReleases && !pushGitTags) {
throw new Error(
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " +
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " +
"or set 'create-github-releases' to false.",
);
}
const result = await runPublish({
script: publishScript,
githubToken,
git,
octokit,
createGithubReleases: core.getBooleanInput("createGithubReleases"),
github,
createGithubReleases,
pushGitTags,
cwd,
});
if (result.stagedPackages?.length) {
const artifactId = await uploadStagedRelease(
result.stagedPackages,
result.exitCode === 0 ? "approve" : "reject",
);
core.setOutput("staged-release-artifact-id", String(artifactId));
}
if (result.published) {
core.setOutput("published", "true");
core.setOutput(
"publishedPackages",
"published-packages",
JSON.stringify(result.publishedPackages),
);
}
@@ -155,21 +183,18 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
core.info("All changesets are empty; not creating PR");
return;
case hasChangesets: {
const octokit = setupOctokit(githubToken);
const { pullRequestNumber } = await runVersion({
script: getOptionalInput("version"),
githubToken,
git,
octokit,
script: getOptionalInput("version-script"),
github,
cwd,
prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit"),
prTitle: getOptionalInput("pr-title"),
commitMessage: getOptionalInput("commit-message"),
hasPublishScript,
prDraft,
branch: getOptionalInput("branch"),
branch: getOptionalInput("pr-base-branch"),
});
core.setOutput("pullRequestNumber", String(pullRequestNumber));
core.setOutput("pr-number", String(pullRequestNumber));
return;
}
+89
View File
@@ -0,0 +1,89 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import {
downloadArtifact,
execChangesetsCli,
getOptionalInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
await validateChangesetsCliVersion(cwd);
const publishPlanArtifactId = getOptionalInput("publish-plan-artifact-id");
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
const outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`);
await pack(cwd, {
outDir,
publishPlanPath: publishPlanArtifactId
? await downloadPublishPlanArtifact(tmpDir, Number(publishPlanArtifactId))
: undefined,
});
const packDirArtifact = await artifact.uploadArtifact(
`changeset-pack-${Date.now()}`,
await getFiles(outDir),
outDir,
{
retentionDays: 30,
},
);
if (packDirArtifact.id === undefined) {
throw new Error("Packed artifact upload did not return an artifact id");
}
core.setOutput("pack-dir-artifact-id", String(packDirArtifact.id));
}
async function pack(
cwd: string,
args: {
outDir: string;
publishPlanPath?: string;
},
) {
const cliArgs = ["pack", "--out-dir", args.outDir];
if (args.publishPlanPath) {
cliArgs.push("--from-publish-plan", args.publishPlanPath);
}
await execChangesetsCli(cliArgs, {
cwd,
env: process.env,
});
}
async function downloadPublishPlanArtifact(tmpDir: string, artifactId: number) {
const downloadPath = await downloadArtifact(
tmpDir,
artifactId,
"changeset-publish-plan",
);
return path.join(downloadPath, "publish-plan.json");
}
async function getFiles(dir: string): Promise<string[]> {
const entries = await fs.readdir(dir, { withFileTypes: true });
const files = await Promise.all(
entries.map(async (entry) => {
const entryPath = path.join(dir, entry.name);
if (entry.isDirectory()) {
return getFiles(entryPath);
}
return [entryPath];
}),
);
return files.flat();
}
+4 -3
View File
@@ -1,5 +1,6 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
import { getOptionalInput, getRequiredInput } from "../utils.ts";
type Octokit = ReturnType<typeof github.getOctokit>;
type CreateCommentParams = NonNullable<
@@ -23,9 +24,9 @@ async function main() {
);
}
const githubToken = core.getInput("github-token", { required: true });
const body = core.getInput("body", { required: true });
const updateId = core.getInput("update-id");
const githubToken = getRequiredInput("github-token");
const body = getRequiredInput("body");
const updateId = getOptionalInput("update-id");
const commentMarker = updateId ? getCommentMarker(updateId) : null;
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
+1 -1
View File
@@ -1,5 +1,5 @@
import * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import { getReleasePlan } from "@changesets/get-release-plan";
import type {
ComprehensiveRelease,
ReleasePlan,
+2 -1
View File
@@ -1,6 +1,6 @@
import { pathToFileURL } from "node:url";
import type * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import { getReleasePlan } from "@changesets/get-release-plan";
import { createFixture } from "fs-fixture";
import { exec } from "tinyexec";
import { describe, expect, it } from "vitest";
@@ -28,6 +28,7 @@ describe("getPullRequestWorktree", () => {
private: true,
workspaces: ["packages/*"],
}),
"package-lock.json": "",
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
+94
View File
@@ -0,0 +1,94 @@
import fs from "node:fs/promises";
import os from "node:os";
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runPublish } from "../run.ts";
import { uploadStagedRelease } from "../staged-release.ts";
import {
downloadArtifact,
getOptionalBooleanInput,
getOptionalInput,
getRequiredInput,
validateChangesetsCliVersion,
} from "../utils.ts";
import { assertValidStageInput } from "./options.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
await validateChangesetsCliVersion(cwd);
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const stage = getOptionalBooleanInput("stage");
const packDirArtifactId = getOptionalInput("pack-dir-artifact-id");
const createGithubReleases = core.getBooleanInput("create-github-releases");
const pushGitTags = core.getBooleanInput("push-git-tags");
assertValidStageInput(stage, script);
if (createGithubReleases && !pushGitTags) {
throw new Error(
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " +
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " +
"or set 'create-github-releases' to false.",
);
}
// NOTE: Always use API mode here as publish does not need a commit-mode.
const github = new GitHub({ cwd, githubToken, commitMode: "github-api" });
const fromPackDir = packDirArtifactId
? await downloadArtifact(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
Number(packDirArtifactId),
"changeset-pack",
)
: undefined;
const result = await runPublish({
script,
stage,
github,
createGithubReleases,
pushGitTags,
cwd,
fromPackDir,
});
if (result.stagedPackages?.length) {
const artifactId = await uploadStagedRelease(
result.stagedPackages,
result.exitCode === 0 ? "approve" : "reject",
);
core.setOutput("staged-release-artifact-id", String(artifactId));
}
if (result.published) {
core.setOutput("published", "true");
core.setOutput(
"published-packages",
JSON.stringify(result.publishedPackages),
);
} else {
core.setOutput("published", "false");
}
if (result.exitCode !== 0) {
throw new Error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
}
}
+16
View File
@@ -0,0 +1,16 @@
import { describe, expect, it } from "vitest";
import { assertValidStageInput } from "./options.ts";
describe("publish stage input", () => {
it("rejects an explicit stage override with a custom script", () => {
expect(() => assertValidStageInput(false, "pnpm release")).toThrow(
"cannot be combined with a custom 'script'",
);
});
it("allows an omitted stage input with a custom script", () => {
expect(() =>
assertValidStageInput(undefined, "pnpm release"),
).not.toThrow();
});
});
+10
View File
@@ -0,0 +1,10 @@
export function assertValidStageInput(
stage: boolean | undefined,
script: string | undefined,
) {
if (stage !== undefined && script) {
throw new Error(
"The 'stage' input cannot be combined with a custom 'script'. Configure staged publishing inside the script instead.",
);
}
}
+1 -1
View File
@@ -1,5 +1,5 @@
import { readPreState } from "@changesets/pre";
import readChangesets from "@changesets/read";
import { readChangesets } from "@changesets/read";
import type { PreState, NewChangeset } from "@changesets/types";
export type ChangesetState = {
+174 -31
View File
@@ -1,11 +1,11 @@
import path from "node:path";
import * as core from "@actions/core";
import type { Changeset } from "@changesets/types";
import writeChangeset from "@changesets/write";
import { writeChangeset } from "@changesets/write";
import { createFixture } from "fs-fixture";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import { runVersion } from "./run.ts";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { GitHub } from "./github.ts";
import { readChangesetsOutput, runPublish, runVersion } from "./run.ts";
vi.mock("@actions/github", () => ({
context: {
@@ -21,8 +21,9 @@ vi.mock("@actions/github", () => ({
graphql: mockedGraphql,
}),
}));
vi.mock("./git.ts");
vi.mock("@changesets/ghcommit/git");
vi.mock("@actions/core", { spy: true });
const mockedWarning = vi.mocked(core.warning);
vi.mock("@changesets/ghcommit");
let mockedGithubMethods = {
pulls: {
@@ -58,6 +59,7 @@ function createSimpleProjectFixture() {
private: true,
workspaces: ["packages/*"],
}),
"package-lock.json": "",
});
}
@@ -84,6 +86,7 @@ function createIgnoredPackageFixture() {
private: true,
workspaces: ["packages/*"],
}),
"package-lock.json": "",
});
}
@@ -91,10 +94,166 @@ const writeChangesets = (changesets: Changeset[], cwd: string) => {
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
};
const createGithub = (cwd: string) =>
new GitHub({
cwd,
githubToken: "@@GITHUB_TOKEN",
commitMode: "github-api",
});
beforeEach(() => {
vi.clearAllMocks();
});
afterEach(() => {
vi.unstubAllEnvs();
});
describe("publish", () => {
it("parses staged publish events in emitted order", async () => {
await using fixture = await createFixture({
"changesets-output.ndjson": [
JSON.stringify({
type: "npm-stage",
packageName: "pkg-b",
version: "1.0.0",
tag: "latest",
gitTag: "pkg-b@1.0.0",
stageId: "stage-b",
}),
JSON.stringify({ type: "unknown" }),
JSON.stringify({
type: "npm-stage",
packageName: "pkg-a",
version: "1.0.0",
tag: "latest",
gitTag: "pkg-a@1.0.0",
stageId: "stage-a",
}),
].join("\n"),
});
await expect(
readChangesetsOutput(path.join(fixture.path, "changesets-output.ndjson")),
).resolves.toMatchObject([
{ type: "npm-stage", stageId: "stage-b" },
{ type: "npm-stage", stageId: "stage-a" },
]);
});
it("returns staged packages from a custom publish script", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
vi.stubEnv("RUNNER_TEMP", cwd);
await fixture.writeFile(
"write-output.cjs",
`require("node:fs").writeFileSync(process.env.CHANGESETS_OUTPUT, JSON.stringify({
type: "npm-stage",
packageName: "changesets-dev-simple-project-pkg-b",
version: "1.0.0",
tag: "latest",
gitTag: "changesets-dev-simple-project-pkg-b@1.0.0",
stageId: "stage-b"
}) + "\\n")`,
);
const result = await runPublish({
script: "node write-output.cjs",
github: createGithub(cwd),
createGithubReleases: false,
pushGitTags: false,
cwd,
});
expect(result).toMatchObject({
published: false,
exitCode: 0,
stagedPackages: [{ type: "npm-stage", stageId: "stage-b" }],
});
expect(mockedGithubMethods.repos.createRelease).not.toHaveBeenCalled();
});
it("passes an explicit stage override to the built-in CLI", async () => {
await using fixture = await createFixture({
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
type: "module",
}),
"node_modules/@changesets/cli/bin.js": `
import fs from "node:fs";
fs.writeFileSync("args.json", JSON.stringify(process.argv.slice(2)));
fs.writeFileSync(process.env.CHANGESETS_OUTPUT, "");
`,
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
}),
"package-lock.json": "",
});
const cwd = fixture.path;
vi.stubEnv("RUNNER_TEMP", cwd);
await runPublish({
stage: false,
github: createGithub(cwd),
createGithubReleases: false,
pushGitTags: false,
cwd,
});
await expect(
fixture.readFile("args.json", "utf8").then(JSON.parse),
).resolves.toEqual(["publish", "--no-stage"]);
});
it("warns when a custom publish script does not create the output file", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
vi.stubEnv("RUNNER_TEMP", cwd);
const result = await runPublish({
script: 'node -e "void 0"',
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
});
expect(result).toEqual({ published: false, exitCode: 0 });
expect(mockedWarning).toHaveBeenCalledWith(
expect.stringContaining(
"GitHub releases and git tags cannot be created without this output",
),
);
});
it("throws when the built-in publish command does not create the output file", async () => {
await using fixture = await createFixture({
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
type: "module",
}),
"node_modules/@changesets/cli/bin.js": "",
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
}),
"package-lock.json": "",
});
const cwd = fixture.path;
vi.stubEnv("RUNNER_TEMP", cwd);
await expect(
runPublish({
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
}),
).rejects.toThrow("Failed to read changesets output at");
});
});
describe("version", () => {
it("creates simple PR", async () => {
await using fixture = await createSimpleProjectFixture();
@@ -126,9 +285,7 @@ describe("version", () => {
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
});
@@ -161,9 +318,7 @@ describe("version", () => {
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
prDraft: "create",
});
@@ -197,9 +352,7 @@ describe("version", () => {
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
});
@@ -232,9 +385,7 @@ describe("version", () => {
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
});
@@ -287,9 +438,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
prBodyMaxCharacters: 1000,
});
@@ -346,9 +495,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
prBodyMaxCharacters: 500,
});
@@ -383,9 +530,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
prDraft: "create",
});
@@ -417,9 +562,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
github: createGithub(cwd),
cwd,
prDraft: "always",
});
+227 -125
View File
@@ -1,32 +1,37 @@
import { randomUUID } from "node:crypto";
import fs from "node:fs/promises";
import { createRequire } from "node:module";
import os from "node:os";
import path from "node:path";
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github";
import {
exec,
getExecOutput,
type ExecOptions,
type ExecOutput,
} from "@actions/exec";
import { context } from "@actions/github";
import type { PreState } from "@changesets/types";
import { type Package, getPackages } from "@manypkg/get-packages";
import semverLt from "semver/functions/lt.js";
import { Git } from "./git.ts";
import type { GitHub } from "./github.ts";
import type { Octokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts";
import {
execChangesetsCli,
getChangedPackages,
getChangelogEntry,
getExecOutputChangesetsCli,
getVersionsByDirectory,
isErrorWithCode,
sortTheThings,
} from "./utils.ts";
const require = createRequire(import.meta.url);
// GitHub Issues/PRs messages have a max size limit on the
// message body payload.
// `body is too long (maximum is 65536 characters)`.
// To avoid that, we ensure to cap the message to 60k chars.
const MAX_CHARACTERS_PER_MESSAGE = 60000;
const createRelease = async (
export const createRelease = async (
octokit: Octokit,
{ pkg, tagName }: { pkg: Package; tagName: string },
) => {
@@ -54,135 +59,255 @@ const createRelease = async (
tag_name: tagName,
body: changelogEntry.content,
prerelease: pkg.packageJson.version.includes("-"),
...github.context.repo,
...context.repo,
});
};
type PublishOptions = {
script: string;
githubToken: string;
octokit: Octokit;
script?: string;
fromPackDir?: string;
stage?: boolean;
createGithubReleases: boolean;
git: Git;
pushGitTags: boolean;
github: GitHub;
cwd: string;
};
type PublishedPackage = { name: string; version: string };
export type ChangesetsOutputEvent =
| {
type: "git-tag";
tag: string;
packageName: string;
}
| {
type: "npm-stage";
packageName: string;
version: string;
tag: string;
gitTag: string;
stageId: string;
};
export type NpmStageEvent = Extract<
ChangesetsOutputEvent,
{ type: "npm-stage" }
>;
class ChangesetsOutputReadError extends Error {}
type PublishResult =
| {
published: true;
publishedPackages: PublishedPackage[];
stagedPackages?: NpmStageEvent[];
exitCode: number;
}
| {
published: false;
stagedPackages?: NpmStageEvent[];
exitCode: number;
};
function isObject(value: unknown) {
return typeof value === "object" && value !== null;
}
function isChangesetsOutputEvent(
value: unknown,
): value is ChangesetsOutputEvent {
if (!isObject(value) || !("type" in value)) return false;
if (
value.type === "git-tag" &&
"tag" in value &&
typeof value.tag === "string" &&
"packageName" in value &&
typeof value.packageName === "string"
) {
return true;
}
return (
value.type === "npm-stage" &&
"packageName" in value &&
typeof value.packageName === "string" &&
"version" in value &&
typeof value.version === "string" &&
"tag" in value &&
typeof value.tag === "string" &&
"gitTag" in value &&
typeof value.gitTag === "string" &&
"stageId" in value &&
typeof value.stageId === "string"
);
}
export async function readChangesetsOutput(outputPath: string) {
let rawOutput: string;
try {
rawOutput = await fs.readFile(outputPath, "utf8");
} catch (err) {
throw new ChangesetsOutputReadError(
`Failed to read changesets output at ${outputPath}`,
{ cause: err },
);
}
const events: ChangesetsOutputEvent[] = [];
let lineStart = 0;
while (lineStart <= rawOutput.length) {
let lineEnd = rawOutput.indexOf("\n", lineStart);
if (lineEnd === -1) {
lineEnd = rawOutput.length;
}
const line = rawOutput.slice(lineStart, lineEnd);
lineStart = lineEnd + 1;
if (/^\s*$/.test(line)) {
continue;
}
let event: unknown;
try {
event = JSON.parse(line);
} catch (err) {
throw new Error(`Failed to parse changesets output event: ${line}`, {
cause: err,
});
}
if (!isChangesetsOutputEvent(event)) {
continue;
}
events.push(event);
}
return events;
}
export async function runPublish({
script,
githubToken,
git,
octokit,
fromPackDir,
stage,
github,
createGithubReleases,
pushGitTags,
cwd,
}: PublishOptions): Promise<PublishResult> {
let changesetPublishOutput = await getExecOutput(script, undefined, {
const { octokit } = github;
let changesetPublishOutput: ExecOutput;
const outputFile = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
`changesets-output-${randomUUID()}.ndjson`,
);
const execOptions: ExecOptions = {
cwd,
ignoreReturnCode: true,
env: { ...process.env, GITHUB_TOKEN: githubToken },
});
env: {
...process.env,
GITHUB_TOKEN: github.getToken(),
CHANGESETS_OUTPUT: outputFile,
},
};
let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = [];
if (script) {
changesetPublishOutput = await getExecOutput(
script,
undefined,
execOptions,
);
} else {
const args = ["publish"];
if (stage !== undefined) {
args.push(stage ? "--stage" : "--no-stage");
}
if (fromPackDir) {
args.push("--from-pack-dir", fromPackDir);
}
changesetPublishOutput = await getExecOutputChangesetsCli(
args,
execOptions,
);
}
if (tool !== "root") {
let newTagRegex = /New tag:\s+(@[^/]+\/[^@]+|[^/]+)@([^\s]+)/;
let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x]));
for (let line of changesetPublishOutput.stdout.split("\n")) {
let match = line.match(newTagRegex);
if (match === null) {
continue;
}
let pkgName = match[1];
let pkg = packagesByName.get(pkgName);
let { packages, rootPackage, tool } = await getPackages(cwd);
let packagesByName = new Map(
[...packages, ...(rootPackage ? [rootPackage] : [])].map((x) => [
x.packageJson.name,
x,
]),
);
let output: ChangesetsOutputEvent[];
try {
output = await readChangesetsOutput(outputFile);
} catch (err) {
if (!script || !(err instanceof ChangesetsOutputReadError)) {
throw err;
}
core.warning(
`${err.message}. GitHub releases and git tags cannot be created without this output. Ensure the custom publish script passes CHANGESETS_OUTPUT to the Changesets CLI.`,
);
output = [];
}
const stagedPackages = output.filter(
(event): event is NpmStageEvent => event.type === "npm-stage",
);
let releases = output
.filter(
(event): event is Extract<ChangesetsOutputEvent, { type: "git-tag" }> =>
event.type === "git-tag",
)
.map((event) => {
let pkg = packagesByName.get(event.packageName);
if (pkg === undefined) {
throw new Error(
`Package "${pkgName}" not found.` +
`Package "${event.packageName}" not found.` +
"This is probably a bug in the action, please open an issue",
);
}
releasedPackages.push(pkg);
}
return { pkg, tag: event.tag };
});
if (createGithubReleases) {
await Promise.all(
releasedPackages.map(async (pkg) => {
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName });
}),
);
}
} else {
if (packages.length === 0) {
throw new Error(
`No package found.` +
"This is probably a bug in the action, please open an issue",
);
}
let pkg = packages[0];
let newTagRegex = /New tag:/;
for (let line of changesetPublishOutput.stdout.split("\n")) {
let match = line.match(newTagRegex);
if (match) {
releasedPackages.push(pkg);
if (createGithubReleases) {
const tagName = `v${pkg.packageJson.version}`;
await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName });
}
break;
}
}
if (tool.type === "root" && packages.length === 0) {
throw new Error(
`No package found.` +
"This is probably a bug in the action, please open an issue",
);
}
if (releasedPackages.length) {
if (createGithubReleases || pushGitTags) {
await Promise.all(
releases.map(async ({ pkg, tag }) => {
if (pushGitTags) {
await github.pushTag(tag);
}
if (createGithubReleases) {
await createRelease(octokit, { pkg, tagName: tag });
}
}),
);
}
if (releases.length) {
return {
published: true,
publishedPackages: releasedPackages.map((pkg) => ({
publishedPackages: releases.map(({ pkg }) => ({
name: pkg.packageJson.name,
version: pkg.packageJson.version,
})),
...(stagedPackages.length > 0 ? { stagedPackages } : {}),
exitCode: changesetPublishOutput.exitCode,
};
}
return { published: false, exitCode: changesetPublishOutput.exitCode };
return {
published: false,
...(stagedPackages.length > 0 ? { stagedPackages } : {}),
exitCode: changesetPublishOutput.exitCode,
};
}
const requireChangesetsCliPkgJson = (cwd: string) => {
try {
return require(
require.resolve("@changesets/cli/package.json", {
paths: [cwd],
}),
);
} catch (err) {
if (isErrorWithCode(err, "MODULE_NOT_FOUND")) {
throw new Error(
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`,
{ cause: err },
);
}
throw err;
}
};
type GetMessageOptions = {
hasPublishScript: boolean;
branch: string;
@@ -254,9 +379,7 @@ export async function getVersionPrBody({
type VersionOptions = {
script?: string;
githubToken: string;
git: Git;
octokit: Octokit;
github: GitHub;
cwd?: string;
prTitle?: string;
commitMessage?: string;
@@ -272,47 +395,30 @@ type RunVersionResult = {
export async function runVersion({
script,
githubToken,
git,
octokit,
github,
cwd = process.cwd(),
prTitle = "Version Packages",
commitMessage = "Version Packages",
hasPublishScript = false,
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
branch = github.context.ref.replace("refs/heads/", ""),
branch = context.ref.replace("refs/heads/", ""),
prDraft,
}: VersionOptions): Promise<RunVersionResult> {
const { octokit } = github;
let versionBranch = `changeset-release/${branch}`;
let { preState } = await readChangesetState(cwd);
await git.prepareBranch(versionBranch);
await github.prepareBranch(versionBranch);
let versionsByDirectory = await getVersionsByDirectory(cwd);
const env = { ...process.env, GITHUB_TOKEN: githubToken };
const env = { ...process.env, GITHUB_TOKEN: github.getToken() };
if (script) {
await exec(script, undefined, { cwd, env });
} else {
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0")
? "bump"
: "version";
await exec(
"node",
[
require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
}),
cmd,
],
{
cwd,
env,
},
);
await execChangesetsCli(["version"], { cwd, env });
}
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
@@ -338,17 +444,10 @@ export async function runVersion({
!!preState ? ` (${preState.tag})` : ""
}`;
/**
* Fetch any existing pull requests that are open against the branch,
* before we push any changes that may inadvertently close the existing PRs.
*
* (`@changesets/ghcommit` has to reset the branch to the same commit as the base,
* which GitHub will then react to by closing the PRs)
*/
const existingPullRequests = await octokit.rest.pulls.list({
...github.context.repo,
...context.repo,
state: "open",
head: `${github.context.repo.owner}:${versionBranch}`,
head: `${context.repo.owner}:${versionBranch}`,
base: branch,
});
core.info(
@@ -359,7 +458,10 @@ export async function runVersion({
)}`,
);
await git.pushChanges({ branch: versionBranch, message: finalCommitMessage });
await github.pushChanges({
branch: versionBranch,
message: finalCommitMessage,
});
const changedPackagesInfo = (await changedPackagesInfoPromises)
.filter((x) => x)
@@ -381,7 +483,7 @@ export async function runVersion({
title: finalPrTitle,
body: prBody,
draft: prDraft !== undefined,
...github.context.repo,
...context.repo,
});
return {
+121
View File
@@ -0,0 +1,121 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import readChangesetState from "../readChangesetState.ts";
import { execChangesetsCli, validateChangesetsCliVersion } from "../utils.ts";
type ModeResult =
| {
mode: "none";
}
| {
mode: "version";
}
| {
mode: "publish";
publishPlanPath: string;
};
type PublishPlan = unknown[];
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = process.cwd();
await validateChangesetsCliVersion(cwd);
const result = await getMode(cwd);
core.setOutput("mode", result.mode);
if (result.mode === "publish") {
const publishPlanArtifact = await artifact.uploadArtifact(
path.basename(result.publishPlanPath, ".json"),
[result.publishPlanPath],
path.dirname(result.publishPlanPath),
{
skipArchive: true,
retentionDays: 30,
},
);
if (publishPlanArtifact.id === undefined) {
throw new Error(
"Publish plan artifact upload did not return an artifact id",
);
}
core.setOutput("publish-plan-artifact-id", String(publishPlanArtifact.id));
}
}
async function getMode(cwd: string): Promise<ModeResult> {
const { changesets } = await readChangesetState(cwd);
if (changesets.length > 0) {
const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0,
);
if (hasNonEmptyChangesets) {
return { mode: "version" };
}
return { mode: "none" };
}
const publishPlanPath = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
`changeset-publish-plan-${Date.now()}`,
// we need a stable filename here (in a unique dirname) so the artifact download can find this cleanly
"publish-plan.json",
);
await execChangesetsCli(["publish-plan", "--output", publishPlanPath], {
cwd,
env: process.env,
});
const publishPlan = await readPublishPlan(publishPlanPath);
if (publishPlan.length === 0) {
return { mode: "none" };
}
return {
mode: "publish",
publishPlanPath,
};
}
async function readPublishPlan(publishPlanPath: string): Promise<PublishPlan> {
let rawPlan: string;
try {
rawPlan = await fs.readFile(publishPlanPath, "utf8");
} catch (err) {
throw new Error(`Failed to read publish plan at ${publishPlanPath}`, {
cause: err,
});
}
let plan: unknown;
try {
plan = JSON.parse(rawPlan);
} catch (err) {
throw new Error(`Failed to parse publish plan at ${publishPlanPath}`, {
cause: err,
});
}
if (
typeof plan !== "object" ||
plan === null ||
!("version" in plan) ||
typeof plan.version !== "number" ||
!("plan" in plan) ||
!Array.isArray(plan.plan)
) {
throw new Error(
`Invalid publish plan at ${publishPlanPath}: expected { version: number; plan: unknown[] }`,
);
}
return plan.plan;
}
+218
View File
@@ -0,0 +1,218 @@
import * as path from "node:path";
import { getExecOutput } from "@actions/exec";
import type { Package } from "@manypkg/get-packages";
import { createFixture } from "fs-fixture";
import { describe, expect, it, vi } from "vitest";
import type { GitHub } from "./github.ts";
import {
createStagedReleaseHandoff,
finalizeStagedRelease,
formatStageCommand,
validateStagedReleaseHandoff,
verifyPublished,
type StagedReleaseEntry,
} from "./staged-release.ts";
vi.mock("@actions/github", () => ({
context: {
repo: { owner: "changesets", repo: "action" },
runId: 123,
sha: "abc123",
},
}));
vi.mock("@actions/exec", async (importOriginal) => ({
...(await importOriginal<typeof import("@actions/exec")>()),
getExecOutput: vi.fn(),
}));
const entry: StagedReleaseEntry = {
packageName: "pkg-a",
version: "1.0.0",
tag: "latest",
gitTag: "pkg-a@1.0.0",
stageId: "1de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f",
};
async function createProject() {
return createFixture({
"package.json": JSON.stringify({
name: "repo",
private: true,
workspaces: ["packages/*"],
}),
"package-lock.json": "",
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "pkg-b",
version: "1.0.0",
}),
});
}
describe("staged release handoff", () => {
it("prints stage ids in their topological event order", () => {
expect(
formatStageCommand(
[
{ type: "npm-stage", ...entry, stageId: "stage-b" },
{ type: "npm-stage", ...entry, stageId: "stage-a" },
],
"approve",
),
).toBe("changeset stage approve stage-b stage-a");
});
it("prints rejection recovery for a partial publish failure", () => {
expect(
formatStageCommand(
[{ type: "npm-stage", ...entry, stageId: "stage-a" }],
"reject",
),
).toBe("changeset stage reject stage-a");
});
it("validates origin, manifests, tags, and preserves order", async () => {
await using fixture = await createProject();
const handoff = createStagedReleaseHandoff(
[
{ type: "npm-stage", ...entry },
{
type: "npm-stage",
...entry,
packageName: "pkg-b",
gitTag: "pkg-b@1.0.0",
stageId: "2de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f",
},
],
{ repository: "changesets/action", runId: 123, sha: "abc123" },
);
const result = await validateStagedReleaseHandoff(handoff, fixture.path, {
repository: "changesets/action",
runId: 123,
sha: "abc123",
});
expect(result.handoff.releases.map((release) => release.stageId)).toEqual([
"1de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f",
"2de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f",
]);
});
it("rejects a handoff from another workflow run", async () => {
await using fixture = await createProject();
const handoff = createStagedReleaseHandoff(
[{ type: "npm-stage", ...entry }],
{ repository: "changesets/action", runId: 122, sha: "abc123" },
);
await expect(
validateStagedReleaseHandoff(handoff, fixture.path, {
repository: "changesets/action",
runId: 123,
sha: "abc123",
}),
).rejects.toThrow("do not match this workflow run");
});
it("verifies an exact version through the configured package manager", async () => {
await using fixture = await createProject();
vi.mocked(getExecOutput).mockResolvedValue({
exitCode: 0,
stdout: JSON.stringify("1.0.0"),
stderr: "",
} as never);
await verifyPublished([entry], fixture.path, { timeoutMs: 0 });
expect(getExecOutput).toHaveBeenCalledWith(
"npm",
["view", "pkg-a@1.0.0", "version", "--json"],
expect.objectContaining({ cwd: fixture.path }),
);
});
it("accepts existing correct tags and releases without writes", async () => {
const getRef = vi.fn().mockResolvedValue({
data: { object: { sha: "abc123" } },
});
const createRef = vi.fn();
const getReleaseByTag = vi.fn().mockResolvedValue({ data: { id: 1 } });
const createRelease = vi.fn();
const github = {
octokit: {
rest: {
git: { getRef, createRef },
repos: { getReleaseByTag, createRelease },
},
},
} as unknown as GitHub;
const pkg = {
dir: path.join("/repo", "packages/pkg-a"),
relativeDir: "packages/pkg-a",
packageJson: { name: "pkg-a", version: "1.0.0" },
} satisfies Package;
await finalizeStagedRelease({
github,
handoff: {
version: 1,
repository: "changesets/action",
runId: 123,
sha: "abc123",
releases: [entry],
},
packagesByName: new Map([["pkg-a", pkg]]),
cwd: "/repo",
verify: false,
});
expect(createRef).not.toHaveBeenCalled();
expect(createRelease).not.toHaveBeenCalled();
});
it("rejects an existing tag at another commit", async () => {
const github = {
octokit: {
rest: {
git: {
getRef: vi.fn().mockResolvedValue({
data: { object: { sha: "wrong" } },
}),
createRef: vi.fn(),
},
repos: {
getReleaseByTag: vi.fn(),
createRelease: vi.fn(),
},
},
},
} as unknown as GitHub;
await expect(
finalizeStagedRelease({
github,
handoff: {
version: 1,
repository: "changesets/action",
runId: 123,
sha: "abc123",
releases: [entry],
},
packagesByName: new Map([
[
"pkg-a",
{
dir: "/repo/pkg-a",
relativeDir: "pkg-a",
packageJson: { name: "pkg-a", version: "1.0.0" },
} satisfies Package,
],
]),
cwd: "/repo",
verify: false,
}),
).rejects.toThrow("expected abc123");
});
});
+342
View File
@@ -0,0 +1,342 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import { getExecOutput } from "@actions/exec";
import { context } from "@actions/github";
import { getPackages, type Package } from "@manypkg/get-packages";
import type { GitHub } from "./github.ts";
import { createRelease, type NpmStageEvent } from "./run.ts";
import { downloadArtifact } from "./utils.ts";
export const STAGED_RELEASE_VERSION = 1;
export const STAGED_RELEASE_FILENAME = "staged-release.json";
const STAGE_ID_PATTERN =
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
export type StagedReleaseEntry = Omit<NpmStageEvent, "type">;
export type StagedReleaseHandoff = {
version: typeof STAGED_RELEASE_VERSION;
repository: string;
runId: number;
sha: string;
releases: StagedReleaseEntry[];
};
type HandoffIdentity = {
repository: string;
runId: number;
sha: string;
};
function currentIdentity(): HandoffIdentity {
return {
repository: `${context.repo.owner}/${context.repo.repo}`,
runId: context.runId,
sha: context.sha,
};
}
function isObject(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null;
}
function isHttpNotFound(error: unknown) {
return (
isObject(error) &&
(error.status === 404 || error.code === 404 || error.code === "404")
);
}
function isStagedReleaseEntry(value: unknown): value is StagedReleaseEntry {
return (
isObject(value) &&
typeof value.packageName === "string" &&
value.packageName.length > 0 &&
typeof value.version === "string" &&
value.version.length > 0 &&
typeof value.tag === "string" &&
value.tag.length > 0 &&
typeof value.gitTag === "string" &&
value.gitTag.length > 0 &&
typeof value.stageId === "string" &&
STAGE_ID_PATTERN.test(value.stageId)
);
}
export function createStagedReleaseHandoff(
events: readonly NpmStageEvent[],
identity: HandoffIdentity = currentIdentity(),
): StagedReleaseHandoff {
return {
version: STAGED_RELEASE_VERSION,
...identity,
releases: events.map(({ type: _, ...event }) => event),
};
}
export function formatStageCommand(
events: readonly NpmStageEvent[],
operation: "approve" | "reject",
) {
return `changeset stage ${operation} ${events
.map((event) => event.stageId)
.join(" ")}`;
}
export async function uploadStagedRelease(
events: readonly NpmStageEvent[],
operation: "approve" | "reject",
): Promise<number> {
const verb = operation === "approve" ? "Approve" : "Reject";
core.info(`${verb} the staged packages in this order:
${formatStageCommand(events, operation)}`);
core.info(
"This command uses the default registry. For custom or multiple registries, split the IDs and pass --registry to each command.",
);
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
const outDir = path.join(tmpDir, `changeset-staged-release-${Date.now()}`);
const handoffPath = path.join(outDir, STAGED_RELEASE_FILENAME);
await fs.mkdir(outDir, { recursive: true });
await fs.writeFile(
handoffPath,
`${JSON.stringify(createStagedReleaseHandoff(events), null, 2)}\n`,
);
const result = await artifact.uploadArtifact(
`changeset-staged-release-${context.runId}-${Date.now()}`,
[handoffPath],
outDir,
{ skipArchive: true, retentionDays: 30 },
);
if (result.id === undefined) {
throw new Error("Staged release artifact upload did not return an id");
}
return result.id;
}
function expectedGitTag(
tool: Awaited<ReturnType<typeof getPackages>>["tool"],
entry: StagedReleaseEntry,
) {
return tool.type === "root"
? `v${entry.version}`
: `${entry.packageName}@${entry.version}`;
}
export async function validateStagedReleaseHandoff(
value: unknown,
cwd: string,
identity: HandoffIdentity = currentIdentity(),
): Promise<{
handoff: StagedReleaseHandoff;
packagesByName: Map<string, Package>;
}> {
if (
!isObject(value) ||
value.version !== STAGED_RELEASE_VERSION ||
value.repository !== identity.repository ||
value.runId !== identity.runId ||
value.sha !== identity.sha ||
!Array.isArray(value.releases) ||
value.releases.length === 0 ||
!value.releases.every(isStagedReleaseEntry)
) {
throw new Error(
"Invalid staged release artifact: version, origin, or release entries do not match this workflow run",
);
}
const handoff = value as StagedReleaseHandoff;
const uniqueFields: Array<keyof StagedReleaseEntry> = [
"packageName",
"gitTag",
"stageId",
];
for (const field of uniqueFields) {
const values = handoff.releases.map((entry) => entry[field]);
if (new Set(values).size !== values.length) {
throw new Error(
`Invalid staged release artifact: duplicate ${field} value`,
);
}
}
const { packages, rootPackage, tool } = await getPackages(cwd);
const packagesByName = new Map(
[...packages, ...(rootPackage ? [rootPackage] : [])].map((pkg) => [
pkg.packageJson.name,
pkg,
]),
);
for (const entry of handoff.releases) {
const pkg = packagesByName.get(entry.packageName);
if (!pkg || pkg.packageJson.version !== entry.version) {
throw new Error(
`Invalid staged release artifact: ${entry.packageName}@${entry.version} does not match the checked-out manifest`,
);
}
if (entry.gitTag !== expectedGitTag(tool, entry)) {
throw new Error(
`Invalid staged release artifact: unexpected Git tag ${entry.gitTag}`,
);
}
}
return { handoff, packagesByName };
}
export async function downloadAndValidateStagedRelease(
artifactId: number,
cwd: string,
) {
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
const artifactDir = await downloadArtifact(
tmpDir,
artifactId,
"changeset-staged-release",
);
const handoffPath = path.join(artifactDir, STAGED_RELEASE_FILENAME);
let value: unknown;
try {
value = JSON.parse(await fs.readFile(handoffPath, "utf8"));
} catch (error) {
throw new Error(`Failed to read staged release artifact ${artifactId}`, {
cause: error,
});
}
return validateStagedReleaseHandoff(value, cwd);
}
function outputContainsVersion(output: string, version: string) {
const values: unknown[] = [];
for (const line of output.split("\n")) {
if (!line.trim()) continue;
try {
values.push(JSON.parse(line));
} catch {
continue;
}
}
const contains = (value: unknown): boolean => {
if (value === version) return true;
if (Array.isArray(value)) return value.some(contains);
if (isObject(value)) return Object.values(value).some(contains);
return false;
};
return values.some(contains);
}
async function isPublished(
cwd: string,
tool: Awaited<ReturnType<typeof getPackages>>["tool"],
entry: StagedReleaseEntry,
) {
const spec = `${entry.packageName}@${entry.version}`;
const command =
tool.type === "pnpm" ? "pnpm" : tool.type === "yarn" ? "yarn" : "npm";
const args =
tool.type === "yarn"
? ["npm", "info", spec, "--fields", "version", "--json"]
: ["view", spec, "version", "--json"];
const result = await getExecOutput(command, args, {
cwd,
ignoreReturnCode: true,
silent: true,
env: process.env as Record<string, string>,
});
return (
result.exitCode === 0 && outputContainsVersion(result.stdout, entry.version)
);
}
export async function verifyPublished(
releases: readonly StagedReleaseEntry[],
cwd: string,
options: { timeoutMs?: number; intervalMs?: number } = {},
) {
const timeoutMs = options.timeoutMs ?? 120_000;
const intervalMs = options.intervalMs ?? 5_000;
const deadline = Date.now() + timeoutMs;
const { tool } = await getPackages(cwd);
while (true) {
const results = await Promise.all(
releases.map((release) => isPublished(cwd, tool, release)),
);
if (results.every(Boolean)) return;
if (Date.now() >= deadline) {
const missing = releases
.filter((_, index) => !results[index])
.map((release) => `${release.packageName}@${release.version}`);
throw new Error(
`Timed out waiting for approved packages to become visible: ${missing.join(", ")}`,
);
}
await new Promise((resolve) =>
setTimeout(resolve, Math.min(intervalMs, deadline - Date.now())),
);
}
}
async function ensureTag(github: GitHub, tag: string, sha: string) {
try {
const existing = await github.octokit.rest.git.getRef({
...context.repo,
ref: `tags/${tag}`,
});
if (existing.data.object.sha !== sha) {
throw new Error(
`Git tag ${tag} already exists at ${existing.data.object.sha}, expected ${sha}`,
);
}
return;
} catch (error) {
if (!isHttpNotFound(error)) {
throw error;
}
}
await github.octokit.rest.git.createRef({
...context.repo,
ref: `refs/tags/${tag}`,
sha,
});
}
async function ensureRelease(github: GitHub, pkg: Package, tagName: string) {
try {
await github.octokit.rest.repos.getReleaseByTag({
...context.repo,
tag: tagName,
});
return;
} catch (error) {
if (!isHttpNotFound(error)) {
throw error;
}
}
await createRelease(github.octokit, { pkg, tagName });
}
export async function finalizeStagedRelease(options: {
github: GitHub;
handoff: StagedReleaseHandoff;
packagesByName: Map<string, Package>;
cwd: string;
verify: boolean;
}) {
if (options.verify) {
await verifyPublished(options.handoff.releases, options.cwd);
}
for (const entry of options.handoff.releases) {
const pkg = options.packagesByName.get(entry.packageName)!;
await ensureTag(options.github, entry.gitTag, options.handoff.sha);
await ensureRelease(options.github, pkg, entry.gitTag);
}
}
+53 -1
View File
@@ -1,5 +1,11 @@
import { createFixture } from "fs-fixture";
import { expect, test } from "vitest";
import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts";
import {
BumpLevels,
getChangelogEntry,
sortTheThings,
validateChangesetsCliVersion,
} from "./utils.ts";
let changelog = `# @keystone-alpha/email
@@ -100,3 +106,49 @@ test("it sorts the things right", () => {
];
expect(things.sort(sortTheThings)).toMatchSnapshot();
});
test("throws when the project declares Changesets CLI v2", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^2.29.7" },
}),
"package-lock.json": "",
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
test("accepts a Changesets CLI v3 contract without an installed CLI", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
});
await expect(
validateChangesetsCliVersion(fixture.path),
).resolves.toBeUndefined();
});
test("throws when the project has Changesets CLI v2 installed", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
version: "2.29.7",
}),
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
+157
View File
@@ -1,5 +1,19 @@
import fs from "node:fs/promises";
import { createRequire } from "node:module";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import {
exec,
getExecOutput,
type ExecOptions as ActionsExecOptions,
type ExecOutput,
} from "@actions/exec";
import { getPackages, type Package } from "@manypkg/get-packages";
import major from "semver/functions/major.js";
import subset from "semver/ranges/subset.js";
const require = createRequire(import.meta.url);
export const BumpLevels = {
dep: 0,
@@ -111,3 +125,146 @@ export function fileExists(filePath: string) {
() => false,
);
}
export function getOptionalInput(name: string) {
// normalize empty string default return value of `core.getInput` to undefined
return core.getInput(name) || undefined;
}
export function getRequiredInput(name: string) {
// it's just a small utility wrapper, mainly introduced for usage parity with our custom `getOptionalInput`
// note: `core.getBooleanInput` gets used directly as it already normalizes the return value nicely
return core.getInput(name, { required: true });
}
export function getOptionalBooleanInput(name: string) {
const value = getOptionalInput(name);
if (value === undefined) return undefined;
if (value.toLowerCase() === "true") return true;
if (value.toLowerCase() === "false") return false;
throw new Error(
`Invalid boolean input ${JSON.stringify(name)}: ${JSON.stringify(value)}`,
);
}
export function throwOnRenamedInputs(renames: Record<string, string>) {
const references: Record<string, string> = {};
for (const [oldInput, newInput] of Object.entries(renames)) {
if (core.getInput(oldInput)) {
references[oldInput] = newInput;
}
}
if (Object.keys(references).length > 0) {
const list = Object.entries(references)
.map(([oldInput, newInput]) => `- "${oldInput}" -> "${newInput}"`)
.join("\n");
throw new Error(
`The following inputs have been renamed:\n${list}\nPlease update your workflow file.`,
);
}
}
const changesetsCliCompatibilityError =
"This version of the Changesets action is designed to work with Changesets CLI v3. " +
"Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.";
export async function validateChangesetsCliVersion(cwd: string) {
const { rootPackage } = await getPackages(cwd);
const packageJson = rootPackage?.packageJson;
const declaredVersion =
packageJson?.devDependencies?.["@changesets/cli"] ??
packageJson?.dependencies?.["@changesets/cli"];
if (typeof declaredVersion === "string") {
const range = declaredVersion.startsWith("workspace:")
? declaredVersion.slice("workspace:".length)
: declaredVersion;
let isV2 = false;
try {
isV2 = subset(range, ">=2.0.0-0 <3.0.0-0", {
includePrerelease: true,
});
} catch {
// it could be a non-semver protocol
}
if (isV2) {
throw new Error(changesetsCliCompatibilityError);
}
}
let cliPackageJson;
try {
cliPackageJson = require(
require.resolve("@changesets/cli/package.json", { paths: [cwd] }),
);
} catch {
return;
}
if (
typeof cliPackageJson.version === "string" &&
major(cliPackageJson.version) === 2
) {
throw new Error(changesetsCliCompatibilityError);
}
}
function resolveChangesetsCli(cwd: string) {
return require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
});
}
interface ExecOptions extends Omit<ActionsExecOptions, "env"> {
env?: Record<string, string | undefined>;
}
export function execChangesetsCli(args: string[], options?: ExecOptions) {
return exec(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export function getExecOutputChangesetsCli(
args: string[],
options?: ExecOptions,
): Promise<ExecOutput> {
return getExecOutput(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export async function downloadArtifact(
tmpDir: string,
artifactId: number,
name: string,
) {
if (!Number.isInteger(artifactId) || artifactId <= 0) {
throw new Error(
`Invalid ${JSON.stringify(name)} artifact id: ${artifactId}`,
);
}
const downloadPath = path.join(tmpDir, `${name}-${artifactId}-${Date.now()}`);
const result = await artifact.downloadArtifact(artifactId, {
path: downloadPath,
});
if (!result.downloadPath) {
throw new Error(
`${JSON.stringify(name)} artifact download did not return a path for artifact ${artifactId}`,
);
}
return result.downloadPath;
}
+62
View File
@@ -0,0 +1,62 @@
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runVersion } from "../run.ts";
import {
getOptionalInput,
getRequiredInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
await validateChangesetsCliVersion(cwd);
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const commitMessage = getRequiredInput("commit-message");
const prTitle = getRequiredInput("pr-title");
const prDraft = getOptionalInput("pr-draft");
const prBaseBranch = getOptionalInput("pr-base-branch");
const commitMode = getOptionalInput("commit-mode") ?? "git-cli";
const setupGitUser = core.getBooleanInput("setup-git-user");
// Validations
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
throw new Error(`Invalid pr-draft input: ${prDraft}`);
}
if (commitMode !== "git-cli" && commitMode !== "github-api") {
throw new Error(`Invalid commit-mode input: ${commitMode}`);
}
const github = new GitHub({
cwd,
githubToken,
commitMode,
});
if (setupGitUser) {
core.info("setting git user");
await github.setupUser();
}
const { pullRequestNumber } = await runVersion({
script,
github,
cwd,
prTitle,
commitMessage,
// TODO: Use neutral message for PR description
hasPublishScript: true,
prDraft,
branch: prBaseBranch,
});
core.setOutput("pr-number", String(pullRequestNumber));
}
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/version
TODO
+45
View File
@@ -0,0 +1,45 @@
name: Changesets - Version
description: Version packages
runs:
using: node24
main: ../dist/version.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
script:
description: "The command to use to version packages"
required: false
commit-message:
description: "The commit message. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-title:
description: "The pull request title. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-draft:
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
required: false
pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false
commit-mode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
all commits and tags are signed using GitHub's GPG key and attributed to the user
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
setup-git-user:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
required: false
default: true
outputs:
pr-number:
description: The pull request number that was created or updated
branding:
icon: package
color: blue