mirror of
https://github.com/changesets/action
synced 2026-10-26 16:39:56 +08:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Mateusz Burzyński
|
79d401e0bd |
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": minor
|
||||
---
|
||||
|
||||
Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Removed compatibility support for old Changesets v1.
|
||||
@@ -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`
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
|
||||
@@ -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"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Update to Changesets v3 packages
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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
|
||||
@@ -10,11 +10,6 @@ inputs:
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up pnpm
|
||||
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
|
||||
|
||||
|
||||
@@ -27,12 +27,12 @@ jobs:
|
||||
security-events: write # allow writing security events
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Run zizmor
|
||||
uses: zizmorcore/zizmor-action@cc914d7f3750a2d13d75c7f184a1060aa0e9d482 # v0.6.4
|
||||
uses: zizmorcore/zizmor-action@5f14fd08f7cf1cb1609c1e344975f152c7ee938d # v0.5.6
|
||||
with:
|
||||
persona: pedantic
|
||||
annotations: true
|
||||
@@ -43,7 +43,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- uses: ./.github/actions/ci-setup
|
||||
|
||||
- name: Test
|
||||
run: pnpm test
|
||||
@@ -53,7 +58,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- uses: ./.github/actions/ci-setup
|
||||
|
||||
- name: Typecheck
|
||||
run: pnpm typecheck
|
||||
@@ -63,7 +73,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- uses: ./.github/actions/ci-setup
|
||||
|
||||
- name: Format
|
||||
run: pnpm format
|
||||
|
||||
@@ -24,7 +24,12 @@ jobs:
|
||||
permissions:
|
||||
contents: read # to check out repo (actions/checkout)
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- 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
|
||||
|
||||
@@ -33,7 +38,7 @@ jobs:
|
||||
|
||||
- name: Select mode
|
||||
id: select-mode
|
||||
uses: $/select-mode
|
||||
uses: ./select-mode
|
||||
|
||||
version:
|
||||
name: Version
|
||||
@@ -45,14 +50,19 @@ jobs:
|
||||
permissions:
|
||||
contents: read # to check out repo (actions/checkout)
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- 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
|
||||
- uses: ./.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
@@ -62,9 +72,10 @@ jobs:
|
||||
|
||||
- name: Create or update release pull request
|
||||
id: changesets
|
||||
uses: $/version
|
||||
uses: ./version
|
||||
with:
|
||||
github-token: ${{ steps.bot-auth.outputs.token }}
|
||||
setup-git-user: false
|
||||
script: pnpm bump
|
||||
|
||||
publish:
|
||||
@@ -77,14 +88,19 @@ jobs:
|
||||
permissions:
|
||||
contents: write # to create release and have it authored by github-actions (changesets/action)
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- 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
|
||||
- uses: ./.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
@@ -92,7 +108,7 @@ jobs:
|
||||
permission-contents: write # to bypass branch and tag protection rules (release.ts)
|
||||
|
||||
- name: Publish to marketplace
|
||||
uses: $/publish
|
||||
uses: ./publish
|
||||
with:
|
||||
github-token: ${{ steps.bot-auth.outputs.token }}
|
||||
script: pnpm release
|
||||
|
||||
@@ -122,7 +122,12 @@ jobs:
|
||||
pull-requests: write # to comment on the pull request with the release result (changesets/action)
|
||||
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
- 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
|
||||
|
||||
@@ -161,7 +166,7 @@ jobs:
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- uses: $/.github/actions/setup-bot-auth
|
||||
- uses: ./.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
|
||||
@@ -2,6 +2,5 @@ node_modules
|
||||
.parcel-cache
|
||||
.cache
|
||||
*.log
|
||||
.env
|
||||
|
||||
dist/
|
||||
|
||||
-118
@@ -1,123 +1,5 @@
|
||||
# @changesets/action
|
||||
|
||||
## 2.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#735](https://github.com/changesets/action/pull/735) [`8833883`](https://github.com/changesets/action/commit/88338839e35c3e0fa61f3c9c3f27e7572cd5f2cf) Thanks [@bluwy](https://github.com/bluwy)! - Handle error when pushing git tags with the git CLI
|
||||
|
||||
- [#724](https://github.com/changesets/action/pull/724) [`36f529f`](https://github.com/changesets/action/commit/36f529f13ab58bbcf6331035cb950385586e8a89) Thanks [@bluwy](https://github.com/bluwy)! - Improve log messages
|
||||
|
||||
- [#724](https://github.com/changesets/action/pull/724) [`36f529f`](https://github.com/changesets/action/commit/36f529f13ab58bbcf6331035cb950385586e8a89) Thanks [@bluwy](https://github.com/bluwy)! - Fix root action double error logs
|
||||
|
||||
- [#729](https://github.com/changesets/action/pull/729) [`ca85897`](https://github.com/changesets/action/commit/ca8589735af2ff6977a0f6474537d550040530d8) Thanks [@bluwy](https://github.com/bluwy)! - Always switch and reset branch when generating version commits, similar to if `push-with-git-cli` is enabled
|
||||
|
||||
## 2.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#721](https://github.com/changesets/action/pull/721) [`da1ea29`](https://github.com/changesets/action/commit/da1ea291ef93203a08fad360eac36f4858dd0514) Thanks [@KEBABSELLER6](https://github.com/KEBABSELLER6)! - Fixed typo in renamed inputs from v1 to v2
|
||||
|
||||
## 2.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- [#718](https://github.com/changesets/action/pull/718) [`3b7c71c`](https://github.com/changesets/action/commit/3b7c71c440e75fca5d335f779290425fc1117fe8) Thanks [@bluwy](https://github.com/bluwy)! - Add a `cwd` input to the root action, `/select-mode`, `/version`, `/pack`, and `/publish` sub-actions to set the current working directory to execute Changesets in. This input existed in v1 but was incorrectly removed.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#716](https://github.com/changesets/action/pull/716) [`6f58ba3`](https://github.com/changesets/action/commit/6f58ba35801ec075a1c87569277591f8ef1a3029) Thanks [@bluwy](https://github.com/bluwy)! - Update `pr-status` message to link to the new faq page
|
||||
|
||||
## 2.0.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- [#692](https://github.com/changesets/action/pull/692) [`cb3f011`](https://github.com/changesets/action/commit/cb3f0110d7423cd340b1c5d63584c0ea6ee63959) Thanks [@Andarist](https://github.com/Andarist)! - Release commits and tags are now pushed using the GitHub API by default.
|
||||
|
||||
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
|
||||
|
||||
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
|
||||
|
||||
- [#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.
|
||||
|
||||
- [#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.
|
||||
|
||||
- [#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.
|
||||
|
||||
- [#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.
|
||||
|
||||
- [#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
|
||||
|
||||
- [#695](https://github.com/changesets/action/pull/695) [`469993c`](https://github.com/changesets/action/commit/469993ce5783c6a38e72541d4ba0d25588702b9a) Thanks [@bluwy](https://github.com/bluwy)! - Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
|
||||
|
||||
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
|
||||
|
||||
- [#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
|
||||
|
||||
- [#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
|
||||
|
||||
- [#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.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#699](https://github.com/changesets/action/pull/699) [`5b307d3`](https://github.com/changesets/action/commit/5b307d3df25daf51c41dff70d2f66df1579ae9fa) Thanks [@Andarist](https://github.com/Andarist)! - Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
|
||||
|
||||
- [#697](https://github.com/changesets/action/pull/697) [`84d78c6`](https://github.com/changesets/action/commit/84d78c68f98f20e24dfff22b22193e7b4f326ad9) Thanks [@Andarist](https://github.com/Andarist)! - 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.
|
||||
|
||||
- [#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.
|
||||
|
||||
- [#688](https://github.com/changesets/action/pull/688) [`219ea82`](https://github.com/changesets/action/commit/219ea82e52caaff2a10a5e34d3455093cf958238) Thanks [@Andarist](https://github.com/Andarist)! - Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
|
||||
|
||||
## 2.0.0-next.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#711](https://github.com/changesets/action/pull/711) [`5fa6767`](https://github.com/changesets/action/commit/5fa67671df41b7a8a9d8123e8e446b1a8ad423db) Thanks [@Andarist](https://github.com/Andarist)! - Fix support for prerelease exits using the new `.changeset/pre` layout.
|
||||
|
||||
## 2.0.0-next.4
|
||||
|
||||
### Major Changes
|
||||
|
||||
- [#692](https://github.com/changesets/action/pull/692) [`cb3f011`](https://github.com/changesets/action/commit/cb3f0110d7423cd340b1c5d63584c0ea6ee63959) Thanks [@Andarist](https://github.com/Andarist)! - Release commits and tags are now pushed using the GitHub API by default.
|
||||
|
||||
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
|
||||
|
||||
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
|
||||
|
||||
- [#695](https://github.com/changesets/action/pull/695) [`469993c`](https://github.com/changesets/action/commit/469993ce5783c6a38e72541d4ba0d25588702b9a) Thanks [@bluwy](https://github.com/bluwy)! - Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
|
||||
|
||||
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#699](https://github.com/changesets/action/pull/699) [`5b307d3`](https://github.com/changesets/action/commit/5b307d3df25daf51c41dff70d2f66df1579ae9fa) Thanks [@Andarist](https://github.com/Andarist)! - Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
|
||||
|
||||
- [#697](https://github.com/changesets/action/pull/697) [`84d78c6`](https://github.com/changesets/action/commit/84d78c68f98f20e24dfff22b22193e7b4f326ad9) Thanks [@Andarist](https://github.com/Andarist)! - 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.
|
||||
|
||||
- [#705](https://github.com/changesets/action/pull/705) [`77be81b`](https://github.com/changesets/action/commit/77be81bcb9d2d1007c53c4f98bffe51da428d6a5) Thanks [@Andarist](https://github.com/Andarist)! - Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates when using GitHub API pushes.
|
||||
|
||||
- [#688](https://github.com/changesets/action/pull/688) [`219ea82`](https://github.com/changesets/action/commit/219ea82e52caaff2a10a5e34d3455093cf958238) Thanks [@Andarist](https://github.com/Andarist)! - Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
|
||||
|
||||
## 2.0.0-next.3
|
||||
|
||||
### Major Changes
|
||||
|
||||
@@ -1,77 +1,235 @@
|
||||
# Changesets GitHub Action
|
||||
# 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 repo contains a collection of GitHub Actions for [Changesets](https://changesets.dev). Check out the [Automating Changesets](https://changesets.dev/guide/automating) guide to learn how to use these actions to automate your workflow.
|
||||
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.
|
||||
|
||||
- [changesets/action](./README.md): (This README. See below for details.)
|
||||
- [changesets/action/select-mode](./select-mode/README.md): Select the mode to run a Changesets workflow.
|
||||
- [changesets/action/version](./version/README.md): Version packages and create or update a pull request with the changes.
|
||||
- [changesets/action/pack](./pack/README.md): Pack publishable packages into tarballs.
|
||||
- [changesets/action/publish](./publish/README.md): Publish packages to npm.
|
||||
- [changesets/action/pr-status](./pr-status/README.md): Generate changeset status in PRs.
|
||||
- [changesets/action/pr-comment](./pr-comment/README.md): Create or update comments on PRs.
|
||||
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details:
|
||||
|
||||
## changesets/action
|
||||
- [pr-status](./pr-status/README.md): Generate changeset status in PRs.
|
||||
- [pr-comment](./pr-comment/README.md): Comment on PRs.
|
||||
|
||||
This action handles versioning and publishing of packages. It's the equivalent of setting up the `changesets/action/select-mode`, `changesets/action/version`, and `changesets/action/publish` actions in a workflow, but with the required permissions combined.
|
||||
## Usage
|
||||
|
||||
If using [trusted publishing](https://docs.npmjs.com/trusted-publishers), it's recommended to set up the individual sub-actions instead to tighten publish permissions.
|
||||
### Inputs
|
||||
|
||||
### Requirements
|
||||
- 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()`
|
||||
- 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
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]:
|
||||
- `contents: write`: to commit version changes
|
||||
- `pull-requests: write`: to create pull request
|
||||
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
### Outputs
|
||||
|
||||
> [!NOTE]
|
||||
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
|
||||
- published - A boolean value to indicate whether a publishing has happened or not
|
||||
- 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
|
||||
|
||||
### Usage
|
||||
### Example workflow
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
#### Without Publishing
|
||||
|
||||
> [!IMPORTANT]
|
||||
> To use a custom GitHub token, pass it explicitly through the `github-token` input:
|
||||
>
|
||||
> ```yaml
|
||||
> with:
|
||||
> github-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
|
||||
> ```
|
||||
>
|
||||
> Setting the `GITHUB_TOKEN` environment variable does not configure the action. This applies whether release changes are pushed using the GitHub API or the Git CLI.
|
||||
Create a file at `.github/workflows/release.yml` with the following content.
|
||||
|
||||
### API
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
<!-- api-start -->
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
| Inputs | Description |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `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. Default to `Version Packages` |
|
||||
| `pr-title` | The pull request title. Default to `Version Packages` |
|
||||
| `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. |
|
||||
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
|
||||
| `create-github-releases` | Whether to create Github releases after publish |
|
||||
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
|
||||
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits and tags. Defaults to `false`. When using the GitHub API, commits and tags are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
|
||||
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `published` | A "true" or "false" string value to indicate whether a publishing is happened or not |
|
||||
| `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"}]` |
|
||||
| `has-changesets` | A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality. |
|
||||
| `pr-number` | The pull request number that was created or updated |
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v6
|
||||
|
||||
<!-- api-end -->
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v6
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
- name: Setup Node.js 26
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 26
|
||||
|
||||
- name: Install Dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Create Release Pull Request
|
||||
uses: changesets/action@v2
|
||||
```
|
||||
|
||||
#### With Publishing
|
||||
|
||||
Before you can setup this action with publishing, you'll need to have an [npm token](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) that can publish the packages in the repo you're setting up the action for and doesn't have 2FA on publish enabled ([2FA on auth can be enabled](https://docs.npmjs.com/about-two-factor-authentication)). You'll also need to [add it as a secret on your GitHub repo](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) with the name `NPM_TOKEN`. Once you've done that, you can create a file at `.github/workflows/release.yml` with the following content.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v6
|
||||
|
||||
- name: Setup Node.js 26
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 26
|
||||
|
||||
- name: Install Dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Create Release Pull Request or Publish to npm
|
||||
id: changesets
|
||||
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-script: pnpm release
|
||||
env:
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
- name: Send a Slack notification if a publish happens
|
||||
if: steps.changesets.outputs.published == 'true'
|
||||
# You can do something when a publish happens.
|
||||
run: my-slack-bot send-notification --message "A new version of ${GITHUB_REPOSITORY} was published!"
|
||||
```
|
||||
|
||||
By default the GitHub Action creates a `.npmrc` file with the following content:
|
||||
|
||||
```txt
|
||||
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
|
||||
```
|
||||
|
||||
However, if a `.npmrc` file is found, the GitHub Action does not recreate the file. This is useful if you need to configure the `.npmrc` file on your own.
|
||||
For example, you can add a step before running the Changesets GitHub Action:
|
||||
|
||||
```yml
|
||||
- name: Creating .npmrc
|
||||
run: |
|
||||
cat << EOF > "$HOME/.npmrc"
|
||||
//registry.npmjs.org/:_authToken=$NPM_TOKEN
|
||||
EOF
|
||||
env:
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
```
|
||||
|
||||
#### Custom Publishing
|
||||
|
||||
If you want to hook into when publishing should occur but have your own publishing functionality, you can utilize the `hasChangesets` output.
|
||||
|
||||
Note that you might need to account for things already being published in your script because a commit without any new changesets can always land on your base branch after a successful publish. In such a case you need to figure out on your own how to skip over the actual publishing logic or handle errors gracefully as most package registries won't allow you to publish over already published version.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v6
|
||||
|
||||
- name: Setup Node.js 26
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 26
|
||||
|
||||
- name: Install Dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Create Release Pull Request or Publish to npm
|
||||
id: changesets
|
||||
uses: changesets/action@v2
|
||||
|
||||
- name: Publish
|
||||
if: steps.changesets.outputs.hasChangesets == 'false'
|
||||
# You can do something when a publish should happen.
|
||||
run: pnpm publish
|
||||
```
|
||||
|
||||
#### With version script
|
||||
|
||||
If you need to add additional logic to the version command, you can do so by using a version script.
|
||||
|
||||
If the version script is present, this action will run that script instead of `changeset version`, so please make sure that your script calls `changeset version` at some point. All the changes made by the script will be included in the PR.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v6
|
||||
|
||||
- name: Setup Node.js 26
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 26
|
||||
|
||||
- name: Install Dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Create Release Pull Request
|
||||
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-script: pnpm version
|
||||
```
|
||||
|
||||
#### With Yarn 2 / Plug'n'Play
|
||||
|
||||
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@v2
|
||||
with:
|
||||
version-script: yarn changeset version
|
||||
# ...
|
||||
```
|
||||
|
||||
+14
-12
@@ -5,9 +5,7 @@ runs:
|
||||
main: "dist/index.js"
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
publish-script:
|
||||
@@ -40,24 +38,28 @@ inputs:
|
||||
this option will also always be `true`.
|
||||
required: false
|
||||
default: true
|
||||
push-with-git-cli:
|
||||
commit-mode:
|
||||
description: >
|
||||
Whether to use the Git CLI instead of the GitHub API to push release commits and tags.
|
||||
Defaults to `false`. When using the GitHub API, commits and tags are signed using
|
||||
GitHub's GPG key and attributed to the user or app that owns the `github-token`.
|
||||
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: false
|
||||
cwd:
|
||||
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
|
||||
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:
|
||||
published:
|
||||
description: A "true" or "false" string value to indicate whether a publishing is happened or not
|
||||
description: A boolean value to indicate whether a publishing is 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 a staged release handoff emitted by the publish script
|
||||
has-changesets:
|
||||
description: A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality.
|
||||
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
|
||||
pr-number:
|
||||
description: The pull request number that was created or updated
|
||||
branding:
|
||||
|
||||
@@ -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.
|
||||
@@ -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
|
||||
+1
-30
@@ -1,32 +1,3 @@
|
||||
# changesets/action/pack
|
||||
|
||||
This action packs publishable packages into tarballs, complements [changesets/action/publish](../publish/README.md) to publish them in a later step.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| -------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `publish-plan-artifact-id` | Artifact id for a publish plan generated by the select-mode subaction |
|
||||
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
||||
|
||||
| Outputs | Description |
|
||||
| ---------------------- | ------------------------------------------- |
|
||||
| `pack-dir-artifact-id` | Artifact id for the packed output directory |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
TODO
|
||||
|
||||
@@ -7,9 +7,6 @@ inputs:
|
||||
publish-plan-artifact-id:
|
||||
description: "Artifact id for a publish plan generated by the select-mode subaction"
|
||||
required: false
|
||||
cwd:
|
||||
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
|
||||
required: false
|
||||
outputs:
|
||||
pack-dir-artifact-id:
|
||||
description: "Artifact id for the packed output directory"
|
||||
|
||||
+27
-29
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@changesets/action",
|
||||
"version": "2.1.2",
|
||||
"version": "2.0.0-next.3",
|
||||
"private": true,
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
@@ -13,46 +13,44 @@
|
||||
"format": "oxfmt --check",
|
||||
"format:fix": "oxfmt",
|
||||
"changeset": "changeset",
|
||||
"bump": "node ./scripts/bump.ts",
|
||||
"update-readme": "node ./scripts/update-readme.ts",
|
||||
"release": "node ./scripts/release.ts",
|
||||
"release:pr": "node ./scripts/release-pr.ts"
|
||||
"bump": "node --experimental-strip-types ./scripts/bump.ts",
|
||||
"release": "node --experimental-strip-types ./scripts/release.ts",
|
||||
"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": "^5.0.2",
|
||||
"@changesets/ghcommit": "^3.0.0",
|
||||
"@changesets/git": "^4.0.1",
|
||||
"@changesets/pre": "^3.0.0",
|
||||
"@changesets/read": "^1.0.1",
|
||||
"@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.8",
|
||||
"@octokit/plugin-throttling": "^11.0.5",
|
||||
"human-id": "^4.2.1",
|
||||
"@octokit/core": "^7.0.6",
|
||||
"@octokit/plugin-throttling": "^11.0.3",
|
||||
"human-id": "^4.1.3",
|
||||
"markdown-table": "^3.0.4",
|
||||
"semver": "^7.8.5",
|
||||
"tinyexec": "^1.3.1"
|
||||
"semver": "^7.8.1",
|
||||
"tinyexec": "^1.2.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@changesets/changelog-github": "^1.0.1",
|
||||
"@changesets/cli": "^3.0.3",
|
||||
"@changesets/types": "^7.0.0",
|
||||
"@changesets/write": "^1.0.1",
|
||||
"@tsconfig/node24": "^24.0.5",
|
||||
"@types/node": "^26.6.2",
|
||||
"@types/semver": "^7.8.0",
|
||||
"fs-fixture": "^2.16.0",
|
||||
"oxfmt": "^0.70.0",
|
||||
"rolldown": "^1.2.10",
|
||||
"typescript": "^7.0.2",
|
||||
"vitest": "^5.0.1",
|
||||
"yaml": "^2.9.1"
|
||||
"@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",
|
||||
"fs-fixture": "^2.13.0",
|
||||
"oxfmt": "^0.48.0",
|
||||
"rolldown": "^1.0.1",
|
||||
"typescript": "^6.0.3",
|
||||
"vitest": "^4.1.6"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
},
|
||||
"packageManager": "pnpm@11.20.0+sha512.9a6f330a95b66446ea088faf1521405a8a01f07fde7124cc9958dfed52d4bb436737e65b08f85f37b46fcba375092558ac51262b816844b22f63406ed166bfee"
|
||||
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a"
|
||||
}
|
||||
|
||||
Generated
+801
-975
File diff suppressed because it is too large
Load Diff
+17
-18
@@ -3,24 +3,23 @@ dedupePeers: true
|
||||
dedupePeerDependents: true
|
||||
minimumReleaseAge: 10080
|
||||
minimumReleaseAgeExclude:
|
||||
- "@changesets/apply-release-plan@8.0.0"
|
||||
- "@changesets/assemble-release-plan@7.0.0"
|
||||
- "@changesets/changelog-git@1.0.0"
|
||||
- "@changesets/changelog-github@1.0.0"
|
||||
- "@changesets/cli@3.0.0"
|
||||
- "@changesets/config@4.0.0"
|
||||
- "@changesets/errors@1.0.0"
|
||||
- "@changesets/get-dependents-graph@3.0.0"
|
||||
- "@changesets/get-github-info@1.0.0"
|
||||
- "@changesets/get-release-plan@5.0.0"
|
||||
- "@changesets/git@4.0.0"
|
||||
- "@changesets/parse@1.0.0"
|
||||
- "@changesets/pre@3.0.0"
|
||||
- "@changesets/read@1.0.0"
|
||||
- "@changesets/should-skip-package@1.0.0"
|
||||
- "@changesets/types@7.0.0"
|
||||
- "@changesets/write@1.0.0"
|
||||
- "vite@8.2.0"
|
||||
- "@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
|
||||
|
||||
+12
-49
@@ -1,28 +1,16 @@
|
||||
# changesets/action/pr-comment
|
||||
# @changesets/action/pr-comment
|
||||
|
||||
This action creates or updates comments on PRs, aimed to complement [changesets/action/pr-status](../pr-status/README.md).
|
||||
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md).
|
||||
|
||||
Its features are kept intentionally simple. For advanced usecases, check out other actions such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
|
||||
This action is intentionally simple without advanced features. Check out other actions if so, such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
|
||||
|
||||
## Requirements
|
||||
See the [action metadata](action.yml) for details on the inputs and outputs.
|
||||
|
||||
- [Job permissions][job-permissions]:
|
||||
- `pull-requests: write`: to create and update comments on PRs
|
||||
- [Workflow triggers][workflow-triggers]:
|
||||
- [`pull_request`][trigger-pull-request]
|
||||
- [`pull_request_target`][trigger-pull-request-target]
|
||||
|
||||
> [!CAUTION]
|
||||
> **Do not run untrusted code** when using the `pull_request_target` event.
|
||||
>
|
||||
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
|
||||
## Example setup
|
||||
|
||||
```yaml
|
||||
name: PR Comment
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
@@ -30,25 +18,21 @@ jobs:
|
||||
pr-comment:
|
||||
runs-on: ubuntu-slim
|
||||
permissions:
|
||||
pull-requests: write # to create and update comments on PRs (changesets/action/pr-comment)
|
||||
pull-requests: write # to create and update comments on PRs
|
||||
steps:
|
||||
- name: Comment on PR
|
||||
uses: changesets/action/pr-comment@v2
|
||||
- uses: changesets/action/pr-comment@v1
|
||||
with:
|
||||
body: Hello world!
|
||||
```
|
||||
|
||||
If the action is called again for the same PR, for example, if called in another workflow run, it will update the comment it created by default.
|
||||
|
||||
If you use the action to create different types of comments, pass an `update-id` value to differentiate them.
|
||||
When called repeatedly, the action will update the comment it created by default. If you use this action to create different types of comments, pass an `update-id` value to differentiate them.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
pr-comment:
|
||||
# ...
|
||||
steps:
|
||||
- name: Comment on PR
|
||||
uses: changesets/action/pr-comment@v2
|
||||
- uses: changesets/action/pr-comment@v1
|
||||
with:
|
||||
body: Hello world!
|
||||
update-id: my-tag
|
||||
@@ -61,29 +45,8 @@ jobs:
|
||||
pr-comment:
|
||||
# ...
|
||||
steps:
|
||||
- uses: changesets/action/pr-comment@v2
|
||||
- uses: changesets/action/pr-comment@v1
|
||||
with:
|
||||
body: Hello world!
|
||||
update-id: ""
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `body` | **Required.** The comment body to post on the PR. |
|
||||
| `update-id` | By default, the action will create and update a comment with this id. Pass a different id to create and update a new comment, or pass an empty string to disable updating comments. |
|
||||
|
||||
| Outputs | Description |
|
||||
| ------------ | ---------------------------------------------------------- |
|
||||
| `comment-id` | The comment id of the comment that was created or updated. |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
|
||||
[trigger-pull-request-target]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
|
||||
|
||||
@@ -1,13 +1,11 @@
|
||||
name: Changesets - PR Comment
|
||||
description: Create or update comments on PRs
|
||||
description: A simple GitHub Action to comment on PRs
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/pr-comment.js
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
body:
|
||||
|
||||
+55
-24
@@ -1,40 +1,71 @@
|
||||
# changesets/action/pr-status
|
||||
|
||||
This action generates the changesets status in PRs, for example, whether it has changeset files and which packages will be released if the PR is merged.
|
||||
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 will automatically fetch the PR head ref into a temporary detached worktree in order to infer the changed files and packages.
|
||||
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.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]:
|
||||
- [`pull_request`][trigger-pull-request]
|
||||
- [`pull_request_target`][trigger-pull-request-target]
|
||||
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.
|
||||
>
|
||||
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
|
||||
> 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).
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
|
||||
[trigger-pull-request-target]: 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:
|
||||
|
||||
## Usage
|
||||
```yaml
|
||||
jobs:
|
||||
pr-status:
|
||||
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||
# ...
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
|
||||
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.
|
||||
|
||||
## API
|
||||
## Example setup
|
||||
|
||||
<!-- api-start -->
|
||||
```yaml
|
||||
# .github/workflows/comment-changesets-pr-status.yml
|
||||
name: Comment Changesets status in PRs
|
||||
|
||||
Inputs: _none_
|
||||
on:
|
||||
pull_request_target:
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| `comment-body` | The generated comment body to present the changesets status in PRs. |
|
||||
permissions: {} # require explicitly stating all permissions in each job
|
||||
|
||||
<!-- api-end -->
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
pr-status:
|
||||
runs-on: ubuntu-slim
|
||||
permissions:
|
||||
contents: read # to check out files in the repo
|
||||
outputs:
|
||||
comment-body: ${{ steps.pr-status.outputs.comment-body }}
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Generate status
|
||||
id: pr-status
|
||||
uses: changesets/action/pr-status@v1
|
||||
|
||||
pr-comment:
|
||||
needs: pr-status
|
||||
runs-on: ubuntu-slim
|
||||
permissions:
|
||||
pull-requests: write # to create and update comments on PRs
|
||||
steps:
|
||||
- name: Comment on PR
|
||||
uses: changesets/action/pr-comment@v1
|
||||
with:
|
||||
body: ${{ needs.pr-status.outputs.comment-body }}
|
||||
```
|
||||
|
||||
The workflow uses [`@changesets/action/pr-comment`](../pr-comment/README.md), which is a simple GitHub Action to comment on PRs.
|
||||
|
||||
+17
-31
@@ -1,38 +1,24 @@
|
||||
# changesets/action/publish
|
||||
|
||||
This action publishes packages to npm.
|
||||
Publishes packages with Changesets.
|
||||
|
||||
## Requirements
|
||||
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.
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]:
|
||||
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
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:
|
||||
|
||||
## Usage
|
||||
```sh
|
||||
changeset stage approve <id...>
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
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.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `script` | The command to use to publish packages |
|
||||
| `pack-dir-artifact-id` | Artifact id for packed publish output generated by the pack subaction |
|
||||
| `create-github-releases` | Whether to create Github releases after publish |
|
||||
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
|
||||
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `published` | A "true" or "false" string value to indicate whether a publishing has happened or not |
|
||||
| `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"}]` |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
After approval, pass the artifact id to
|
||||
`changesets/action/github-release` to verify publication and create Git tags
|
||||
and GitHub Releases.
|
||||
|
||||
+10
-7
@@ -5,14 +5,18 @@ runs:
|
||||
main: ../dist/publish.js
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
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
|
||||
@@ -26,15 +30,14 @@ inputs:
|
||||
this option will also always be `true`.
|
||||
required: false
|
||||
default: true
|
||||
cwd:
|
||||
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
|
||||
required: false
|
||||
outputs:
|
||||
published:
|
||||
description: A "true" or "false" string value to indicate whether a publishing has happened or not
|
||||
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
|
||||
|
||||
@@ -9,6 +9,7 @@ export default defineConfig({
|
||||
"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",
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
import * as fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { markdownTable } from "markdown-table";
|
||||
import * as yaml from "yaml";
|
||||
|
||||
await main();
|
||||
|
||||
async function main() {
|
||||
for await (const readmePath of fs.glob("**/README.md", {
|
||||
exclude: ["**/node_modules/**"],
|
||||
})) {
|
||||
const actionPath = path.join(path.dirname(readmePath), "action.yml");
|
||||
const actionExists = await fs.stat(actionPath).catch(() => null);
|
||||
if (!actionExists) continue;
|
||||
|
||||
const action = yaml.parse(await fs.readFile(actionPath, "utf8"));
|
||||
const inputs = action.inputs ?? {};
|
||||
const outputs = action.outputs ?? {};
|
||||
|
||||
const content = [
|
||||
renderSection("Inputs", inputs),
|
||||
renderSection("Outputs", outputs),
|
||||
].join("\n\n");
|
||||
|
||||
const readme = await fs.readFile(readmePath, "utf8");
|
||||
const updated = readme.replace(
|
||||
/<!-- api-start -->[\s\S]*?<!-- api-end -->/,
|
||||
`<!-- api-start -->\n\n${content}\n\n<!-- api-end -->`,
|
||||
);
|
||||
await fs.writeFile(readmePath, updated);
|
||||
}
|
||||
}
|
||||
|
||||
function renderSection(title: string, entries: Record<string, any>) {
|
||||
const rows: string[][] = [];
|
||||
for (const [name, entry] of Object.entries(entries)) {
|
||||
let description = (entry.description ?? "").trim().replace(/\|/g, "\\|");
|
||||
if (entry.required) description = `**Required.** ${description}`;
|
||||
rows.push([`\`${name}\``, description]);
|
||||
}
|
||||
if (rows.length === 0) {
|
||||
return `${title}: _none_`;
|
||||
}
|
||||
rows.unshift([title, "Description"]);
|
||||
return markdownTable(rows);
|
||||
}
|
||||
+1
-33
@@ -1,35 +1,3 @@
|
||||
# changesets/action/select-mode
|
||||
|
||||
This action selects the mode to run a Changesets workflow:
|
||||
|
||||
- `"version"`: Changesets are found. The workflow should version packages and create a pull request with the changes.
|
||||
- `"publish"`: No changesets are found and they are publishable packages. The workflow should publish them.
|
||||
- `"none"`: No changesets are found and there are no publishable packages. The workflow should do nothing.
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| ------ | --------------------------------------------------------------------------------------- |
|
||||
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `mode` | The mode to use for the current repo state: 'version', 'publish', or 'none'. |
|
||||
| `publish-plan-artifact-id` | Artifact id for the generated publish plan when mode is `publish` |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
TODO
|
||||
|
||||
@@ -3,10 +3,7 @@ description: Whether to version or publish in the current repo state
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/select-mode.js
|
||||
inputs:
|
||||
cwd:
|
||||
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
|
||||
required: false
|
||||
inputs: {}
|
||||
outputs:
|
||||
mode:
|
||||
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
|
||||
|
||||
@@ -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,
|
||||
})),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -1,227 +0,0 @@
|
||||
import { Buffer } from "node:buffer";
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { exec } from "tinyexec";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { GitHub } from "./github.ts";
|
||||
import { createGitHttpRemote, shallowClone, testdir } from "./test-utils.ts";
|
||||
|
||||
const githubContext = vi.hoisted(() => ({
|
||||
repo: {
|
||||
owner: "changesets",
|
||||
repo: "action",
|
||||
},
|
||||
sha: "base-sha",
|
||||
}));
|
||||
|
||||
vi.mock("@actions/github", () => ({
|
||||
context: githubContext,
|
||||
getOctokit: () => ({}),
|
||||
}));
|
||||
|
||||
async function git(cwd: string, args: string[]) {
|
||||
const result = await exec("git", args, {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
return result.stdout.trim();
|
||||
}
|
||||
|
||||
function getAuthorization(token: string) {
|
||||
return `basic ${Buffer.from(`x-access-token:${token}`).toString("base64")}`;
|
||||
}
|
||||
|
||||
function createRemote() {
|
||||
return createGitHttpRemote({ "file.txt": "initial\n" });
|
||||
}
|
||||
|
||||
async function isolateGitConfig() {
|
||||
const fixture = await testdir({ "global.gitconfig": "" });
|
||||
vi.stubEnv("GIT_CONFIG_GLOBAL", path.join(fixture.path, "global.gitconfig"));
|
||||
return fixture;
|
||||
}
|
||||
|
||||
type GitHttpRemote = Awaited<ReturnType<typeof createGitHttpRemote>>;
|
||||
|
||||
async function pushChangedFile(
|
||||
repository: string,
|
||||
serverUrl: string,
|
||||
token: string,
|
||||
) {
|
||||
await fs.writeFile(path.join(repository, "file.txt"), "changed\n");
|
||||
const github = new GitHub({
|
||||
cwd: repository,
|
||||
githubToken: token,
|
||||
pushWithGitCli: true,
|
||||
serverUrl,
|
||||
});
|
||||
await github.pushChanges({
|
||||
branch: "changeset-release/main",
|
||||
message: "Version Packages",
|
||||
});
|
||||
return github;
|
||||
}
|
||||
|
||||
async function expectReleaseBranch(remote: GitHttpRemote, repository: string) {
|
||||
expect(
|
||||
await git(remote.path, ["rev-parse", "refs/heads/changeset-release/main"]),
|
||||
).toBe(await git(repository, ["rev-parse", "HEAD"]));
|
||||
}
|
||||
|
||||
function expectRequestsToUseToken(remote: GitHttpRemote, token: string) {
|
||||
expect(remote.requests.length).toBeGreaterThan(0);
|
||||
for (const request of remote.requests) {
|
||||
expect(request.headers.authorization).toEqual([getAuthorization(token)]);
|
||||
}
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.stubEnv("GIT_AUTHOR_DATE", "2000-01-01T00:00:00Z");
|
||||
vi.stubEnv("GIT_COMMITTER_DATE", "2000-01-01T00:00:00Z");
|
||||
vi.stubEnv("GIT_CONFIG_COUNT", "0");
|
||||
vi.stubEnv("GIT_CONFIG_NOSYSTEM", "1");
|
||||
vi.stubEnv("GIT_TERMINAL_PROMPT", "0");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
describe("GitHub", () => {
|
||||
it("defaults to GitHub API mode", () => {
|
||||
const github = new GitHub({
|
||||
cwd: "/repo",
|
||||
githubToken: "token",
|
||||
});
|
||||
|
||||
expect(github.pushWithGitCli).toBe(false);
|
||||
});
|
||||
|
||||
it("uses github-token instead of checkout's persisted header for branch and tag pushes", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
const checkoutToken = "checkout-token";
|
||||
await using remote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(remote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
const serverUrl = new URL(remote.url).origin;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", remote.url]);
|
||||
await git(repository, [
|
||||
"config",
|
||||
`http.${serverUrl}/.extraheader`,
|
||||
`AUTHORIZATION: ${getAuthorization(checkoutToken)}`,
|
||||
]);
|
||||
|
||||
const github = await pushChangedFile(repository, serverUrl, actionToken);
|
||||
await git(repository, ["tag", "v1.0.0"]);
|
||||
await github.pushTag("v1.0.0");
|
||||
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expect(await git(remote.path, ["rev-parse", "refs/tags/v1.0.0"])).toBe(
|
||||
await git(repository, ["rev-parse", "v1.0.0"]),
|
||||
);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses github-token instead of credentials embedded in the push URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using remote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(remote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
const remoteUrl = new URL(remote.url);
|
||||
remoteUrl.username = "x-access-token";
|
||||
remoteUrl.password = "checkout-token";
|
||||
await git(repository, ["remote", "set-url", "origin", remoteUrl.href]);
|
||||
|
||||
const persistedCredentialUrl = new URL(remoteUrl);
|
||||
persistedCredentialUrl.password = "";
|
||||
await git(repository, [
|
||||
"config",
|
||||
`http.${persistedCredentialUrl.href}.extraheader`,
|
||||
`AUTHORIZATION: ${getAuthorization("checkout-token")}`,
|
||||
]);
|
||||
|
||||
await pushChangedFile(repository, remoteUrl.origin, actionToken);
|
||||
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses the push URL when it differs from the fetch URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using fetchRemote = await createRemote();
|
||||
await using pushRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(fetchRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
|
||||
await git(repository, ["config", "remote.origin.pushurl", pushRemote.url]);
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(fetchRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
expect(fetchRemote.requests).toEqual([]);
|
||||
await expectReleaseBranch(pushRemote, repository);
|
||||
expectRequestsToUseToken(pushRemote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses github-token for every push URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using firstRemote = await createRemote();
|
||||
await using secondRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(firstRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
for (const remote of [firstRemote, secondRemote]) {
|
||||
await git(repository, [
|
||||
"config",
|
||||
"--add",
|
||||
"remote.origin.pushurl",
|
||||
remote.url,
|
||||
]);
|
||||
}
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(firstRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
for (const remote of [firstRemote, secondRemote]) {
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}
|
||||
}, 15_000);
|
||||
|
||||
it("preserves existing command-scoped Git config entries", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using fetchRemote = await createRemote();
|
||||
await using pushRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(fetchRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
|
||||
vi.stubEnv("GIT_CONFIG_COUNT", "1");
|
||||
vi.stubEnv("GIT_CONFIG_KEY_0", "remote.origin.pushurl");
|
||||
vi.stubEnv("GIT_CONFIG_VALUE_0", pushRemote.url);
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(fetchRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
expect(fetchRemote.requests).toEqual([]);
|
||||
await expectReleaseBranch(pushRemote, repository);
|
||||
expectRequestsToUseToken(pushRemote, actionToken);
|
||||
}, 15_000);
|
||||
});
|
||||
+37
-136
@@ -5,6 +5,8 @@ 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>;
|
||||
@@ -48,47 +50,20 @@ const checkIfClean = async (options: GitOptions): Promise<boolean> => {
|
||||
return !stdout.length;
|
||||
};
|
||||
|
||||
function getHttpUrl(remoteUrl: string): string | undefined {
|
||||
try {
|
||||
const url = new URL(remoteUrl);
|
||||
if (url.protocol !== "http:" && url.protocol !== "https:") {
|
||||
return;
|
||||
}
|
||||
|
||||
// Git includes the username when deciding which URL-specific config is
|
||||
// most specific, so retain it. Password, query, and fragment do not
|
||||
// participate in matching; strip them before copying the URL into the env.
|
||||
url.password = "";
|
||||
url.search = "";
|
||||
url.hash = "";
|
||||
return url.href;
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
export class GitHub {
|
||||
readonly #githubToken: string;
|
||||
readonly octokit: Octokit;
|
||||
readonly cwd: string;
|
||||
readonly pushWithGitCli: boolean;
|
||||
readonly serverUrl: string;
|
||||
readonly commitMode: CommitMode;
|
||||
|
||||
constructor(options: {
|
||||
githubToken: string;
|
||||
cwd: string;
|
||||
pushWithGitCli?: boolean;
|
||||
serverUrl?: string;
|
||||
commitMode?: CommitMode;
|
||||
}) {
|
||||
this.#githubToken = options.githubToken;
|
||||
this.cwd = options.cwd;
|
||||
this.pushWithGitCli = options.pushWithGitCli ?? false;
|
||||
this.serverUrl = (
|
||||
options.serverUrl ??
|
||||
context.serverUrl ??
|
||||
process.env.GITHUB_SERVER_URL ??
|
||||
"https://github.com"
|
||||
).replace(/\/+$/, "");
|
||||
this.commitMode = options.commitMode ?? "git-cli";
|
||||
this.octokit = setupOctokit(options.githubToken);
|
||||
}
|
||||
|
||||
@@ -96,106 +71,32 @@ export class GitHub {
|
||||
return this.#githubToken;
|
||||
}
|
||||
|
||||
async #getCliAuthEnv(): Promise<Record<string, string>> {
|
||||
// Make `github-token` authoritative for CLI pushes without changing the
|
||||
// repository config. Git may otherwise use checkout's persisted header or
|
||||
// credentials embedded in a remote URL, so we need to install command-scoped
|
||||
// `http.extraHeader` overrides for every push destination.
|
||||
//
|
||||
// Historical context: v1 put `github-token` in ~/.netrc, where checkout's
|
||||
// extraheader took precedence. This setup with reset + authHeader
|
||||
// deliberately makes `github-token` win for pushes.
|
||||
#getCliAuthEnv(): Record<string, string> {
|
||||
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
|
||||
"base64",
|
||||
);
|
||||
|
||||
// The environment may already contain command-scoped Git config. Append
|
||||
// our KEY_n/VALUE_n entries so those existing settings stay active.
|
||||
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}`,
|
||||
);
|
||||
}
|
||||
|
||||
// `git push origin` prefers remote.origin.pushurl over the fetch URL and
|
||||
// supports more than one push URL, so inspect every effective destination.
|
||||
const { stdout } = await getExecOutput(
|
||||
"git",
|
||||
["remote", "get-url", "--push", "--all", "origin"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
// A user-configured remote can contain credentials.
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
|
||||
// Git reads `http.extraHeader` from the most specific matching URL section.
|
||||
// The host key replaces checkout's usual persisted header; an exact key for
|
||||
// each destination outranks path- or username-specific inherited config.
|
||||
// Git selects only one URL section, so these keys do not duplicate headers.
|
||||
const extraHeaderKeys = new Set([`http.${this.serverUrl}/.extraheader`]);
|
||||
for (const remoteUrl of stdout.split(/\r?\n/)) {
|
||||
const httpUrl = getHttpUrl(remoteUrl);
|
||||
if (httpUrl !== undefined) {
|
||||
extraHeaderKeys.add(`http.${httpUrl}.extraheader`);
|
||||
}
|
||||
}
|
||||
const authHeader = `AUTHORIZATION: basic ${basic}`;
|
||||
|
||||
// Each URL key needs two new command-scoped config entries: one to reset
|
||||
// the inherited header list and one to install our Authorization header.
|
||||
const env: Record<string, string> = {
|
||||
GIT_CONFIG_COUNT: String(gitConfigCount + extraHeaderKeys.size * 2),
|
||||
return {
|
||||
GIT_CONFIG_COUNT: String(gitConfigCount + 1),
|
||||
[`GIT_CONFIG_KEY_${gitConfigCount}`]: `http.${serverUrl}/.extraheader`,
|
||||
[`GIT_CONFIG_VALUE_${gitConfigCount}`]: `AUTHORIZATION: basic ${basic}`,
|
||||
};
|
||||
|
||||
// `http.extraHeader` is multi-valued, so merely appending our header could
|
||||
// make Git send both tokens. An empty value resets inherited values; the
|
||||
// following value adds only ours.
|
||||
let index = 0;
|
||||
for (const extraHeaderKey of extraHeaderKeys) {
|
||||
const resetIndex = gitConfigCount + index * 2;
|
||||
const authIndex = resetIndex + 1;
|
||||
env[`GIT_CONFIG_KEY_${resetIndex}`] = extraHeaderKey;
|
||||
env[`GIT_CONFIG_VALUE_${resetIndex}`] = "";
|
||||
env[`GIT_CONFIG_KEY_${authIndex}`] = extraHeaderKey;
|
||||
env[`GIT_CONFIG_VALUE_${authIndex}`] = authHeader;
|
||||
index++;
|
||||
}
|
||||
|
||||
return env;
|
||||
}
|
||||
|
||||
async ensureGitUser() {
|
||||
// Check the exact identities that Git would use for commits without
|
||||
// allowing Git to fall back to auto-detected values like user@hostname.
|
||||
// This covers explicit GIT_AUTHOR_* / GIT_COMMITTER_* env vars, local
|
||||
// config, and global config. A partial identity, with only a name or only
|
||||
// an email, does not pass this check. If either identity is missing,
|
||||
// configure our default bot user as a fallback.
|
||||
const authorIdentity = await getExecOutput(
|
||||
"git",
|
||||
["-c", "user.useConfigOnly=true", "var", "GIT_AUTHOR_IDENT"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
const committerIdentity = await getExecOutput(
|
||||
"git",
|
||||
["-c", "user.useConfigOnly=true", "var", "GIT_COMMITTER_IDENT"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
if (authorIdentity.exitCode === 0 && committerIdentity.exitCode === 0) {
|
||||
async setupUser() {
|
||||
if (this.commitMode === "github-api") {
|
||||
return;
|
||||
}
|
||||
core.info("Setting git user to github-actions[bot]");
|
||||
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
|
||||
cwd: this.cwd,
|
||||
});
|
||||
@@ -213,36 +114,38 @@ export class GitHub {
|
||||
}
|
||||
|
||||
async pushTag(tag: string) {
|
||||
try {
|
||||
if (!this.pushWithGitCli) {
|
||||
await this.octokit.rest.git.createRef({
|
||||
if (this.commitMode === "github-api") {
|
||||
return this.octokit.rest.git
|
||||
.createRef({
|
||||
...context.repo,
|
||||
ref: `refs/tags/${tag}`,
|
||||
sha: context.sha,
|
||||
})
|
||||
.catch((err) => {
|
||||
// Assuming tag was manually pushed in custom publish script
|
||||
core.warning(`Failed to create tag ${tag}: ${err.message}`);
|
||||
});
|
||||
} else {
|
||||
await exec("git", ["push", "origin", tag], {
|
||||
cwd: this.cwd,
|
||||
env: {
|
||||
...process.env,
|
||||
...(await this.#getCliAuthEnv()),
|
||||
} as Record<string, string>,
|
||||
});
|
||||
}
|
||||
} catch (err) {
|
||||
core.warning(
|
||||
`Failed to create git tag "${tag}". Assuming it was manually pushed by the publish script: ${(err as Error).message}`,
|
||||
);
|
||||
}
|
||||
await exec("git", ["push", "origin", tag], {
|
||||
cwd: this.cwd,
|
||||
env: {
|
||||
...process.env,
|
||||
...this.#getCliAuthEnv(),
|
||||
} as Record<string, string>,
|
||||
});
|
||||
}
|
||||
|
||||
async prepareBranch(branch: string) {
|
||||
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(context.sha, { cwd: this.cwd });
|
||||
}
|
||||
|
||||
async pushChanges({ branch, message }: { branch: string; message: string }) {
|
||||
if (!this.pushWithGitCli) {
|
||||
if (this.commitMode === "github-api") {
|
||||
await commitChangesSinceBase({
|
||||
octokit: this.octokit,
|
||||
...context.repo,
|
||||
@@ -251,20 +154,18 @@ export class GitHub {
|
||||
base: {
|
||||
commit: context.sha,
|
||||
},
|
||||
force: true,
|
||||
cwd: this.cwd,
|
||||
});
|
||||
return;
|
||||
}
|
||||
if (!(await checkIfClean({ cwd: this.cwd }))) {
|
||||
await this.ensureGitUser();
|
||||
await commitAll(message, { cwd: this.cwd });
|
||||
}
|
||||
await push(branch, {
|
||||
cwd: this.cwd,
|
||||
env: {
|
||||
...process.env,
|
||||
...(await this.#getCliAuthEnv()),
|
||||
...this.#getCliAuthEnv(),
|
||||
} as Record<string, string>,
|
||||
});
|
||||
}
|
||||
|
||||
+83
-17
@@ -1,35 +1,33 @@
|
||||
import fs from "node:fs/promises";
|
||||
import * as core from "@actions/core";
|
||||
import { GitHub } from "./github.ts";
|
||||
import readChangesetState from "./readChangesetState.ts";
|
||||
import { runPublish, runVersion } from "./run.ts";
|
||||
import { uploadStagedRelease } from "./staged-release.ts";
|
||||
import {
|
||||
fileExists,
|
||||
getOptionalInput,
|
||||
getRequiredInput,
|
||||
throwOnRemovedCommitModeInput,
|
||||
throwOnRenamedInputs,
|
||||
validateChangesetsCliVersion,
|
||||
} from "./utils.ts";
|
||||
|
||||
try {
|
||||
await main();
|
||||
} catch (err) {
|
||||
core.setFailed((err as Error).message);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = getOptionalInput("cwd") || process.cwd();
|
||||
(async () => {
|
||||
// If the user needs to change the cwd, set `working-directory` in the step instead
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
throwOnRenamedInputs({
|
||||
publish: "publish-script",
|
||||
version: "version-script",
|
||||
commit: "commit-message",
|
||||
commit: "commit-mesage",
|
||||
title: "pr-title",
|
||||
branch: "pr-base-branch",
|
||||
prDraft: "pr-draft",
|
||||
createGithubReleases: "create-github-releases",
|
||||
commitMode: "commit-mode",
|
||||
setupGitUser: "setup-git-user",
|
||||
});
|
||||
throwOnRemovedCommitModeInput();
|
||||
|
||||
const githubToken = getRequiredInput("github-token");
|
||||
if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) {
|
||||
@@ -40,8 +38,12 @@ async function main() {
|
||||
);
|
||||
}
|
||||
|
||||
const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
|
||||
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 pr-draft: ${prDraft}`);
|
||||
return;
|
||||
@@ -49,9 +51,16 @@ async function main() {
|
||||
const github = new GitHub({
|
||||
cwd,
|
||||
githubToken,
|
||||
pushWithGitCli,
|
||||
commitMode,
|
||||
});
|
||||
|
||||
let setupGitUser = core.getBooleanInput("setup-git-user");
|
||||
|
||||
if (setupGitUser) {
|
||||
core.info("setting git user");
|
||||
await github.setupUser();
|
||||
}
|
||||
|
||||
let { changesets } = await readChangesetState(cwd);
|
||||
|
||||
let publishScript = core.getInput("publish-script");
|
||||
@@ -68,7 +77,7 @@ async function main() {
|
||||
switch (true) {
|
||||
case !hasChangesets && !hasPublishScript:
|
||||
core.info(
|
||||
"No changesets present or were removed by merging version PR. Not publishing because publish-script is not set.",
|
||||
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
|
||||
);
|
||||
return;
|
||||
case !hasChangesets && hasPublishScript: {
|
||||
@@ -76,6 +85,51 @@ async function main() {
|
||||
"No changesets found. Attempting to publish any unpublished packages to npm",
|
||||
);
|
||||
|
||||
if (process.env.NPM_TOKEN) {
|
||||
const userNpmrcPath = `${process.env.HOME}/.npmrc`;
|
||||
|
||||
if (await fileExists(userNpmrcPath)) {
|
||||
core.info("Found existing user .npmrc file");
|
||||
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
|
||||
const authLine = userNpmrcContent.split("\n").find((line) => {
|
||||
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
|
||||
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
|
||||
});
|
||||
if (authLine) {
|
||||
core.info(
|
||||
"Found existing auth token for the npm registry in the user .npmrc file",
|
||||
);
|
||||
} else {
|
||||
core.info(
|
||||
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one",
|
||||
);
|
||||
await fs.appendFile(
|
||||
userNpmrcPath,
|
||||
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
core.info(
|
||||
"No user .npmrc file found, creating one with NPM_TOKEN used as auth token",
|
||||
);
|
||||
await fs.writeFile(
|
||||
userNpmrcPath,
|
||||
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`,
|
||||
);
|
||||
}
|
||||
} else if (
|
||||
process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN &&
|
||||
process.env.ACTIONS_ID_TOKEN_REQUEST_URL
|
||||
) {
|
||||
core.info(
|
||||
"No NPM_TOKEN found, but OIDC is available - using npm trusted publishing",
|
||||
);
|
||||
} else {
|
||||
core.info(
|
||||
"No NPM_TOKEN or OIDC available - assuming npm is already authenticated",
|
||||
);
|
||||
}
|
||||
|
||||
const createGithubReleases = core.getBooleanInput(
|
||||
"create-github-releases",
|
||||
);
|
||||
@@ -95,6 +149,14 @@ async function main() {
|
||||
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(
|
||||
@@ -104,7 +166,7 @@ async function main() {
|
||||
}
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
throw new Error(
|
||||
core.error(
|
||||
`Publish command exited with code ${result.exitCode}${
|
||||
result.published
|
||||
? `, but some packages were published: ${result.publishedPackages
|
||||
@@ -113,11 +175,12 @@ async function main() {
|
||||
: ""
|
||||
}`,
|
||||
);
|
||||
process.exit(result.exitCode);
|
||||
}
|
||||
return;
|
||||
}
|
||||
case hasChangesets && !hasNonEmptyChangesets:
|
||||
core.info("All changesets are empty. Not creating PR");
|
||||
core.info("All changesets are empty; not creating PR");
|
||||
return;
|
||||
case hasChangesets: {
|
||||
const { pullRequestNumber } = await runVersion({
|
||||
@@ -136,4 +199,7 @@ async function main() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
})().catch((err) => {
|
||||
core.error(err);
|
||||
core.setFailed(err.message);
|
||||
});
|
||||
|
||||
+2
-1
@@ -17,7 +17,8 @@ try {
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = getOptionalInput("cwd") || process.cwd();
|
||||
// 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");
|
||||
|
||||
@@ -53,7 +53,7 @@ Latest commit: ${commitSha}
|
||||
|
||||
${getReleasePlanMessage(releasePlan)}
|
||||
|
||||
Not sure what this means? [Click here to learn what changesets are](https://changesets.dev/faq).
|
||||
Not sure what this means? [Click here to learn what changesets are](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
|
||||
|
||||
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`;
|
||||
}
|
||||
@@ -72,7 +72,7 @@ Merging this PR will not cause a version bump for any packages. If these changes
|
||||
|
||||
${getReleasePlanMessage(releasePlan)}
|
||||
|
||||
[Click here to learn what changesets are, and how to add one](https://changesets.dev/faq).
|
||||
[Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
|
||||
|
||||
[Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
|
||||
}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import { pathToFileURL } from "node:url";
|
||||
import type * as github from "@actions/github";
|
||||
import { getReleasePlan } from "@changesets/get-release-plan";
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { exec } from "tinyexec";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { gitdir, shallowClone, testdir } from "../test-utils.ts";
|
||||
import { getPullRequestWorktree } from "./worktree.ts";
|
||||
|
||||
type PullRequestContext = NonNullable<
|
||||
@@ -21,7 +21,7 @@ async function git(cwd: string, args: string[]) {
|
||||
describe("getPullRequestWorktree", () => {
|
||||
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
|
||||
// Local source repo
|
||||
await using sourceRepoFixture = await gitdir({
|
||||
await using sourceRepoFixture = await createFixture({
|
||||
".changeset/config.json": JSON.stringify({}),
|
||||
"package.json": JSON.stringify({
|
||||
name: "repo",
|
||||
@@ -35,33 +35,46 @@ describe("getPullRequestWorktree", () => {
|
||||
}),
|
||||
});
|
||||
const sourceRepo = sourceRepoFixture.path;
|
||||
await git(sourceRepo, ["init", "-b", "main"]);
|
||||
await git(sourceRepo, ["config", "user.name", "Test User"]);
|
||||
await git(sourceRepo, ["config", "user.email", "test@example.com"]);
|
||||
await git(sourceRepo, ["add", "."]);
|
||||
await git(sourceRepo, ["commit", "-m", "base"]);
|
||||
|
||||
// Simulate remote bare git server
|
||||
await using originBareFixture = await testdir();
|
||||
await using originBareFixture = await createFixture();
|
||||
const originBare = originBareFixture.path;
|
||||
await git(originBare, [
|
||||
"clone",
|
||||
"--bare",
|
||||
pathToFileURL(sourceRepo).toString(),
|
||||
".",
|
||||
]);
|
||||
await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
|
||||
|
||||
// Simulate checkout PR in github action
|
||||
await using checkoutRepoFixture = await shallowClone(originBare);
|
||||
await using checkoutRepoFixture = await createFixture();
|
||||
const checkoutRepo = checkoutRepoFixture.path;
|
||||
|
||||
// Simulate remote fork bare git server
|
||||
await using forkBareFixture = await testdir();
|
||||
const forkBare = forkBareFixture.path;
|
||||
await git(forkBare, [
|
||||
await git(checkoutRepo, [
|
||||
"clone",
|
||||
"--bare",
|
||||
"--depth",
|
||||
"1",
|
||||
"--branch",
|
||||
"main",
|
||||
pathToFileURL(originBare).toString(),
|
||||
".",
|
||||
checkoutRepo,
|
||||
]);
|
||||
|
||||
await using forkRepoFixture = await shallowClone(forkBare);
|
||||
// Simulate remote fork bare git server
|
||||
await using forkBareFixture = await createFixture();
|
||||
const forkBare = forkBareFixture.path;
|
||||
await git(forkBare, ["clone", "--bare", originBare, forkBare]);
|
||||
|
||||
await using forkRepoFixture = await createFixture();
|
||||
const forkRepo = forkRepoFixture.path;
|
||||
await git(forkRepo, [
|
||||
"clone",
|
||||
"--depth",
|
||||
"1",
|
||||
"--branch",
|
||||
"main",
|
||||
pathToFileURL(forkBare).toString(),
|
||||
forkRepo,
|
||||
]);
|
||||
await git(forkRepo, ["config", "user.name", "Test User"]);
|
||||
await git(forkRepo, ["config", "user.email", "test@example.com"]);
|
||||
await git(forkRepo, ["checkout", "-b", "feature"]);
|
||||
|
||||
@@ -5,7 +5,6 @@ import path from "node:path";
|
||||
import type * as github from "@actions/github";
|
||||
import { isRepoShallow } from "@changesets/git";
|
||||
import { exec } from "tinyexec";
|
||||
import { moveDisposable, type WithAsyncDispose } from "../utils.ts";
|
||||
|
||||
type PullRequestContext = NonNullable<
|
||||
typeof github.context.payload.pull_request
|
||||
@@ -123,6 +122,22 @@ async function tempWorktree(cwd: string, dir: string, ref: Ref) {
|
||||
};
|
||||
}
|
||||
|
||||
type WithAsyncDispose<T> = T & {
|
||||
[Symbol.asyncDispose](): Promise<void>;
|
||||
};
|
||||
|
||||
function moveDisposable<T extends object>(
|
||||
stack: AsyncDisposableStack,
|
||||
value: T,
|
||||
): WithAsyncDispose<T> {
|
||||
const moved = stack.move();
|
||||
return Object.assign(value, {
|
||||
async [Symbol.asyncDispose]() {
|
||||
await moved.disposeAsync();
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export async function getPullRequestWorktree(
|
||||
context: PullRequestContext,
|
||||
cwd: string = process.cwd(),
|
||||
|
||||
+19
-3
@@ -3,12 +3,15 @@ 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();
|
||||
@@ -17,15 +20,19 @@ try {
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = getOptionalInput("cwd") || process.cwd();
|
||||
// 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. " +
|
||||
@@ -34,8 +41,8 @@ async function main() {
|
||||
);
|
||||
}
|
||||
|
||||
// The publish sub-action always uses the GitHub API for tag pushes.
|
||||
const github = new GitHub({ cwd, githubToken });
|
||||
// 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(
|
||||
@@ -47,6 +54,7 @@ async function main() {
|
||||
|
||||
const result = await runPublish({
|
||||
script,
|
||||
stage,
|
||||
github,
|
||||
createGithubReleases,
|
||||
pushGitTags,
|
||||
@@ -54,6 +62,14 @@ async function main() {
|
||||
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(
|
||||
|
||||
@@ -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();
|
||||
});
|
||||
});
|
||||
@@ -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,40 +0,0 @@
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import readChangesetState from "./readChangesetState.ts";
|
||||
|
||||
const changeset = `---
|
||||
"pkg-a": patch
|
||||
---
|
||||
|
||||
Fix a bug.
|
||||
`;
|
||||
|
||||
describe("readChangesetState", () => {
|
||||
it("filters versioned changesets in prerelease mode", async () => {
|
||||
await using fixture = await createFixture({
|
||||
".changeset/pre.json": JSON.stringify({ mode: "pre", tag: "next" }),
|
||||
".changeset/pre/versioned.md": changeset,
|
||||
".changeset/pending.md": changeset,
|
||||
});
|
||||
|
||||
const state = await readChangesetState(fixture.path);
|
||||
|
||||
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
|
||||
"pending",
|
||||
]);
|
||||
});
|
||||
|
||||
it("includes versioned changesets when exiting prerelease mode", async () => {
|
||||
await using fixture = await createFixture({
|
||||
".changeset/pre.json": JSON.stringify({ mode: "exit", tag: "next" }),
|
||||
".changeset/pre/versioned.md": changeset,
|
||||
});
|
||||
|
||||
const state = await readChangesetState(fixture.path);
|
||||
|
||||
expect(state.preState).toBeUndefined();
|
||||
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
|
||||
"pre/versioned",
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -14,11 +14,11 @@ export default async function readChangesetState(
|
||||
let changesets = await readChangesets(cwd);
|
||||
|
||||
if (preState !== undefined && preState.mode === "pre") {
|
||||
let changesetsToFilter = new Set(preState.changesets);
|
||||
|
||||
return {
|
||||
preState,
|
||||
changesets: changesets.filter(
|
||||
(changeset) => !changeset.id.startsWith("pre/"),
|
||||
),
|
||||
changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
+105
-37
@@ -1,13 +1,11 @@
|
||||
import path from "node:path";
|
||||
import * as core from "@actions/core";
|
||||
import * as github from "@actions/github";
|
||||
import type { Changeset } from "@changesets/types";
|
||||
import { writeChangeset } from "@changesets/write";
|
||||
import { exec } from "tinyexec";
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { GitHub } from "./github.ts";
|
||||
import { runPublish, runVersion } from "./run.ts";
|
||||
import { gitdir } from "./test-utils.ts";
|
||||
import { readChangesetsOutput, runPublish, runVersion } from "./run.ts";
|
||||
|
||||
vi.mock("@actions/github", () => ({
|
||||
context: {
|
||||
@@ -23,12 +21,8 @@ vi.mock("@actions/github", () => ({
|
||||
graphql: mockedGraphql,
|
||||
}),
|
||||
}));
|
||||
vi.mock("@actions/core", async (importOriginal) => ({
|
||||
...(await importOriginal<typeof import("@actions/core")>()),
|
||||
error: vi.fn(),
|
||||
notice: vi.fn(),
|
||||
warning: vi.fn(),
|
||||
}));
|
||||
vi.mock("@actions/core", { spy: true });
|
||||
const mockedWarning = vi.mocked(core.warning);
|
||||
vi.mock("@changesets/ghcommit");
|
||||
|
||||
let mockedGithubMethods = {
|
||||
@@ -45,7 +39,7 @@ let mockedGraphql = vi.fn();
|
||||
const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules");
|
||||
|
||||
function createSimpleProjectFixture() {
|
||||
return gitdir({
|
||||
return createFixture({
|
||||
node_modules: (api) => api.symlink(nodeModulesDir),
|
||||
".changeset/config.json": JSON.stringify({}),
|
||||
"packages/pkg-a/package.json": JSON.stringify({
|
||||
@@ -70,7 +64,7 @@ function createSimpleProjectFixture() {
|
||||
}
|
||||
|
||||
function createIgnoredPackageFixture() {
|
||||
return gitdir({
|
||||
return createFixture({
|
||||
node_modules: (api) => api.symlink(nodeModulesDir),
|
||||
".changeset/config.json": JSON.stringify({
|
||||
ignore: ["changesets-dev-ignored-package-pkg-a"],
|
||||
@@ -104,23 +98,11 @@ const createGithub = (cwd: string) =>
|
||||
new GitHub({
|
||||
cwd,
|
||||
githubToken: "@@GITHUB_TOKEN",
|
||||
pushWithGitCli: false,
|
||||
commitMode: "github-api",
|
||||
});
|
||||
|
||||
async function updateGithubContext(cwd: string) {
|
||||
const head = await exec("git", ["rev-parse", "HEAD"], {
|
||||
nodeOptions: { cwd },
|
||||
});
|
||||
github.context.sha = head.stdout.trim();
|
||||
}
|
||||
|
||||
function resetGithubContext() {
|
||||
github.context.sha = "xeac7";
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
resetGithubContext();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
@@ -128,10 +110,105 @@ afterEach(() => {
|
||||
});
|
||||
|
||||
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;
|
||||
await updateGithubContext(cwd);
|
||||
vi.stubEnv("RUNNER_TEMP", cwd);
|
||||
|
||||
const result = await runPublish({
|
||||
@@ -143,7 +220,7 @@ describe("publish", () => {
|
||||
});
|
||||
|
||||
expect(result).toEqual({ published: false, exitCode: 0 });
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect(mockedWarning).toHaveBeenCalledWith(
|
||||
expect.stringContaining(
|
||||
"GitHub releases and git tags cannot be created without this output",
|
||||
),
|
||||
@@ -151,7 +228,7 @@ describe("publish", () => {
|
||||
});
|
||||
|
||||
it("throws when the built-in publish command does not create the output file", async () => {
|
||||
await using fixture = await gitdir({
|
||||
await using fixture = await createFixture({
|
||||
"node_modules/@changesets/cli/package.json": JSON.stringify({
|
||||
name: "@changesets/cli",
|
||||
type: "module",
|
||||
@@ -164,7 +241,6 @@ describe("publish", () => {
|
||||
"package-lock.json": "",
|
||||
});
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
vi.stubEnv("RUNNER_TEMP", cwd);
|
||||
|
||||
await expect(
|
||||
@@ -182,7 +258,6 @@ describe("version", () => {
|
||||
it("creates simple PR", async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -220,7 +295,6 @@ describe("version", () => {
|
||||
it('creates a draft PR when prDraft is "create"', async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -255,7 +329,6 @@ describe("version", () => {
|
||||
it("only includes bumped packages in the PR body", async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -289,7 +362,6 @@ describe("version", () => {
|
||||
it("doesn't include ignored package that got a dependency update in the PR body", async () => {
|
||||
await using fixture = await createIgnoredPackageFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -323,7 +395,6 @@ describe("version", () => {
|
||||
it("does not include changelog entries if full message exceeds size limit", async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -381,7 +452,6 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -439,7 +509,6 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
it('updates an existing PR via GraphQL without converting it to draft when prDraft is "create"', async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
|
||||
data: [{ number: 123, node_id: "PR_kwDOA" }],
|
||||
@@ -472,7 +541,6 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await updateGithubContext(cwd);
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
|
||||
data: [{ number: 123, node_id: "PR_kwDOA" }],
|
||||
|
||||
+79
-30
@@ -31,7 +31,7 @@ import {
|
||||
// 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 },
|
||||
) => {
|
||||
@@ -66,6 +66,7 @@ const createRelease = async (
|
||||
type PublishOptions = {
|
||||
script?: string;
|
||||
fromPackDir?: string;
|
||||
stage?: boolean;
|
||||
createGithubReleases: boolean;
|
||||
pushGitTags: boolean;
|
||||
github: GitHub;
|
||||
@@ -73,11 +74,25 @@ type PublishOptions = {
|
||||
};
|
||||
|
||||
type PublishedPackage = { name: string; version: string };
|
||||
type ChangesetsOutputEvent = {
|
||||
type: "git-tag";
|
||||
tag: string;
|
||||
packageName: 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 {}
|
||||
|
||||
@@ -85,10 +100,12 @@ type PublishResult =
|
||||
| {
|
||||
published: true;
|
||||
publishedPackages: PublishedPackage[];
|
||||
stagedPackages?: NpmStageEvent[];
|
||||
exitCode: number;
|
||||
}
|
||||
| {
|
||||
published: false;
|
||||
stagedPackages?: NpmStageEvent[];
|
||||
exitCode: number;
|
||||
};
|
||||
|
||||
@@ -99,18 +116,32 @@ function isObject(value: unknown) {
|
||||
function isChangesetsOutputEvent(
|
||||
value: unknown,
|
||||
): value is ChangesetsOutputEvent {
|
||||
return (
|
||||
isObject(value) &&
|
||||
"type" in value &&
|
||||
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"
|
||||
);
|
||||
}
|
||||
|
||||
async function readChangesetsOutput(outputPath: string) {
|
||||
export async function readChangesetsOutput(outputPath: string) {
|
||||
let rawOutput: string;
|
||||
try {
|
||||
rawOutput = await fs.readFile(outputPath, "utf8");
|
||||
@@ -158,16 +189,13 @@ async function readChangesetsOutput(outputPath: string) {
|
||||
export async function runPublish({
|
||||
script,
|
||||
fromPackDir,
|
||||
stage,
|
||||
github,
|
||||
createGithubReleases,
|
||||
pushGitTags,
|
||||
cwd,
|
||||
}: PublishOptions): Promise<PublishResult> {
|
||||
const { octokit } = github;
|
||||
// Changesets creates annotated tags locally, including when the action pushes those tags through the GitHub API.
|
||||
// It might also be important for custom publish scripts to have a valid git user configured.
|
||||
await github.ensureGitUser();
|
||||
|
||||
let changesetPublishOutput: ExecOutput;
|
||||
const outputFile = path.join(
|
||||
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
|
||||
@@ -191,6 +219,9 @@ export async function runPublish({
|
||||
);
|
||||
} else {
|
||||
const args = ["publish"];
|
||||
if (stage !== undefined) {
|
||||
args.push(stage ? "--stage" : "--no-stage");
|
||||
}
|
||||
if (fromPackDir) {
|
||||
args.push("--from-pack-dir", fromPackDir);
|
||||
}
|
||||
@@ -200,8 +231,13 @@ export async function runPublish({
|
||||
);
|
||||
}
|
||||
|
||||
let { packages, tool } = await getPackages(cwd);
|
||||
let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x]));
|
||||
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);
|
||||
@@ -214,16 +250,24 @@ export async function runPublish({
|
||||
);
|
||||
output = [];
|
||||
}
|
||||
let releases = output.map((event) => {
|
||||
let pkg = packagesByName.get(event.packageName);
|
||||
if (pkg === undefined) {
|
||||
throw new Error(
|
||||
`Package "${event.packageName}" not found.` +
|
||||
"This is probably a bug in the action, please open an issue",
|
||||
);
|
||||
}
|
||||
return { pkg, tag: event.tag };
|
||||
});
|
||||
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 "${event.packageName}" not found.` +
|
||||
"This is probably a bug in the action, please open an issue",
|
||||
);
|
||||
}
|
||||
return { pkg, tag: event.tag };
|
||||
});
|
||||
|
||||
if (tool.type === "root" && packages.length === 0) {
|
||||
throw new Error(
|
||||
@@ -252,11 +296,16 @@ export async function runPublish({
|
||||
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,
|
||||
};
|
||||
}
|
||||
|
||||
type GetMessageOptions = {
|
||||
@@ -401,7 +450,7 @@ export async function runVersion({
|
||||
head: `${context.repo.owner}:${versionBranch}`,
|
||||
base: branch,
|
||||
});
|
||||
core.debug(
|
||||
core.info(
|
||||
`Existing pull requests: ${JSON.stringify(
|
||||
existingPullRequests.data,
|
||||
null,
|
||||
@@ -427,7 +476,7 @@ export async function runVersion({
|
||||
});
|
||||
|
||||
if (existingPullRequests.data.length === 0) {
|
||||
core.info("Creating pull request");
|
||||
core.info("creating pull request");
|
||||
const { data: newPullRequest } = await octokit.rest.pulls.create({
|
||||
base: branch,
|
||||
head: versionBranch,
|
||||
@@ -443,7 +492,7 @@ export async function runVersion({
|
||||
} else {
|
||||
const [pullRequest] = existingPullRequests.data;
|
||||
|
||||
core.info(`Updating found pull request #${pullRequest.number}`);
|
||||
core.info(`updating found pull request #${pullRequest.number}`);
|
||||
const convertPullRequestToDraftMutation =
|
||||
prDraft === "always"
|
||||
? `
|
||||
|
||||
@@ -4,11 +4,7 @@ import path from "node:path";
|
||||
import artifact from "@actions/artifact";
|
||||
import * as core from "@actions/core";
|
||||
import readChangesetState from "../readChangesetState.ts";
|
||||
import {
|
||||
execChangesetsCli,
|
||||
getOptionalInput,
|
||||
validateChangesetsCliVersion,
|
||||
} from "../utils.ts";
|
||||
import { execChangesetsCli, validateChangesetsCliVersion } from "../utils.ts";
|
||||
|
||||
type ModeResult =
|
||||
| {
|
||||
@@ -31,7 +27,7 @@ try {
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = getOptionalInput("cwd") || process.cwd();
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
const result = await getMode(cwd);
|
||||
|
||||
@@ -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");
|
||||
});
|
||||
});
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -1,293 +0,0 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { spawn } from "node:child_process";
|
||||
import fsp from "node:fs/promises";
|
||||
import http, { type IncomingMessage, type ServerResponse } from "node:http";
|
||||
import path from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
import { createFixture, type FileTree } from "fs-fixture";
|
||||
import { exec } from "tinyexec";
|
||||
import { moveDisposable } from "./utils.ts";
|
||||
|
||||
export type Fixture = FileTree;
|
||||
|
||||
export async function testdir(dir?: Fixture) {
|
||||
return createFixture(dir, {
|
||||
fs: {
|
||||
...fsp,
|
||||
rm: (filePath, options) =>
|
||||
fsp.rm(filePath, {
|
||||
maxRetries: 3,
|
||||
retryDelay: 100,
|
||||
...options,
|
||||
}),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Git maintenance can race with fixture cleanup by touching pack files.
|
||||
export async function disableGitBackgroundMaintenance(cwd: string) {
|
||||
await exec("git", ["config", "gc.auto", "0"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
await exec("git", ["config", "maintenance.auto", "false"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
}
|
||||
|
||||
export async function gitdir(dir: Fixture) {
|
||||
await using stack = new AsyncDisposableStack();
|
||||
const fixture = stack.use(
|
||||
await testdir({
|
||||
".gitattributes": "* text=auto eol=lf\n",
|
||||
...dir,
|
||||
}),
|
||||
);
|
||||
const cwd = fixture.path;
|
||||
|
||||
await exec("git", ["init"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
await disableGitBackgroundMaintenance(cwd);
|
||||
|
||||
const { stdout } = await exec("git", ["rev-parse", "--abbrev-ref", "HEAD"], {
|
||||
nodeOptions: { cwd },
|
||||
});
|
||||
if (stdout.trim() !== "main") {
|
||||
await exec("git", ["checkout", "-b", "main"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
}
|
||||
|
||||
const gitConfig = `
|
||||
[user]
|
||||
email = x@y.z
|
||||
name = xyz
|
||||
[commit]
|
||||
gpgSign = false
|
||||
[tag]
|
||||
gpgSign = false
|
||||
forceSignAnnotated = false
|
||||
`.trim();
|
||||
await fsp.appendFile(path.join(cwd, ".git/config"), gitConfig, "utf8");
|
||||
|
||||
await exec("git", ["add", "."], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
await exec("git", ["commit", "-m", "initial commit", "--allow-empty"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
|
||||
return moveDisposable(stack, fixture);
|
||||
}
|
||||
|
||||
export async function shallowClone(cwd: string, depth = 1) {
|
||||
await using stack = new AsyncDisposableStack();
|
||||
const fixture = stack.use(await testdir());
|
||||
await exec(
|
||||
"git",
|
||||
["clone", "--depth", depth.toString(), pathToFileURL(cwd).toString(), "."],
|
||||
{
|
||||
nodeOptions: { cwd: fixture.path },
|
||||
throwOnError: true,
|
||||
},
|
||||
);
|
||||
await disableGitBackgroundMaintenance(fixture.path);
|
||||
return moveDisposable(stack, fixture);
|
||||
}
|
||||
|
||||
async function runGitHttpBackend(
|
||||
cwd: string,
|
||||
request: IncomingMessage,
|
||||
response: ServerResponse,
|
||||
) {
|
||||
// `git http-backend` speaks CGI: request metadata goes through environment
|
||||
// variables, the request body through stdin, and the response through stdout.
|
||||
const requestUrl = new URL(
|
||||
request.url ?? "/",
|
||||
`http://${request.headers.host ?? "localhost"}`,
|
||||
);
|
||||
const env: NodeJS.ProcessEnv = {
|
||||
...process.env,
|
||||
CONTENT_LENGTH: request.headers["content-length"] ?? "0",
|
||||
GATEWAY_INTERFACE: "CGI/1.1",
|
||||
GIT_HTTP_EXPORT_ALL: "1",
|
||||
GIT_PROJECT_ROOT: cwd,
|
||||
PATH_INFO: decodeURIComponent(requestUrl.pathname),
|
||||
QUERY_STRING: requestUrl.search.slice(1),
|
||||
REMOTE_ADDR: request.socket.remoteAddress ?? "",
|
||||
REQUEST_METHOD: request.method ?? "GET",
|
||||
SERVER_PROTOCOL: `HTTP/${request.httpVersion}`,
|
||||
};
|
||||
if (request.headers["content-type"] !== undefined) {
|
||||
env.CONTENT_TYPE = request.headers["content-type"];
|
||||
}
|
||||
|
||||
const backend = spawn("git", ["http-backend"], {
|
||||
env,
|
||||
stdio: ["pipe", "pipe", "pipe"],
|
||||
});
|
||||
request.pipe(backend.stdin);
|
||||
|
||||
// Buffer stdout so the CGI headers can be separated from the response body.
|
||||
// Keep stderr only to explain a backend failure.
|
||||
const stdout: Buffer[] = [];
|
||||
const stderr: Buffer[] = [];
|
||||
backend.stdout.on("data", (chunk: Buffer) => stdout.push(chunk));
|
||||
backend.stderr.on("data", (chunk: Buffer) => stderr.push(chunk));
|
||||
|
||||
const exitCode = await new Promise<number | null>((resolve, reject) => {
|
||||
backend.on("error", reject);
|
||||
backend.on("close", resolve);
|
||||
});
|
||||
if (exitCode !== 0) {
|
||||
throw new Error(
|
||||
`git http-backend exited with ${exitCode}: ${Buffer.concat(stderr).toString("utf8")}`,
|
||||
);
|
||||
}
|
||||
|
||||
const output = Buffer.concat(stdout);
|
||||
// CGI ends its response headers with a blank line; accept CRLF and LF output.
|
||||
let separator = Buffer.from("\r\n\r\n");
|
||||
let headerEnd = output.indexOf(separator);
|
||||
if (headerEnd === -1) {
|
||||
separator = Buffer.from("\n\n");
|
||||
headerEnd = output.indexOf(separator);
|
||||
}
|
||||
if (headerEnd === -1) {
|
||||
throw new Error("git http-backend returned an invalid CGI response");
|
||||
}
|
||||
|
||||
// Translate CGI status and headers, then forward the remaining bytes as body.
|
||||
let status = 200;
|
||||
const headers = output.subarray(0, headerEnd).toString("utf8").split(/\r?\n/);
|
||||
for (const header of headers) {
|
||||
const separatorIndex = header.indexOf(":");
|
||||
if (separatorIndex === -1) continue;
|
||||
|
||||
const name = header.slice(0, separatorIndex);
|
||||
const value = header.slice(separatorIndex + 1).trim();
|
||||
if (name.toLowerCase() === "status") {
|
||||
status = Number.parseInt(value, 10);
|
||||
} else {
|
||||
response.setHeader(name, value);
|
||||
}
|
||||
}
|
||||
|
||||
response.writeHead(status);
|
||||
response.end(output.subarray(headerEnd + separator.length));
|
||||
}
|
||||
|
||||
async function listen(server: http.Server) {
|
||||
const waiter = Promise.withResolvers();
|
||||
|
||||
server.on("listening", waiter.resolve);
|
||||
server.on("error", waiter.reject);
|
||||
|
||||
server.listen(0);
|
||||
|
||||
try {
|
||||
await waiter.promise;
|
||||
return server;
|
||||
} finally {
|
||||
server.off("listening", waiter.resolve);
|
||||
server.off("error", waiter.reject);
|
||||
}
|
||||
}
|
||||
|
||||
type RecordedRequest = {
|
||||
method: string;
|
||||
url: string;
|
||||
headers: NodeJS.Dict<string[]>;
|
||||
};
|
||||
|
||||
function recordRequest(request: IncomingMessage): RecordedRequest {
|
||||
return {
|
||||
method: request.method ?? "GET",
|
||||
url: request.url ?? "/",
|
||||
headers: request.headersDistinct,
|
||||
};
|
||||
}
|
||||
|
||||
async function createGitHttpServer(cwd: string) {
|
||||
const requests: RecordedRequest[] = [];
|
||||
const server = http.createServer((request, response) => {
|
||||
const recordedRequest = recordRequest(request);
|
||||
requests.push(recordedRequest);
|
||||
|
||||
void runGitHttpBackend(cwd, request, response).catch((error: unknown) => {
|
||||
response.destroy(
|
||||
Error.isError(error)
|
||||
? error
|
||||
: new Error("Server error", { cause: error }),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
await listen(server);
|
||||
const address = server.address();
|
||||
assert(
|
||||
!!address && typeof address !== "string",
|
||||
"Failed to get server address",
|
||||
);
|
||||
|
||||
return {
|
||||
origin: `http://127.0.0.1:${address.port}`,
|
||||
requests,
|
||||
async [Symbol.asyncDispose]() {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
server.close((error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async function createLocalRemote(dir: Fixture) {
|
||||
await using stack = new AsyncDisposableStack();
|
||||
const fixture = stack.use(await testdir());
|
||||
const remote = fixture.path;
|
||||
{
|
||||
// Use a working repository to create the bare remote's initial history.
|
||||
// Once cloned, the remote owns that history and the source can be disposed.
|
||||
await using sourceFixture = await gitdir(dir);
|
||||
await exec(
|
||||
"git",
|
||||
["clone", "--bare", pathToFileURL(sourceFixture.path).toString(), "."],
|
||||
{
|
||||
nodeOptions: { cwd: remote },
|
||||
throwOnError: true,
|
||||
},
|
||||
);
|
||||
}
|
||||
await disableGitBackgroundMaintenance(remote);
|
||||
await exec("git", ["config", "http.receivepack", "true"], {
|
||||
nodeOptions: { cwd: remote },
|
||||
throwOnError: true,
|
||||
});
|
||||
return moveDisposable(stack, fixture);
|
||||
}
|
||||
|
||||
export async function createGitHttpRemote(files: Fixture) {
|
||||
await using stack = new AsyncDisposableStack();
|
||||
const fixture = stack.use(await createLocalRemote(files));
|
||||
const server = stack.use(
|
||||
await createGitHttpServer(path.dirname(fixture.path)),
|
||||
);
|
||||
|
||||
return moveDisposable(stack, {
|
||||
path: fixture.path,
|
||||
url: `${server.origin}/${path.basename(fixture.path)}`,
|
||||
requests: server.requests,
|
||||
});
|
||||
}
|
||||
+1
-19
@@ -1,10 +1,9 @@
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { afterEach, expect, test, vi } from "vitest";
|
||||
import { expect, test } from "vitest";
|
||||
import {
|
||||
BumpLevels,
|
||||
getChangelogEntry,
|
||||
sortTheThings,
|
||||
throwOnRemovedCommitModeInput,
|
||||
validateChangesetsCliVersion,
|
||||
} from "./utils.ts";
|
||||
|
||||
@@ -75,10 +74,6 @@ let changelog = `# @keystone-alpha/email
|
||||
- Update mjml-dependency
|
||||
`;
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
test("it works", () => {
|
||||
let entry = getChangelogEntry(changelog, "3.0.0");
|
||||
expect(entry.content).toMatchSnapshot();
|
||||
@@ -112,19 +107,6 @@ test("it sorts the things right", () => {
|
||||
expect(things.sort(sortTheThings)).toMatchSnapshot();
|
||||
});
|
||||
|
||||
test.each([
|
||||
["commit-mode", "git-cli", "push-with-git-cli: true"],
|
||||
["commit-mode", "github-api", "push-with-git-cli: false"],
|
||||
["commitMode", "git-cli", "push-with-git-cli: true"],
|
||||
["commitMode", "github-api", "push-with-git-cli: false"],
|
||||
])(
|
||||
"explains how to migrate the removed %s input from %s",
|
||||
(inputName, value, replacement) => {
|
||||
vi.stubEnv(`INPUT_${inputName.toUpperCase()}`, value);
|
||||
expect(() => throwOnRemovedCommitModeInput()).toThrow(replacement);
|
||||
},
|
||||
);
|
||||
|
||||
test("throws when the project declares Changesets CLI v2", async () => {
|
||||
await using fixture = await createFixture({
|
||||
"package.json": JSON.stringify({
|
||||
|
||||
+13
-29
@@ -119,20 +119,11 @@ export function isErrorWithCode(err: unknown, code: string) {
|
||||
);
|
||||
}
|
||||
|
||||
export type WithAsyncDispose<T> = T & {
|
||||
[Symbol.asyncDispose](): Promise<void>;
|
||||
};
|
||||
|
||||
export function moveDisposable<T extends object>(
|
||||
stack: AsyncDisposableStack,
|
||||
value: T,
|
||||
): WithAsyncDispose<T> {
|
||||
const moved = stack.move();
|
||||
return Object.assign(value, {
|
||||
async [Symbol.asyncDispose]() {
|
||||
await moved.disposeAsync();
|
||||
},
|
||||
});
|
||||
export function fileExists(filePath: string) {
|
||||
return fs.access(filePath, fs.constants.F_OK).then(
|
||||
() => true,
|
||||
() => false,
|
||||
);
|
||||
}
|
||||
|
||||
export function getOptionalInput(name: string) {
|
||||
@@ -146,21 +137,14 @@ export function getRequiredInput(name: string) {
|
||||
return core.getInput(name, { required: true });
|
||||
}
|
||||
|
||||
export function throwOnRemovedCommitModeInput() {
|
||||
for (const inputName of ["commit-mode", "commitMode"]) {
|
||||
const value = getOptionalInput(inputName);
|
||||
if (value === undefined) continue;
|
||||
|
||||
const migration =
|
||||
value === "git-cli"
|
||||
? 'Replace it with "push-with-git-cli: true".'
|
||||
: value === "github-api"
|
||||
? 'Remove it or replace it with "push-with-git-cli: false"; GitHub API pushes are now the default.'
|
||||
: 'Set "push-with-git-cli" to true for Git CLI pushes or false for GitHub API pushes.';
|
||||
throw new Error(
|
||||
`The "${inputName}" input has been replaced by the boolean "push-with-git-cli" input. ${migration}`,
|
||||
);
|
||||
}
|
||||
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>) {
|
||||
|
||||
+14
-5
@@ -4,7 +4,6 @@ import { runVersion } from "../run.ts";
|
||||
import {
|
||||
getOptionalInput,
|
||||
getRequiredInput,
|
||||
throwOnRemovedCommitModeInput,
|
||||
validateChangesetsCliVersion,
|
||||
} from "../utils.ts";
|
||||
|
||||
@@ -15,9 +14,9 @@ try {
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = getOptionalInput("cwd") || process.cwd();
|
||||
// If the user needs to change the cwd, set `working-directory` in the step instead
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
throwOnRemovedCommitModeInput();
|
||||
|
||||
const githubToken = getRequiredInput("github-token");
|
||||
const script = getOptionalInput("script");
|
||||
@@ -25,18 +24,28 @@ async function main() {
|
||||
const prTitle = getRequiredInput("pr-title");
|
||||
const prDraft = getOptionalInput("pr-draft");
|
||||
const prBaseBranch = getOptionalInput("pr-base-branch");
|
||||
const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
|
||||
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,
|
||||
pushWithGitCli,
|
||||
commitMode,
|
||||
});
|
||||
|
||||
if (setupGitUser) {
|
||||
core.info("setting git user");
|
||||
await github.setupUser();
|
||||
}
|
||||
|
||||
const { pullRequestNumber } = await runVersion({
|
||||
script,
|
||||
github,
|
||||
|
||||
+1
-41
@@ -1,43 +1,3 @@
|
||||
# changesets/action/version
|
||||
|
||||
This action versions packages and creates or updates a pull request with the changes.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]:
|
||||
- `contents: write`: to commit version changes
|
||||
- `pull-requests: write`: to create pull request
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
> [!NOTE]
|
||||
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `script` | The command to use to version packages |
|
||||
| `commit-message` | The commit message. Default to `Version Packages` |
|
||||
| `pr-title` | The pull request title. Default to `Version Packages` |
|
||||
| `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. |
|
||||
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
|
||||
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits. Defaults to `false`. When using the GitHub API, commits are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
|
||||
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
||||
|
||||
| Outputs | Description |
|
||||
| ----------- | --------------------------------------------------- |
|
||||
| `pr-number` | The pull request number that was created or updated |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
TODO
|
||||
|
||||
+10
-10
@@ -5,9 +5,7 @@ runs:
|
||||
main: ../dist/version.js
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
script:
|
||||
@@ -27,16 +25,18 @@ inputs:
|
||||
pr-base-branch:
|
||||
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
|
||||
required: false
|
||||
push-with-git-cli:
|
||||
commit-mode:
|
||||
description: >
|
||||
Whether to use the Git CLI instead of the GitHub API to push release commits.
|
||||
Defaults to `false`. When using the GitHub API, commits are signed using GitHub's
|
||||
GPG key and attributed to the user or app that owns the `github-token`.
|
||||
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: false
|
||||
cwd:
|
||||
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user