Compare commits

..
32 Commits
Author SHA1 Message Date
changeset-internal-publish-bot[bot] ae32849d5b v2.1.2 2026-09-07 11:58:07 +00:00
changesets-org-version-bot[bot] 0138f456ec Version Packages (#726)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-09-07 11:50:58 +00:00
Bjorn Lu 88338839e3 Handle error when pushing git tags with the git CLI (#735)
* Handle error when pushing git tags with the git CLI

* Update message
2026-09-07 11:45:47 +00:00
Bjorn Lu e08fde7435 Improve log messages (#730) 2026-09-04 18:07:20 +00:00
dependabot[bot] 371fd77b45 Bump human-id in the production-dependencies group across 1 directory (#732)
Bumps the production-dependencies group with 1 update in the / directory: [human-id](https://github.com/RienNeVaPlus/human-id).


Updates `human-id` from 4.2.0 to 4.2.1
- [Commits](https://github.com/RienNeVaPlus/human-id/commits)

---
updated-dependencies:
- dependency-name: human-id
  dependency-version: 4.2.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: production-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-01 06:34:13 +00:00
dependabot[bot] 85efcafd80 Bump actions/checkout in the github-actions group across 1 directory (#734)
Bumps the github-actions group with 1 update in the / directory: [actions/checkout](https://github.com/actions/checkout).


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

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 7.0.1
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-01 06:18:01 +00:00
dependabot[bot] 5bb9d5ccac Bump the development-dependencies group across 1 directory with 7 updates (#733)
Bumps the development-dependencies group with 7 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [@changesets/cli](https://github.com/changesets/changesets/tree/HEAD/packages/cli) | `3.0.0` | `3.0.1` |
| [@changesets/write](https://github.com/changesets/changesets/tree/HEAD/packages/write) | `1.0.0` | `1.0.1` |
| [@tsconfig/node24](https://github.com/tsconfig/bases/tree/HEAD/bases) | `24.0.4` | `24.0.5` |
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) | `26.1.2` | `26.3.0` |
| [oxfmt](https://github.com/oxc-project/oxc/tree/HEAD/npm/oxfmt) | `0.61.0` | `0.65.0` |
| [rolldown](https://github.com/rolldown/rolldown/tree/HEAD/packages/rolldown) | `1.2.2` | `1.2.5` |
| [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) | `4.1.10` | `4.1.11` |



Updates `@changesets/cli` from 3.0.0 to 3.0.1
- [Release notes](https://github.com/changesets/changesets/releases)
- [Changelog](https://github.com/changesets/changesets/blob/main/packages/cli/CHANGELOG.md)
- [Commits](https://github.com/changesets/changesets/commits/@changesets/cli@3.0.1/packages/cli)

Updates `@changesets/write` from 1.0.0 to 1.0.1
- [Release notes](https://github.com/changesets/changesets/releases)
- [Changelog](https://github.com/changesets/changesets/blob/main/packages/write/CHANGELOG.md)
- [Commits](https://github.com/changesets/changesets/commits/@changesets/write@1.0.1/packages/write)

Updates `@tsconfig/node24` from 24.0.4 to 24.0.5
- [Commits](https://github.com/tsconfig/bases/commits/HEAD/bases)

Updates `@types/node` from 26.1.2 to 26.3.0
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Updates `oxfmt` from 0.61.0 to 0.65.0
- [Release notes](https://github.com/oxc-project/oxc/releases)
- [Changelog](https://github.com/oxc-project/oxc/blob/main/npm/oxfmt/CHANGELOG.md)
- [Commits](https://github.com/oxc-project/oxc/commits/oxfmt_v0.65.0/npm/oxfmt)

Updates `rolldown` from 1.2.2 to 1.2.5
- [Release notes](https://github.com/rolldown/rolldown/releases)
- [Changelog](https://github.com/rolldown/rolldown/blob/main/CHANGELOG.md)
- [Commits](https://github.com/rolldown/rolldown/commits/v1.2.5/packages/rolldown)

Updates `vitest` from 4.1.10 to 4.1.11
- [Release notes](https://github.com/vitest-dev/vitest/releases)
- [Changelog](https://github.com/vitest-dev/vitest/blob/main/docs/releases.md)
- [Commits](https://github.com/vitest-dev/vitest/commits/v4.1.11/packages/vitest)

---
updated-dependencies:
- dependency-name: "@changesets/cli"
  dependency-version: 3.0.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: development-dependencies
- dependency-name: "@changesets/write"
  dependency-version: 1.0.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: development-dependencies
- dependency-name: "@tsconfig/node24"
  dependency-version: 24.0.5
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: development-dependencies
- dependency-name: "@types/node"
  dependency-version: 26.3.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development-dependencies
- dependency-name: oxfmt
  dependency-version: 0.65.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development-dependencies
- dependency-name: rolldown
  dependency-version: 1.2.5
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: development-dependencies
- dependency-name: vitest
  dependency-version: 4.1.11
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: development-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-01 06:17:16 +00:00
Bjorn Lu ca8589735a Always prepare branch for version (#729)
* Always prepare branch for version

* Update test
2026-08-31 08:18:49 +00:00
Bjorn Lu 36f529f13a Fix root action double error logs (#724) 2026-08-22 10:32:21 +00:00
changesets-org-version-bot[bot] d7669c894a Version Packages (#722)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-08-19 05:29:59 +00:00
Szajkovics SándorandBjorn Lu da1ea291ef Fix typo in renamed inputs (#721)
* fix: mesage typoo in renamed inputs

* chore: add changeset

* Apply suggestion from @bluwy

---------

Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
2026-08-13 07:10:14 +00:00
changesets-org-version-bot[bot] 7545547fe4 Version Packages (#719)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-08-13 02:33:15 +00:00
Mateusz Burzyński 3043070b0d Prevent test warning annotations (#720) 2026-08-13 00:50:23 +00:00
Bjorn Lu 3b7c71c440 Add back cwd input (#718) 2026-08-12 13:10:39 +00:00
Bjorn Lu 6f58ba3580 Update pr-status message links to new faq (#716) 2026-08-12 10:34:14 +00:00
changesets-org-version-bot[bot] e52ce9e59b Version Packages (#715)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-08-11 12:39:31 +00:00
Mateusz Burzyński 78fdc6bb2e Exit pre mode (#714)
* Exit pre mode

* Remove prerelease-only changesets
2026-08-11 12:35:44 +00:00
Bjorn LuandMateusz Burzyński 187a104ea0 Update deps for stable (#709)
* Update dependencies and pre setup

* Add changeset

* Handle pre change

* Update dependencies

* Use stable Changesets v3 packages

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-08-11 12:17:46 +00:00
changesets-org-version-bot[bot] d11394aa52 Version Packages (next) (#712)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-08-11 11:05:26 +00:00
Mateusz Burzyński 5fa67671df Fix support for prerelease exits using the new .changeset/pre layout (#711)
* Fix prerelease exit mode selection

* Improve prerelease exit changeset wording
2026-08-11 11:00:37 +00:00
Mateusz Burzyński cae6353519 Use new self-repository syntax for local GitHub actions (#706) 2026-08-03 15:40:56 +00:00
changesets-org-version-bot[bot] c1722b9aba Version Packages (next) (#698)
Co-authored-by: changesets-org-version-bot[bot] <288406890+changesets-org-version-bot[bot]@users.noreply.github.com>
2026-08-03 12:10:09 +00:00
Mateusz Burzyński 77be81bcb9 Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates (#705)
* Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates when using GitHub API pushes

* update ghcommit
2026-08-03 12:03:51 +00:00
Mateusz Burzyński cb3f0110d7 Use GitHub API for pushes by default and require explicit github-token when using custom tokens (#692)
* Ensure `github-token` wins for `git-cli` pushes

* more shenanigans

* Default to GitHub API commit mode

* e2e auth tests

* push missing utils

* rename input

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* reuse helpers

* refactor

* refactor

* simplify

* add tests

* refactor

* improve comments

* shift helper

* add comments

* extract test helpers

* update docs and changesets

* update one thing
2026-08-03 11:02:31 +00:00
Bjorn Lu 50de20a107 Add extra permission docs (#704)
* Add extra permission docs

* Update
2026-08-01 09:35:59 +00:00
Bjorn Lu 64b747d5f5 Update all the docs (#703)
* Update all the docs

* Fix heading
2026-07-31 14:33:09 +00:00
Mateusz Burzyński 219ea82e52 Remove setup-git-user in favor of setting fallback only when identity is missing (#688)
* Experiment with skipping setup-git-user more often

* drop setup-git-user

* fix tests
2026-07-27 05:02:39 +00:00
Bjorn Lu 469993ce57 Remove npm auth handling in favor of docs (#695)
* Add docs for npm auth setup

* Show bash examples

* Improve bash pattern

* Update and reference docs

* Remove setup auth code

* Update

* Update

* Update
2026-07-24 15:24:09 +00:00
Bjorn Lu 8a9495e0ee Gitignore .env file (#701) 2026-07-24 12:20:48 +00:00
Mateusz Burzyński 5b307d3df2 Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to changesets/action@v1 (#699)
* Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`

* better spy/mocking

* fmt

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

* Apply suggestion from @teemingc
2026-07-05 17:43:21 +00:00
71 changed files with 2642 additions and 1800 deletions
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
-7
View File
@@ -1,7 +0,0 @@
---
"@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.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": minor
---
Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": major
---
Removed compatibility support for old Changesets v1.
-17
View File
@@ -1,17 +0,0 @@
---
"@changesets/action": major
---
Rename the root action inputs and outputs to better match the sub-actions' conventions.
Inputs:
- `version` -> `version-script`
- `publish` -> `publish-script`
- `commit` -> `commit-message`
- `title` -> `pr-title`
- `branch` -> `pr-base-branch`
Outputs:
- `pull-request-number` -> `pr-number`
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": major
---
Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": major
---
Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
-20
View File
@@ -1,20 +0,0 @@
{
"mode": "pre",
"tag": "next",
"changesets": [
"all-cars-grin",
"chubby-geese-sink",
"eight-clocks-pull",
"eighty-doors-swim",
"eighty-parks-tickle",
"fiery-toes-vanish",
"git-cli-auth-header",
"git-cli-server-url",
"lemon-turtles-itch",
"ready-mangos-boil",
"shaky-rings-type",
"shy-months-crash",
"silent-tips-dance",
"yellow-roses-fix"
]
}
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": major
---
Update to Changesets v3 packages
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": minor
---
Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": major
---
Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
+5
View File
@@ -10,6 +10,11 @@ inputs:
runs: runs:
using: composite using: composite
steps: steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- name: Set up pnpm - name: Set up pnpm
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5 uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
+5 -20
View File
@@ -27,12 +27,12 @@ jobs:
security-events: write # allow writing security events security-events: write # allow writing security events
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with: with:
persist-credentials: false persist-credentials: false
- name: Run zizmor - name: Run zizmor
uses: zizmorcore/zizmor-action@5f14fd08f7cf1cb1609c1e344975f152c7ee938d # v0.5.6 uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2
with: with:
persona: pedantic persona: pedantic
annotations: true annotations: true
@@ -43,12 +43,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Test - name: Test
run: pnpm test run: pnpm test
@@ -58,12 +53,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Typecheck - name: Typecheck
run: pnpm typecheck run: pnpm typecheck
@@ -73,12 +63,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Format - name: Format
run: pnpm format run: pnpm format
+5 -21
View File
@@ -24,12 +24,7 @@ jobs:
permissions: permissions:
contents: read # to check out repo (actions/checkout) contents: read # to check out repo (actions/checkout)
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with: with:
skip-cache: true # avoid cache poisoning attacks skip-cache: true # avoid cache poisoning attacks
@@ -50,19 +45,14 @@ jobs:
permissions: permissions:
contents: read # to check out repo (actions/checkout) contents: read # to check out repo (actions/checkout)
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with: with:
skip-cache: true # avoid cache poisoning attacks skip-cache: true # avoid cache poisoning attacks
- name: Build - name: Build
run: pnpm build run: pnpm build
- uses: ./.github/actions/setup-bot-auth - uses: $/.github/actions/setup-bot-auth
id: bot-auth id: bot-auth
with: with:
client-id: ${{ vars.APP_CLIENT_ID }} client-id: ${{ vars.APP_CLIENT_ID }}
@@ -75,7 +65,6 @@ jobs:
uses: ./version uses: ./version
with: with:
github-token: ${{ steps.bot-auth.outputs.token }} github-token: ${{ steps.bot-auth.outputs.token }}
setup-git-user: false
script: pnpm bump script: pnpm bump
publish: publish:
@@ -88,19 +77,14 @@ jobs:
permissions: permissions:
contents: write # to create release and have it authored by github-actions (changesets/action) contents: write # to create release and have it authored by github-actions (changesets/action)
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with: with:
skip-cache: true # avoid cache poisoning attacks skip-cache: true # avoid cache poisoning attacks
- name: Build - name: Build
run: pnpm build run: pnpm build
- uses: ./.github/actions/setup-bot-auth - uses: $/.github/actions/setup-bot-auth
id: bot-auth id: bot-auth
with: with:
client-id: ${{ vars.APP_CLIENT_ID }} client-id: ${{ vars.APP_CLIENT_ID }}
+2 -7
View File
@@ -122,12 +122,7 @@ jobs:
pull-requests: write # to comment on the pull request with the release result (changesets/action) pull-requests: write # to comment on the pull request with the release result (changesets/action)
steps: steps:
- name: Check out repo - uses: $/.github/actions/ci-setup
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with: with:
skip-cache: true # avoid cache poisoning attacks skip-cache: true # avoid cache poisoning attacks
@@ -166,7 +161,7 @@ jobs:
- name: Build - name: Build
run: pnpm build run: pnpm build
- uses: ./.github/actions/setup-bot-auth - uses: $/.github/actions/setup-bot-auth
id: bot-auth id: bot-auth
with: with:
client-id: ${{ vars.APP_CLIENT_ID }} client-id: ${{ vars.APP_CLIENT_ID }}
+1
View File
@@ -2,5 +2,6 @@ node_modules
.parcel-cache .parcel-cache
.cache .cache
*.log *.log
.env
dist/ dist/
+118
View File
@@ -1,5 +1,123 @@
# @changesets/action # @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 ## 2.0.0-next.3
### Major Changes ### Major Changes
+57 -212
View File
@@ -1,232 +1,77 @@
# Changesets Release Action # Changesets GitHub Action
> [!IMPORTANT] > [!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 is the development branch for `changesets/action` v2 compatible with Changesets v3. For the v1 code compatible with Changesets v2, check out the [`maintenance/v1`](https://github.com/changesets/action/tree/maintenance/v1) branch.
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you. 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.
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details: - [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.
- [pr-status](./pr-status/README.md): Generate changeset status in PRs. ## changesets/action
- [pr-comment](./pr-comment/README.md): Comment on PRs.
## Usage 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.
### Inputs 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.
- publish - The command to use to build and publish packages ### Requirements
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- commit - The commit message to use. Default to `Version Packages`
- title - The pull request title. Default to `Version Packages`
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
### Outputs - 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_
- published - A boolean value to indicate whether a publishing has happened or not > [!NOTE]
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` > In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
### Example workflow ### Usage
#### Without Publishing > [!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.
Create a file at `.github/workflows/release.yml` with the following content. > [!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.
```yml ### API
name: Release
on: <!-- api-start -->
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }} | 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. |
jobs: | Outputs | Description |
release: | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
name: Release | `published` | A "true" or "false" string value to indicate whether a publishing is happened or not |
runs-on: ubuntu-latest | `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"}]` |
steps: | `has-changesets` | A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality. |
- name: Checkout Repo | `pr-number` | The pull request number that was created or updated |
uses: actions/checkout@v6
- name: Setup pnpm <!-- api-end -->
uses: pnpm/action-setup@v6
- name: Setup Node.js 26 [job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
uses: actions/setup-node@v6 [workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
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
# ...
```
+12 -12
View File
@@ -5,7 +5,9 @@ runs:
main: "dist/index.js" main: "dist/index.js"
inputs: inputs:
github-token: github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided 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.
required: false required: false
default: ${{ github.token }} default: ${{ github.token }}
publish-script: publish-script:
@@ -38,26 +40,24 @@ inputs:
this option will also always be `true`. this option will also always be `true`.
required: false required: false
default: true default: true
commit-mode: push-with-git-cli:
description: > description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI, Whether to use the Git CLI instead of the GitHub API to push release commits and tags.
or "github-api" to push changes via the GitHub API. When using "github-api", Defaults to `false`. When using the GitHub API, commits and tags are signed using
all commits and tags are signed using GitHub's GPG key and attributed to the user GitHub's GPG key and attributed to the user or app that owns the `github-token`.
or app who owns the GITHUB_TOKEN.
required: false required: false
default: "git-cli" default: false
setup-git-user: cwd:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true` description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false required: false
default: true
outputs: outputs:
published: published:
description: A boolean value to indicate whether a publishing is happened or not description: A "true" or "false" string value to indicate whether a publishing is happened or not
published-packages: published-packages:
description: > 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"}]` 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: has-changesets:
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality. description: A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality.
pr-number: pr-number:
description: The pull request number that was created or updated description: The pull request number that was created or updated
branding: branding:
+12
View File
File diff suppressed because one or more lines are too long
-12
View File
File diff suppressed because one or more lines are too long
+1 -2
View File
@@ -1,2 +1 @@
import{d as e,f as t,l as n,m as r,p as i,u as a}from"./manypkg-get-packages-BoFCbqAx.js";import{n as o,r as s,t as c}from"./run-Bw2IS-rI.js";import{c as l,f as u,r as d,s as f}from"./utils-DxGVktYo.js";import{t as p}from"./readChangesetState-wtnwjhXS.js";import m from"node:fs/promises";(async()=>{u({publish:`publish-script`,version:`version-script`,commit:`commit-mesage`,title:`pr-title`,branch:`pr-base-branch`,prDraft:`pr-draft`,createGithubReleases:`create-github-releases`,commitMode:`commit-mode`,setupGitUser:`setup-git-user`});let h=l(`github-token`);if(process.env.GITHUB_TOKEN&&process.env.GITHUB_TOKEN!==h)throw Error(`The GITHUB_TOKEN environment variable is set and does not match the "github-token" input. Please pass the custom GitHub token to the "github-token" input and remove the GITHUB_TOKEN environment variable to avoid conflicts.`);let g=process.cwd(),_=f(`commit-mode`)??`git-cli`,v=f(`pr-draft`);if(_!==`git-cli`&&_!==`github-api`){i(`Invalid commit mode: ${_}`);return}if(v!==void 0&&v!==`always`&&v!==`create`){i(`Invalid pr-draft: ${v}`);return}let y=new s({cwd:g,githubToken:h,commitMode:_});a(`setup-git-user`)&&(t(`setting git user`),await y.setupUser());let{changesets:b}=await p(g),x=e(`publish-script`),S=b.length!==0,C=b.some(e=>e.releases.length>0),w=!!x;switch(r(`published`,`false`),r(`published-packages`,`[]`),r(`has-changesets`,String(S)),!0){case!S&&!w:t(`No changesets present or were removed by merging release PR. Not publishing because no publish script found.`);return;case!S&&w:{if(t(`No changesets found. Attempting to publish any unpublished packages to npm`),process.env.NPM_TOKEN){let e=`${process.env.HOME}/.npmrc`;await d(e)?(t(`Found existing user .npmrc file`),(await m.readFile(e,`utf8`)).split(` import{A as e,D as t,O as n,f as r,j as i,k as a,m as o,o as s,p as c,s as l}from"./utils-j_VOz275.js";import{n as u,r as d,t as f}from"./run-CIL9Fbt6.js";import{t as p}from"./readChangesetState-DLdyz-Wv.js";try{await m()}catch(t){e(t.message)}async function m(){let m=s(`cwd`)||process.cwd();await o(m),c({publish:`publish-script`,version:`version-script`,commit:`commit-message`,title:`pr-title`,branch:`pr-base-branch`,prDraft:`pr-draft`,createGithubReleases:`create-github-releases`}),r();let h=l(`github-token`);if(process.env.GITHUB_TOKEN&&process.env.GITHUB_TOKEN!==h)throw Error(`The GITHUB_TOKEN environment variable is set and does not match the "github-token" input. Please pass the custom GitHub token to the "github-token" input and remove the GITHUB_TOKEN environment variable to avoid conflicts.`);let g=t(`push-with-git-cli`),_=s(`pr-draft`);if(_!==void 0&&_!==`always`&&_!==`create`){e(`Invalid pr-draft: ${_}`);return}let v=new d({cwd:m,githubToken:h,pushWithGitCli:g}),{changesets:y}=await p(m),b=n(`publish-script`),x=y.length!==0,S=y.some(e=>e.releases.length>0),C=!!b;switch(i(`published`,`false`),i(`published-packages`,`[]`),i(`has-changesets`,String(x)),!0){case!x&&!C:a(`No changesets present or were removed by merging version PR. Not publishing because publish-script is not set.`);return;case!x&&C:{a(`No changesets found. Attempting to publish any unpublished packages to npm`);let e=t(`create-github-releases`),n=t(`push-git-tags`);if(e&&!n)throw Error(`The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true or set 'create-github-releases' to false.`);let r=await f({script:b,github:v,createGithubReleases:e,pushGitTags:n,cwd:m});if(r.published&&(i(`published`,`true`),i(`published-packages`,JSON.stringify(r.publishedPackages))),r.exitCode!==0)throw Error(`Publish command exited with code ${r.exitCode}${r.published?`, but some packages were published: ${r.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`);return}case x&&!S:a(`All changesets are empty. Not creating PR`);return;case x:{let{pullRequestNumber:e}=await u({script:s(`version-script`),github:v,cwd:m,prTitle:s(`pr-title`),commitMessage:s(`commit-message`),hasPublishScript:C,prDraft:_,branch:s(`pr-base-branch`)});i(`pr-number`,String(e));return}}}export{};
`).find(e=>/^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(e))?t(`Found existing auth token for the npm registry in the user .npmrc file`):(t(`Didn't find existing auth token for the npm registry in the user .npmrc file, creating one`),await m.appendFile(e,`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`))):(t(`No user .npmrc file found, creating one with NPM_TOKEN used as auth token`),await m.writeFile(e,`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`))}else process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN&&process.env.ACTIONS_ID_TOKEN_REQUEST_URL?t(`No NPM_TOKEN found, but OIDC is available - using npm trusted publishing`):t(`No NPM_TOKEN or OIDC available - assuming npm is already authenticated`);let e=a(`create-github-releases`),i=a(`push-git-tags`);if(e&&!i)throw Error(`The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true or set 'create-github-releases' to false.`);let o=await c({script:x,github:y,createGithubReleases:e,pushGitTags:i,cwd:g});o.published&&(r(`published`,`true`),r(`published-packages`,JSON.stringify(o.publishedPackages))),o.exitCode!==0&&(n(`Publish command exited with code ${o.exitCode}${o.published?`, but some packages were published: ${o.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`),process.exit(o.exitCode));return}case S&&!C:t(`All changesets are empty; not creating PR`);return;case S:{let{pullRequestNumber:e}=await o({script:f(`version-script`),github:y,cwd:g,prTitle:f(`pr-title`),commitMessage:f(`commit-message`),hasPublishScript:w,prDraft:v,branch:f(`pr-base-branch`)});r(`pr-number`,String(e));return}}})().catch(e=>{n(e),i(e.message)});export{};
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1 +1 @@
import{m as e,p as t}from"./manypkg-get-packages-BoFCbqAx.js";import{n,p as r,s as i,t as a}from"./utils-DxGVktYo.js";import o from"node:fs/promises";import s from"node:path";import c from"node:os";try{await l()}catch(e){t(e.message)}async function l(){let t=i(`publish-plan-artifact-id`),n=process.cwd(),a=process.env.RUNNER_TEMP??await o.realpath(c.tmpdir()),l=s.join(a,`changeset-pack-${Date.now()}`);await u(n,{outDir:l,publishPlanPath:t?await d(a,Number(t)):void 0});let p=await r.uploadArtifact(`changeset-pack-${Date.now()}`,await f(l),l,{retentionDays:30});if(p.id===void 0)throw Error(`Packed artifact upload did not return an artifact id`);e(`pack-dir-artifact-id`,String(p.id))}async function u(e,t){let r=[`pack`,`--out-dir`,t.outDir];t.publishPlanPath&&r.push(`--from-publish-plan`,t.publishPlanPath),await n(r,{cwd:e,env:process.env})}async function d(e,t){let n=await a(e,t,`changeset-publish-plan`);return s.join(n,`publish-plan.json`)}async function f(e){let t=await o.readdir(e,{withFileTypes:!0});return(await Promise.all(t.map(async t=>{let n=s.join(e,t.name);return t.isDirectory()?f(n):[n]}))).flat()}export{}; import{A as e,j as t,m as n,n as r,o as i,t as a,y as o}from"./utils-j_VOz275.js";import s from"node:fs/promises";import c from"node:path";import l from"node:os";try{await u()}catch(t){e(t.message)}async function u(){let e=i(`cwd`)||process.cwd();await n(e);let r=i(`publish-plan-artifact-id`),a=process.env.RUNNER_TEMP??await s.realpath(l.tmpdir()),u=c.join(a,`changeset-pack-${Date.now()}`);await d(e,{outDir:u,publishPlanPath:r?await f(a,Number(r)):void 0});let m=await o.uploadArtifact(`changeset-pack-${Date.now()}`,await p(u),u,{retentionDays:30});if(m.id===void 0)throw Error(`Packed artifact upload did not return an artifact id`);t(`pack-dir-artifact-id`,String(m.id))}async function d(e,t){let n=[`pack`,`--out-dir`,t.outDir];t.publishPlanPath&&n.push(`--from-publish-plan`,t.publishPlanPath),await r(n,{cwd:e,env:process.env})}async function f(e,t){let n=await a(e,t,`changeset-publish-plan`);return c.join(n,`publish-plan.json`)}async function p(e){let t=await s.readdir(e,{withFileTypes:!0});return(await Promise.all(t.map(async t=>{let n=c.join(e,t.name);return t.isDirectory()?p(n):[n]}))).flat()}export{};
+1 -1
View File
@@ -1 +1 @@
import{a as e,f as t,i as n,m as r,p as i}from"./manypkg-get-packages-BoFCbqAx.js";import{c as a,s as o}from"./utils-DxGVktYo.js";try{await s()}catch(e){i(e.message)}async function s(){let i=n.payload.pull_request;if(!i)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let s=a(`github-token`),l=a(`body`),u=o(`update-id`),d=u?c(u):null,f=d?`${d}\n\n${l}`:l,p={repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number,body:f},m=e(s),h;d&&(t(`Checking for existing comment...`),h=await m.rest.issues.listComments({repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number}).then(e=>e.data.find(e=>e.body?.includes(d))?.id)),h?(t(`Updating existing comment (id: ${h})...`),await m.rest.issues.updateComment({...p,comment_id:h}),r(`comment-id`,h)):(t(`Creating new comment...`),r(`comment-id`,(await m.rest.issues.createComment(p)).data.id)),t(`Done!`)}function c(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{}; import{A as e,T as t,j as n,k as r,o as i,s as a,w as o}from"./utils-j_VOz275.js";try{await s()}catch(t){e(t.message)}async function s(){let e=o.payload.pull_request;if(!e)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let s=a(`github-token`),l=a(`body`),u=i(`update-id`),d=u?c(u):null,f=d?`${d}\n\n${l}`:l,p={repo:e.base.repo.name,owner:e.base.repo.owner.login,issue_number:e.number,body:f},m=t(s),h;if(d&&(r(`Checking for existing comment...`),h=await m.rest.issues.listComments({repo:e.base.repo.name,owner:e.base.repo.owner.login,issue_number:e.number}).then(e=>e.data.find(e=>e.body?.includes(d))?.id)),h)r(`Updating existing comment (id: ${h})...`),await m.rest.issues.updateComment({...p,comment_id:h}),n(`comment-id`,h);else{r(`Creating new comment...`);let e=await m.rest.issues.createComment(p);n(`comment-id`,e.data.id)}r(`Done!`)}function c(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
+12 -12
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1 +1 @@
import{m as e,p as t,u as n}from"./manypkg-get-packages-BoFCbqAx.js";import{r,t as i}from"./run-Bw2IS-rI.js";import{c as a,s as o,t as s}from"./utils-DxGVktYo.js";import c from"node:fs/promises";import l from"node:os";try{await u()}catch(e){t(e.message)}async function u(){let t=a(`github-token`),u=o(`script`),d=o(`pack-dir-artifact-id`),f=n(`create-github-releases`),p=n(`push-git-tags`);if(f&&!p)throw Error(`The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true or set 'create-github-releases' to false.`);let m=process.cwd(),h=await i({script:u,github:new r({cwd:m,githubToken:t,commitMode:`github-api`}),createGithubReleases:f,pushGitTags:p,cwd:m,fromPackDir:d?await s(process.env.RUNNER_TEMP??await c.realpath(l.tmpdir()),Number(d),`changeset-pack`):void 0});if(h.published?(e(`published`,`true`),e(`published-packages`,JSON.stringify(h.publishedPackages))):e(`published`,`false`),h.exitCode!==0)throw Error(`Publish command exited with code ${h.exitCode}${h.published?`, but some packages were published: ${h.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`)}export{}; import{A as e,D as t,j as n,m as r,o as i,s as a,t as o}from"./utils-j_VOz275.js";import{r as s,t as c}from"./run-CIL9Fbt6.js";import l from"node:fs/promises";import u from"node:os";try{await d()}catch(t){e(t.message)}async function d(){let e=i(`cwd`)||process.cwd();await r(e);let d=a(`github-token`),f=i(`script`),p=i(`pack-dir-artifact-id`),m=t(`create-github-releases`),h=t(`push-git-tags`);if(m&&!h)throw Error(`The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true or set 'create-github-releases' to false.`);let g=new s({cwd:e,githubToken:d}),_=p?await o(process.env.RUNNER_TEMP??await l.realpath(u.tmpdir()),Number(p),`changeset-pack`):void 0,v=await c({script:f,github:g,createGithubReleases:m,pushGitTags:h,cwd:e,fromPackDir:_});if(v.published?(n(`published`,`true`),n(`published-packages`,JSON.stringify(v.publishedPackages))):n(`published`,`false`),v.exitCode!==0)throw Error(`Publish command exited with code ${v.exitCode}${v.published?`, but some packages were published: ${v.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`)}export{};
+1
View File
@@ -0,0 +1 @@
import{i as e,t}from"./dist-BjZhuI7Y.js";async function n(n=process.cwd()){let r=await e(n),i=await t(n);return r!==void 0&&r.mode===`pre`?{preState:r,changesets:i.filter(e=>!e.id.startsWith(`pre/`))}:{preState:void 0,changesets:i}}export{n as t};
-1
View File
@@ -1 +0,0 @@
import{i as e,t}from"./dist-IQHIouET.js";async function n(n=process.cwd()){let r=await e(n),i=await t(n);if(r!==void 0&&r.mode===`pre`){let e=new Set(r.changesets);return{preState:r,changesets:i.filter(t=>!e.has(t.id))}}return{preState:void 0,changesets:i}}export{n as t};
-98
View File
@@ -1,98 +0,0 @@
import{T as e,_ as t,a as n,f as r,g as i,i as a,t as o,v as s}from"./manypkg-get-packages-BoFCbqAx.js";import{o as c}from"./dist-IQHIouET.js";import{a as l,d as u,i as d,l as f,m as p,n as m,o as h,u as g}from"./utils-DxGVktYo.js";import{t as ee}from"./readChangesetState-wtnwjhXS.js";import _ from"node:fs/promises";import v from"path";import{Buffer as y}from"node:buffer";import{randomUUID as b}from"node:crypto";import x from"node:path";import S from"node:os";const C=async(e,t)=>(await e.graphql(`
query getRepositoryMetadata(
$owner: String!
$repo: String!
$baseRef: String!
$targetRef: String!
) {
repository(owner: $owner, name: $repo) {
id
baseRef: ref(qualifiedName: $baseRef) {
id
target {
oid
... on Tag {
target {
oid
}
}
}
}
targetBranch: ref(qualifiedName: $targetRef) {
id
target {
oid
}
}
}
}
`,t)).repository,w=async(e,t)=>e.graphql(`
mutation createCommitOnBranch($input: CreateCommitOnBranchInput!) {
createCommitOnBranch(input: $input) {
commit {
oid
}
ref {
id
}
}
}
`,t);function T(e){if(typeof e==`object`)return{headline:e.headline.trim(),body:e.body?.trim()};if(!e.includes(`
`))return{headline:e.trim()};let[t,...n]=e.split(`
`);return{headline:t.trim(),body:n.join(`
`).trim()}}function E(e){return`branch`in e?`refs/heads/${e.branch}`:`tag`in e?`refs/tags/${e.tag}`:e.commit}async function D({octokit:e,owner:t,repo:n,branch:r,base:i,force:a=!1,message:o,fileChanges:s}){let c=E(i),l=await C(e,{owner:t,repo:n,baseRef:c,targetRef:`refs/heads/${r}`});if(!l)throw Error(`Repository "${t}/${n}" not found`);let u=`commit`in i?i.commit:O(l.baseRef);if(!u)throw Error(`Could not determine sha for base ref "${c}"`);let d=l.targetBranch?.target?.oid??null,f=async(t,n)=>{let r=await w(e,{input:{branch:{id:t},expectedHeadOid:u,message:T(o),fileChanges:s}});if(r.createCommitOnBranch?.ref?.id==null)throw Error(`Failed to create commit on branch "${n}"`);if(r.createCommitOnBranch?.commit?.oid==null)throw Error(`Failed to determine commit sha for commit on branch "${n}"`);return{commitSha:r.createCommitOnBranch.commit.oid}};if(d==null){let i=(await e.rest.git.createRef({owner:t,repo:n,ref:`refs/heads/${r}`,sha:u})).data.node_id;if(!i)throw Error(`Failed to create branch "${r}"`);return await f(i,r),{refId:i}}else if(d===u){let e=l.targetBranch.id;return await f(e,r),{refId:e}}else if(a){let i=`changesets-ghcommit-temp/${r}`;try{let{tempRefId:a}=await k({octokit:e,owner:t,repo:n,tempBranch:i,baseSha:u}),{commitSha:o}=await f(a,i),s=(await e.rest.git.updateRef({owner:t,repo:n,ref:`heads/${r}`,sha:o,force:!0})).data.node_id;if(!s)throw Error(`Failed to force update branch "${r}"`);return{refId:s}}finally{await e.rest.git.deleteRef({owner:t,repo:n,ref:`heads/${i}`})}}else throw Error(`Branch "${r}" exists but its HEAD does not match the base ${u} and \`force\` is set to false`)}function O(e){return e?.target?`target`in e.target?e.target.target.oid:e.target.oid:null}async function k({octokit:e,owner:t,repo:n,tempBranch:r,baseSha:i}){try{let a=(await e.rest.git.createRef({owner:t,repo:n,ref:`refs/heads/${r}`,sha:i})).data.node_id;if(!a)throw Error(`Failed to create temporary branch "${r}"`);return{tempRefId:a}}catch(a){if(!A(a))throw a;let o=(await e.rest.git.updateRef({owner:t,repo:n,ref:`heads/${r}`,sha:i,force:!0})).data.node_id;if(!o)throw Error(`Failed to force update temporary branch "${r}"`);return{tempRefId:o}}}function A(e){return typeof e==`object`&&!!e&&`status`in e&&`message`in e&&typeof e.status==`number`&&typeof e.message==`string`&&e.status===422&&e.message.includes(`Reference already exists`)}async function j({cwd:e,filterFiles:t,...n}){e=v.resolve(e??process.cwd());let r=E(n.base??{commit:`HEAD`}),i=await N(e,r);if(!i)throw Error(`Could not determine sha for ref ${r}`);return await D({...n,fileChanges:await M(e,i,t),base:{commit:i}})}async function M(e,t,n){let r=await P(e),i=[],a=[],o=async e=>{if(n&&!n(e))return;let t=v.join(r,e),a=await _.lstat(t);if(a.isSymbolicLink())throw Error(`Unexpected symlink at ${e}, GitHub API only supports files and directories. You may need to add this file to .gitignore`);if(a.mode&73)throw Error(`Unexpected executable file at ${e}, GitHub API only supports non-executable files and directories. You may need to add this file to .gitignore`);i.push({path:e,contents:await _.readFile(t,`base64`)})},s=e=>{n&&!n(e)||a.push({path:e})},[l,u]=await Promise.all([c(`git`,[`diff`,`--name-status`,`--diff-filter=ACDMRT`,t],{throwOnError:!0,nodeOptions:{cwd:r}}),c(`git`,[`ls-files`,`--others`,`--exclude-standard`],{throwOnError:!0,nodeOptions:{cwd:r}})]);for(let e of l.stdout.trim().split(`
`)){if(!e)continue;let[t,...n]=e.split(` `);if(t.startsWith(`R`)||t.startsWith(`C`)){let[e,t]=n;s(e),await o(t);continue}let r=n[0];t===`D`?s(r):await o(r)}for(let e of u.stdout.trim().split(`
`))e&&await o(e);return i.sort((e,t)=>e.path>t.path?1:-1),a.sort((e,t)=>e.path>t.path?1:-1),{additions:i,deletions:a}}async function N(e,t){try{let{stdout:n}=await c(`git`,[`rev-parse`,t],{throwOnError:!0,nodeOptions:{cwd:e}});return n.trim()}catch{return null}}async function P(e){try{let{stdout:t}=await c(`git`,[`rev-parse`,`--git-dir`],{throwOnError:!0,nodeOptions:{cwd:e}});return v.dirname(v.resolve(e,t.trim()))}catch{return e}}var F=e(p(),1),I=`0.0.0-development`,L=()=>Promise.resolve();function R(e,t,n){return e.retryLimiter.schedule(z,e,t,n)}async function z(e,t,n){let{pathname:r}=new URL(n.url,`http://github.test`),i=B(n.method,r),a=!i&&n.method!==`GET`&&n.method!==`HEAD`,o=n.method===`GET`&&r.startsWith(`/search/`),s=r.startsWith(`/graphql`),c=~~t.retryCount>0?{priority:0,weight:0}:{};e.clustering&&(c.expiration=1e3*60),(a||s)&&await e.write.key(e.id).schedule(c,L),a&&e.triggersNotification(r)&&await e.notifications.key(e.id).schedule(c,L),o&&await e.search.key(e.id).schedule(c,L);let l=(i?e.auth:e.global).key(e.id).schedule(c,t,n);if(s){let e=await l;if(e.data.errors!=null&&e.data.errors.some(e=>e.type===`RATE_LIMITED`))throw Object.assign(Error(`GraphQL Rate Limit Exceeded`),{response:e,data:e.data})}return l}function B(e,t){return e===`PATCH`&&/^\/applications\/[^/]+\/token\/scoped$/.test(t)||e===`POST`&&(/^\/applications\/[^/]+\/token$/.test(t)||/^\/app\/installations\/[^/]+\/access_tokens$/.test(t)||t===`/login/oauth/access_token`)}var V=[`/orgs/{org}/invitations`,`/orgs/{org}/invitations/{invitation_id}`,`/orgs/{org}/teams/{team_slug}/discussions`,`/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`,`/repos/{owner}/{repo}/collaborators/{username}`,`/repos/{owner}/{repo}/commits/{commit_sha}/comments`,`/repos/{owner}/{repo}/issues`,`/repos/{owner}/{repo}/issues/{issue_number}/comments`,`/repos/{owner}/{repo}/issues/{issue_number}/sub_issue`,`/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority`,`/repos/{owner}/{repo}/pulls`,`/repos/{owner}/{repo}/pulls/{pull_number}/comments`,`/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies`,`/repos/{owner}/{repo}/pulls/{pull_number}/merge`,`/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers`,`/repos/{owner}/{repo}/pulls/{pull_number}/reviews`,`/repos/{owner}/{repo}/releases`,`/teams/{team_id}/discussions`,`/teams/{team_id}/discussions/{discussion_number}/comments`];function H(e){let t=`^(?:${e.map(e=>e.split(`/`).map(e=>e.startsWith(`{`)?`(?:.+?)`:e).join(`/`)).map(e=>`(?:${e})`).join(`|`)})[^/]*$`;return new RegExp(t,`i`)}var U=H(V),W=U.test.bind(U),G={},K=function(e,t){G.global=new e.Group({id:`octokit-global`,maxConcurrent:10,...t}),G.auth=new e.Group({id:`octokit-auth`,maxConcurrent:1,...t}),G.search=new e.Group({id:`octokit-search`,maxConcurrent:1,minTime:2e3,...t}),G.write=new e.Group({id:`octokit-write`,maxConcurrent:1,minTime:1e3,...t}),G.notifications=new e.Group({id:`octokit-notifications`,maxConcurrent:1,minTime:3e3,...t})};function q(e,t){let{enabled:n=!0,Bottleneck:r=F.default,id:i=`no-id`,timeout:a=1e3*60*2,connection:o}=t.throttle||{};if(!n)return{};let s={timeout:a};o!==void 0&&(s.connection=o),G.global??K(r,s);let c=Object.assign({clustering:o!=null,triggersNotification:W,fallbackSecondaryRateRetryAfter:60,retryAfterBaseValue:1e3,retryLimiter:new r,id:i,...G},t.throttle);if(typeof c.onSecondaryRateLimit!=`function`||typeof c.onRateLimit!=`function`)throw Error(`octokit/plugin-throttling error:
You must pass the onSecondaryRateLimit and onRateLimit error handlers.
See https://octokit.github.io/rest.js/#throttling
const octokit = new Octokit({
throttle: {
onSecondaryRateLimit: (retryAfter, options) => {/* ... */},
onRateLimit: (retryAfter, options) => {/* ... */}
}
})
`);let l={},u=new r.Events(l);return l.on(`secondary-limit`,c.onSecondaryRateLimit),l.on(`rate-limit`,c.onRateLimit),l.on(`error`,t=>e.log.warn(`Error in throttling-plugin limit handler`,t)),c.retryLimiter.on(`failed`,async function(t,n){let[r,i,a]=n.args,{pathname:o}=new URL(a.url,`http://github.test`);if(!(o.startsWith(`/graphql`)&&t.status!==401||t.status===403||t.status===429))return;let s=~~i.retryCount;i.retryCount=s,a.request.retryCount=s;let{wantRetry:c,retryAfter:l=0}=await(async function(){if(/\bsecondary rate\b/i.test(t.message)){let n=Number(t.response.headers[`retry-after`])||r.fallbackSecondaryRateRetryAfter;return{wantRetry:await u.trigger(`secondary-limit`,n,a,e,s),retryAfter:n}}if(t.response.headers!=null&&t.response.headers[`x-ratelimit-remaining`]===`0`||(t.response.data?.errors??[]).some(e=>e.type===`RATE_LIMITED`)){let n=new Date(~~t.response.headers[`x-ratelimit-reset`]*1e3).getTime(),r=Math.max(Math.ceil((n-Date.now())/1e3)+1,0);return{wantRetry:await u.trigger(`rate-limit`,r,a,e,s),retryAfter:r}}return{}})();if(c)return i.retryCount++,l*r.retryAfterBaseValue}),e.hook.wrap(`request`,R.bind(null,c)),{}}q.VERSION=I,q.triggersNotification=W;const J=e=>n(e,{throttle:{onRateLimit:(e,t,n,a)=>{if(i(`Request quota exhausted for request ${t.method} ${t.url}`),a<=2)return r(`Retrying after ${e} seconds!`),!0},onSecondaryRateLimit:(e,t,n,a)=>{if(i(`SecondaryRateLimit detected for request ${t.method} ${t.url}`),a<=2)return r(`Retrying after ${e} seconds!`),!0}}},q),Y=async(e,n)=>{await t(`git`,[`push`,`origin`,`HEAD:${e}`,`--force`],n)},X=async(e,n)=>{let{stderr:r}=await s(`git`,[`checkout`,e],{ignoreReturnCode:!0,...n});r.toString().includes(`Switched to a new branch '${e}'`)||await t(`git`,[`checkout`,`-b`,e],n)},Z=async(e,n)=>{await t(`git`,[`reset`,`--hard`,e],n)},Q=async(e,n)=>{await t(`git`,[`add`,`.`],n),await t(`git`,[`commit`,`-m`,e],n)},te=async e=>{let{stdout:t}=await s(`git`,[`status`,`--porcelain`],e);return!t.length};var ne=class{#e;octokit;cwd;commitMode;constructor(e){this.#e=e.githubToken,this.cwd=e.cwd,this.commitMode=e.commitMode??`git-cli`,this.octokit=J(e.githubToken)}getToken(){return this.#e}#t(){let e=y.from(`x-access-token:${this.#e}`).toString(`base64`),t=(a.serverUrl??process.env.GITHUB_SERVER_URL??`https://github.com`).replace(/\/+$/,``),n=Number(process.env.GIT_CONFIG_COUNT??0);if(!Number.isInteger(n)||n<0)throw Error(`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`);return{GIT_CONFIG_COUNT:String(n+1),[`GIT_CONFIG_KEY_${n}`]:`http.${t}/.extraheader`,[`GIT_CONFIG_VALUE_${n}`]:`AUTHORIZATION: basic ${e}`}}async setupUser(){this.commitMode!==`github-api`&&(await t(`git`,[`config`,`user.name`,`"github-actions[bot]"`],{cwd:this.cwd}),await t(`git`,[`config`,`user.email`,`"41898282+github-actions[bot]@users.noreply.github.com"`],{cwd:this.cwd}))}async pushTag(e){if(this.commitMode===`github-api`)return this.octokit.rest.git.createRef({...a.repo,ref:`refs/tags/${e}`,sha:a.sha}).catch(t=>{i(`Failed to create tag ${e}: ${t.message}`)});await t(`git`,[`push`,`origin`,e],{cwd:this.cwd,env:{...process.env,...this.#t()}})}async prepareBranch(e){this.commitMode!==`github-api`&&(await X(e,{cwd:this.cwd}),await Z(a.sha,{cwd:this.cwd}))}async pushChanges({branch:e,message:t}){if(this.commitMode===`github-api`){await j({octokit:this.octokit,...a.repo,branch:e,message:t,base:{commit:a.sha},cwd:this.cwd});return}await te({cwd:this.cwd})||await Q(t,{cwd:this.cwd}),await Y(e,{cwd:this.cwd,env:{...process.env,...this.#t()}})}};const re=async(e,{pkg:t,tagName:n})=>{let r;try{r=await _.readFile(x.join(t.dir,`CHANGELOG.md`),`utf8`)}catch(e){if(g(e,`ENOENT`))return;throw e}let i=l(r,t.packageJson.version);if(!i)throw Error(`Could not find changelog entry for ${t.packageJson.name}@${t.packageJson.version}`);await e.rest.repos.createRelease({name:n,tag_name:n,body:i.content,prerelease:t.packageJson.version.includes(`-`),...a.repo})};function $(e){return typeof e==`object`&&!!e}function ie(e){return $(e)&&`type`in e&&e.type===`git-tag`&&`tag`in e&&typeof e.tag==`string`&&`packageName`in e&&typeof e.packageName==`string`}async function ae(e){let t;try{t=await _.readFile(e,`utf8`)}catch(t){throw Error(`Failed to read changesets output at ${e}`,{cause:t})}let n=[],r=0;for(;r<=t.length;){let e=t.indexOf(`
`,r);e===-1&&(e=t.length);let i=t.slice(r,e);if(r=e+1,/^\s*$/.test(i))continue;let a;try{a=JSON.parse(i)}catch(e){throw Error(`Failed to parse changesets output event: ${i}`,{cause:e})}ie(a)&&n.push(a)}return n}async function oe({script:e,fromPackDir:t,github:n,createGithubReleases:r,pushGitTags:i,cwd:a}){let{octokit:c}=n,l,u=x.join(process.env.RUNNER_TEMP??await _.realpath(S.tmpdir()),`changesets-output-${b()}.ndjson`),d={cwd:a,ignoreReturnCode:!0,env:{...process.env,GITHUB_TOKEN:n.getToken(),CHANGESETS_OUTPUT:u}};if(e)l=await s(e,void 0,d);else{let e=[`publish`];t&&e.push(`--from-pack-dir`,t),l=await h(e,d)}let{packages:f,tool:p}=await o(a),m=new Map(f.map(e=>[e.packageJson.name,e])),g=(await ae(u)).map(e=>{let t=m.get(e.packageName);if(t===void 0)throw Error(`Package "${e.packageName}" not found.This is probably a bug in the action, please open an issue`);return{pkg:t,tag:e.tag}});if(p.type===`root`&&f.length===0)throw Error(`No package found.This is probably a bug in the action, please open an issue`);return(r||i)&&await Promise.all(g.map(async({pkg:e,tag:t})=>{i&&await n.pushTag(t),r&&await re(c,{pkg:e,tagName:t})})),g.length?{published:!0,publishedPackages:g.map(({pkg:e})=>({name:e.packageJson.name,version:e.packageJson.version})),exitCode:l.exitCode}:{published:!1,exitCode:l.exitCode}}async function se({hasPublishScript:e,preState:t,changedPackagesInfo:n,prBodyMaxCharacters:r,branch:i}){let a=`This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and ${e?`the packages will be published to npm automatically`:`publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing)`}. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${i}, this PR will be updated.
`,o=t?`⚠️⚠️⚠️⚠️⚠️⚠️
\`${i}\` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run \`changeset pre exit\` on \`${i}\`.
⚠️⚠️⚠️⚠️⚠️⚠️
`:``,s=`# Releases`,c=[a,o,s,...n.map(e=>`${e.header}\n\n${e.content}`)].join(`
`);return c.length>r&&(c=[a,o,s,`
> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.
`,...n.map(e=>`${e.header}\n\n`)].join(`
`)),c.length>r&&(c=[a,o,s,`
> All release information have been omitted from this message, as the content exceeds the size limit.`].join(`
`)),c}async function ce({script:e,github:n,cwd:i=process.cwd(),prTitle:o=`Version Packages`,commitMessage:s=`Version Packages`,hasPublishScript:c=!1,prBodyMaxCharacters:p=6e4,branch:h=a.ref.replace(`refs/heads/`,``),prDraft:g}){let{octokit:v}=n,y=`changeset-release/${h}`,{preState:b}=await ee(i);await n.prepareBranch(y);let S=await f(i),C={...process.env,GITHUB_TOKEN:n.getToken()};e?await t(e,void 0,{cwd:i,env:C}):await m([`version`],{cwd:i,env:C});let w=await d(i,S),T=Promise.all(w.map(async e=>{let t=l(await _.readFile(x.join(e.dir,`CHANGELOG.md`),`utf8`),e.packageJson.version);return{highestLevel:t.highestLevel,private:!!e.packageJson.private,content:t.content,header:`## ${e.packageJson.name}@${e.packageJson.version}`}})),E=`${o}${b?` (${b.tag})`:``}`,D=`${s}${b?` (${b.tag})`:``}`,O=await v.rest.pulls.list({...a.repo,state:`open`,head:`${a.repo.owner}:${y}`,base:h});r(`Existing pull requests: ${JSON.stringify(O.data,null,2)}`),await n.pushChanges({branch:y,message:D});let k=await se({hasPublishScript:c,preState:b,branch:h,changedPackagesInfo:(await T).filter(e=>e).sort(u),prBodyMaxCharacters:p});if(O.data.length===0){r(`creating pull request`);let{data:e}=await v.rest.pulls.create({base:h,head:y,title:E,body:k,draft:g!==void 0,...a.repo});return{pullRequestNumber:e.number}}else{let[e]=O.data;r(`updating found pull request #${e.number}`);let t=`
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
${g===`always`?`
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}`:``}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
`;return await v.graphql(t,{pullRequestId:e.node_id,title:E,body:k}),{pullRequestNumber:e.number}}}export{ce as n,ne as r,oe as t};
+98
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1 +1 @@
import{m as e,p as t}from"./manypkg-get-packages-BoFCbqAx.js";import{n,p as r}from"./utils-DxGVktYo.js";import{t as i}from"./readChangesetState-wtnwjhXS.js";import a from"node:fs/promises";import o from"node:path";import s from"node:os";try{await c()}catch(e){t(e.message)}async function c(){let t=await l();if(e(`mode`,t.mode),t.mode===`publish`){let n=await r.uploadArtifact(o.basename(t.publishPlanPath,`.json`),[t.publishPlanPath],o.dirname(t.publishPlanPath),{skipArchive:!0,retentionDays:30});if(n.id===void 0)throw Error(`Publish plan artifact upload did not return an artifact id`);e(`publish-plan-artifact-id`,String(n.id))}}async function l(){let{changesets:e}=await i();if(e.length>0)return e.some(e=>e.releases.length>0)?{mode:`version`}:{mode:`none`};let t=process.cwd(),r=o.join(process.env.RUNNER_TEMP??await a.realpath(s.tmpdir()),`changeset-publish-plan-${Date.now()}`,`publish-plan.json`);return await n([`publish-plan`,`--output`,r],{cwd:t,env:process.env}),(await u(r)).length===0?{mode:`none`}:{mode:`publish`,publishPlanPath:r}}async function u(e){let t;try{t=await a.readFile(e,`utf8`)}catch(t){throw Error(`Failed to read publish plan at ${e}`,{cause:t})}let n;try{n=JSON.parse(t)}catch(t){throw Error(`Failed to parse publish plan at ${e}`,{cause:t})}if(typeof n!=`object`||!n||!(`version`in n)||typeof n.version!=`number`||!(`plan`in n)||!Array.isArray(n.plan))throw Error(`Invalid publish plan at ${e}: expected { version: number; plan: unknown[] }`);return n.plan}export{}; import{A as e,j as t,m as n,n as r,o as i,y as a}from"./utils-j_VOz275.js";import{t as o}from"./readChangesetState-DLdyz-Wv.js";import s from"node:fs/promises";import c from"node:path";import l from"node:os";try{await u()}catch(t){e(t.message)}async function u(){let e=i(`cwd`)||process.cwd();await n(e);let r=await d(e);if(t(`mode`,r.mode),r.mode===`publish`){let e=await a.uploadArtifact(c.basename(r.publishPlanPath,`.json`),[r.publishPlanPath],c.dirname(r.publishPlanPath),{skipArchive:!0,retentionDays:30});if(e.id===void 0)throw Error(`Publish plan artifact upload did not return an artifact id`);t(`publish-plan-artifact-id`,String(e.id))}}async function d(e){let{changesets:t}=await o(e);if(t.length>0)return t.some(e=>e.releases.length>0)?{mode:`version`}:{mode:`none`};let n=c.join(process.env.RUNNER_TEMP??await s.realpath(l.tmpdir()),`changeset-publish-plan-${Date.now()}`,`publish-plan.json`);return await r([`publish-plan`,`--output`,n],{cwd:e,env:process.env}),(await f(n)).length===0?{mode:`none`}:{mode:`publish`,publishPlanPath:n}}async function f(e){let t;try{t=await s.readFile(e,`utf8`)}catch(t){throw Error(`Failed to read publish plan at ${e}`,{cause:t})}let n;try{n=JSON.parse(t)}catch(t){throw Error(`Failed to parse publish plan at ${e}`,{cause:t})}if(typeof n!=`object`||!n||!(`version`in n)||typeof n.version!=`number`||!(`plan`in n)||!Array.isArray(n.plan))throw Error(`Invalid publish plan at ${e}: expected { version: number; plan: unknown[] }`);return n.plan}export{};
-82
View File
File diff suppressed because one or more lines are too long
+228
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1 +1 @@
import{f as e,m as t,p as n,u as r}from"./manypkg-get-packages-BoFCbqAx.js";import{n as i,r as a}from"./run-Bw2IS-rI.js";import{c as o,s}from"./utils-DxGVktYo.js";try{await c()}catch(e){n(e.message)}async function c(){let n=o(`github-token`),c=s(`script`),l=o(`commit-message`),u=o(`pr-title`),d=s(`pr-draft`),f=s(`pr-base-branch`),p=s(`commit-mode`)??`git-cli`,m=r(`setup-git-user`);if(d!==void 0&&d!==`always`&&d!==`create`)throw Error(`Invalid pr-draft input: ${d}`);if(p!==`git-cli`&&p!==`github-api`)throw Error(`Invalid commit-mode input: ${p}`);let h=process.cwd(),g=new a({cwd:h,githubToken:n,commitMode:p});m&&(e(`setting git user`),await g.setupUser());let{pullRequestNumber:_}=await i({script:c,github:g,cwd:h,prTitle:u,commitMessage:l,hasPublishScript:!0,prDraft:d,branch:f});t(`pr-number`,String(_))}export{}; import{A as e,D as t,f as n,j as r,m as i,o as a,s as o}from"./utils-j_VOz275.js";import{n as s,r as c}from"./run-CIL9Fbt6.js";try{await l()}catch(t){e(t.message)}async function l(){let e=a(`cwd`)||process.cwd();await i(e),n();let l=o(`github-token`),u=a(`script`),d=o(`commit-message`),f=o(`pr-title`),p=a(`pr-draft`),m=a(`pr-base-branch`),h=t(`push-with-git-cli`);if(p!==void 0&&p!==`always`&&p!==`create`)throw Error(`Invalid pr-draft input: ${p}`);let g=new c({cwd:e,githubToken:l,pushWithGitCli:h}),{pullRequestNumber:_}=await s({script:u,github:g,cwd:e,prTitle:f,commitMessage:d,hasPublishScript:!0,prDraft:p,branch:m});r(`pr-number`,String(_))}export{};
+30 -1
View File
@@ -1,3 +1,32 @@
# changesets/action/pack # changesets/action/pack
TODO 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
+3
View File
@@ -7,6 +7,9 @@ inputs:
publish-plan-artifact-id: publish-plan-artifact-id:
description: "Artifact id for a publish plan generated by the select-mode subaction" description: "Artifact id for a publish plan generated by the select-mode subaction"
required: false required: false
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs: outputs:
pack-dir-artifact-id: pack-dir-artifact-id:
description: "Artifact id for the packed output directory" description: "Artifact id for the packed output directory"
+28 -26
View File
@@ -1,6 +1,6 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "2.0.0-next.3", "version": "2.1.2",
"private": true, "private": true,
"license": "MIT", "license": "MIT",
"type": "module", "type": "module",
@@ -13,44 +13,46 @@
"format": "oxfmt --check", "format": "oxfmt --check",
"format:fix": "oxfmt", "format:fix": "oxfmt",
"changeset": "changeset", "changeset": "changeset",
"bump": "node --experimental-strip-types ./scripts/bump.ts", "bump": "node ./scripts/bump.ts",
"release": "node --experimental-strip-types ./scripts/release.ts", "update-readme": "node ./scripts/update-readme.ts",
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts" "release": "node ./scripts/release.ts",
"release:pr": "node ./scripts/release-pr.ts"
}, },
"dependencies": { "dependencies": {
"@actions/artifact": "^6.2.1", "@actions/artifact": "^6.2.1",
"@actions/core": "^3.0.1", "@actions/core": "^3.0.1",
"@actions/exec": "^3.0.0", "@actions/exec": "^3.0.0",
"@actions/github": "^9.1.1", "@actions/github": "^9.1.1",
"@changesets/get-release-plan": "^5.0.0-next.7", "@changesets/get-release-plan": "^5.0.0",
"@changesets/ghcommit": "^3.0.0-next.1", "@changesets/ghcommit": "^3.0.0",
"@changesets/git": "^4.0.0-next.6", "@changesets/git": "^4.0.0",
"@changesets/pre": "^3.0.0-next.6", "@changesets/pre": "^3.0.0",
"@changesets/read": "^1.0.0-next.7", "@changesets/read": "^1.0.0",
"@manypkg/get-packages": "^3.1.0", "@manypkg/get-packages": "^3.1.0",
"@octokit/core": "^7.0.6", "@octokit/core": "^7.0.7",
"@octokit/plugin-throttling": "^11.0.3", "@octokit/plugin-throttling": "^11.0.5",
"human-id": "^4.1.3", "human-id": "^4.2.1",
"markdown-table": "^3.0.4", "markdown-table": "^3.0.4",
"semver": "^7.8.1", "semver": "^7.8.5",
"tinyexec": "^1.2.4" "tinyexec": "^1.3.0"
}, },
"devDependencies": { "devDependencies": {
"@changesets/changelog-github": "^1.0.0-next.6", "@changesets/changelog-github": "^1.0.0",
"@changesets/cli": "^3.0.0-next.8", "@changesets/cli": "^3.0.1",
"@changesets/types": "^7.0.0-next.6", "@changesets/types": "^7.0.0",
"@changesets/write": "^1.0.0-next.6", "@changesets/write": "^1.0.1",
"@tsconfig/node24": "^24.0.4", "@tsconfig/node24": "^24.0.5",
"@types/node": "^24.12.4", "@types/node": "^26.3.0",
"@types/semver": "^7.7.1", "@types/semver": "^7.8.0",
"fs-fixture": "^2.13.0", "fs-fixture": "^2.14.0",
"oxfmt": "^0.48.0", "oxfmt": "^0.65.0",
"rolldown": "^1.0.1", "rolldown": "^1.2.5",
"typescript": "^6.0.3", "typescript": "^6.0.3",
"vitest": "^4.1.6" "vitest": "^4.1.11",
"yaml": "^2.9.0"
}, },
"engines": { "engines": {
"node": ">=24" "node": ">=24"
}, },
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a" "packageManager": "pnpm@11.20.0+sha512.9a6f330a95b66446ea088faf1521405a8a01f07fde7124cc9958dfed52d4bb436737e65b08f85f37b46fcba375092558ac51262b816844b22f63406ed166bfee"
} }
+705 -728
View File
File diff suppressed because it is too large Load Diff
+18 -17
View File
@@ -3,23 +3,24 @@ dedupePeers: true
dedupePeerDependents: true dedupePeerDependents: true
minimumReleaseAge: 10080 minimumReleaseAge: 10080
minimumReleaseAgeExclude: minimumReleaseAgeExclude:
- "@changesets/apply-release-plan@8.0.0-next.7" - "@changesets/apply-release-plan@8.0.0"
- "@changesets/assemble-release-plan@7.0.0-next.7" - "@changesets/assemble-release-plan@7.0.0"
- "@changesets/changelog-git@1.0.0-next.6" - "@changesets/changelog-git@1.0.0"
- "@changesets/changelog-github@1.0.0-next.6" - "@changesets/changelog-github@1.0.0"
- "@changesets/cli@3.0.0-next.8" - "@changesets/cli@3.0.0"
- "@changesets/config@4.0.0-next.6" - "@changesets/config@4.0.0"
- "@changesets/get-dependents-graph@3.0.0-next.6" - "@changesets/errors@1.0.0"
- "@changesets/get-github-info@1.0.0-next.3" - "@changesets/get-dependents-graph@3.0.0"
- "@changesets/get-release-plan@5.0.0-next.7" - "@changesets/get-github-info@1.0.0"
- "@changesets/ghcommit@3.0.0-next.1" - "@changesets/get-release-plan@5.0.0"
- "@changesets/git@4.0.0-next.6" - "@changesets/git@4.0.0"
- "@changesets/parse@1.0.0-next.7" - "@changesets/parse@1.0.0"
- "@changesets/pre@3.0.0-next.6" - "@changesets/pre@3.0.0"
- "@changesets/read@1.0.0-next.7" - "@changesets/read@1.0.0"
- "@changesets/should-skip-package@1.0.0-next.6" - "@changesets/should-skip-package@1.0.0"
- "@changesets/types@7.0.0-next.6" - "@changesets/types@7.0.0"
- "@changesets/write@1.0.0-next.6" - "@changesets/write@1.0.0"
- "vite@8.2.0"
overrides: overrides:
lightningcss: "-" # we do not bundle any css lightningcss: "-" # we do not bundle any css
+49 -12
View File
@@ -1,16 +1,28 @@
# @changesets/action/pr-comment # changesets/action/pr-comment
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md). This action creates or updates comments on PRs, aimed to complement [changesets/action/pr-status](../pr-status/README.md).
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). 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).
See the [action metadata](action.yml) for details on the inputs and outputs. ## Requirements
## Example setup - [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.
```yaml ```yaml
name: PR Comment
on: on:
pull_request: pull_request:
@@ -18,21 +30,25 @@ jobs:
pr-comment: pr-comment:
runs-on: ubuntu-slim runs-on: ubuntu-slim
permissions: permissions:
pull-requests: write # to create and update comments on PRs pull-requests: write # to create and update comments on PRs (changesets/action/pr-comment)
steps: steps:
- uses: changesets/action/pr-comment@v1 - name: Comment on PR
uses: changesets/action/pr-comment@v2
with: with:
body: Hello world! body: Hello world!
``` ```
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. 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.
```yaml ```yaml
jobs: jobs:
pr-comment: pr-comment:
# ... # ...
steps: steps:
- uses: changesets/action/pr-comment@v1 - name: Comment on PR
uses: changesets/action/pr-comment@v2
with: with:
body: Hello world! body: Hello world!
update-id: my-tag update-id: my-tag
@@ -45,8 +61,29 @@ jobs:
pr-comment: pr-comment:
# ... # ...
steps: steps:
- uses: changesets/action/pr-comment@v1 - uses: changesets/action/pr-comment@v2
with: with:
body: Hello world! body: Hello world!
update-id: "" 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
+4 -2
View File
@@ -1,11 +1,13 @@
name: Changesets - PR Comment name: Changesets - PR Comment
description: A simple GitHub Action to comment on PRs description: Create or update comments on PRs
runs: runs:
using: node24 using: node24
main: ../dist/pr-comment.js main: ../dist/pr-comment.js
inputs: inputs:
github-token: github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided 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.
required: false required: false
default: ${{ github.token }} default: ${{ github.token }}
body: body:
+24 -55
View File
@@ -1,71 +1,40 @@
# changesets/action/pr-status # changesets/action/pr-status
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. 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.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages. It 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.
See the [action metadata](action.yml) for details on the inputs and outputs. ## 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]
> [!CAUTION] > [!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. > **Do not run untrusted code** when using the `pull_request_target` event.
> >
> The example below only **_checks out_** and **_reads_** code, and does not **_execute_** any code from the fork. > `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.
>
> Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs: [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
```yaml ## Usage
jobs:
pr-status:
if: github.event.pull_request.head.repo.full_name == github.repository
# ...
```
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. > [!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 ## API
```yaml <!-- api-start -->
# .github/workflows/comment-changesets-pr-status.yml
name: Comment Changesets status in PRs
on: Inputs: _none_
pull_request_target:
permissions: {} # require explicitly stating all permissions in each job | Outputs | Description |
| -------------- | ------------------------------------------------------------------- |
| `comment-body` | The generated comment body to present the changesets status in PRs. |
concurrency: <!-- api-end -->
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.
+36 -1
View File
@@ -1,3 +1,38 @@
# changesets/action/publish # changesets/action/publish
TODO This action publishes packages to npm.
## Requirements
- 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_
## 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 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
+7 -2
View File
@@ -5,7 +5,9 @@ runs:
main: ../dist/publish.js main: ../dist/publish.js
inputs: inputs:
github-token: github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided 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.
required: false required: false
default: ${{ github.token }} default: ${{ github.token }}
script: script:
@@ -24,9 +26,12 @@ inputs:
this option will also always be `true`. this option will also always be `true`.
required: false required: false
default: true default: true
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs: outputs:
published: published:
description: "A boolean value to indicate whether a publishing has happened or not" description: A "true" or "false" string value to indicate whether a publishing has happened or not
published-packages: published-packages:
description: > 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"}]` 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"}]`
+46
View File
@@ -0,0 +1,46 @@
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);
}
+33 -1
View File
@@ -1,3 +1,35 @@
# changesets/action/select-mode # changesets/action/select-mode
TODO 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
+4 -1
View File
@@ -3,7 +3,10 @@ description: Whether to version or publish in the current repo state
runs: runs:
using: node24 using: node24
main: ../dist/select-mode.js main: ../dist/select-mode.js
inputs: {} inputs:
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs: outputs:
mode: mode:
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'." description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
+227
View File
@@ -0,0 +1,227 @@
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);
});
+131 -32
View File
@@ -5,8 +5,6 @@ import { context } from "@actions/github";
import { commitChangesSinceBase } from "@changesets/ghcommit"; import { commitChangesSinceBase } from "@changesets/ghcommit";
import { setupOctokit, type Octokit } from "./octokit.ts"; import { setupOctokit, type Octokit } from "./octokit.ts";
export type CommitMode = "git-cli" | "github-api";
type GitOptions = { type GitOptions = {
cwd: string; cwd: string;
env?: Record<string, string>; env?: Record<string, string>;
@@ -50,20 +48,47 @@ const checkIfClean = async (options: GitOptions): Promise<boolean> => {
return !stdout.length; 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 { export class GitHub {
readonly #githubToken: string; readonly #githubToken: string;
readonly octokit: Octokit; readonly octokit: Octokit;
readonly cwd: string; readonly cwd: string;
readonly commitMode: CommitMode; readonly pushWithGitCli: boolean;
readonly serverUrl: string;
constructor(options: { constructor(options: {
githubToken: string; githubToken: string;
cwd: string; cwd: string;
commitMode?: CommitMode; pushWithGitCli?: boolean;
serverUrl?: string;
}) { }) {
this.#githubToken = options.githubToken; this.#githubToken = options.githubToken;
this.cwd = options.cwd; this.cwd = options.cwd;
this.commitMode = options.commitMode ?? "git-cli"; this.pushWithGitCli = options.pushWithGitCli ?? false;
this.serverUrl = (
options.serverUrl ??
context.serverUrl ??
process.env.GITHUB_SERVER_URL ??
"https://github.com"
).replace(/\/+$/, "");
this.octokit = setupOctokit(options.githubToken); this.octokit = setupOctokit(options.githubToken);
} }
@@ -71,32 +96,106 @@ export class GitHub {
return this.#githubToken; return this.#githubToken;
} }
#getCliAuthEnv(): Record<string, string> { 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.
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString( const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
"base64", "base64",
); );
const serverUrl = (
context.serverUrl ?? // The environment may already contain command-scoped Git config. Append
process.env.GITHUB_SERVER_URL ?? // our KEY_n/VALUE_n entries so those existing settings stay active.
"https://github.com"
).replace(/\/+$/, "");
const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0); const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0);
if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) { if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) {
throw new Error( throw new Error(
`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`, `Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`,
); );
} }
return {
GIT_CONFIG_COUNT: String(gitConfigCount + 1), // `git push origin` prefers remote.origin.pushurl over the fetch URL and
[`GIT_CONFIG_KEY_${gitConfigCount}`]: `http.${serverUrl}/.extraheader`, // supports more than one push URL, so inspect every effective destination.
[`GIT_CONFIG_VALUE_${gitConfigCount}`]: `AUTHORIZATION: basic ${basic}`, 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),
}; };
// `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++;
} }
async setupUser() { return env;
if (this.commitMode === "github-api") { }
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) {
return; return;
} }
core.info("Setting git user to github-actions[bot]");
await exec("git", ["config", "user.name", `"github-actions[bot]"`], { await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
cwd: this.cwd, cwd: this.cwd,
}); });
@@ -114,38 +213,36 @@ export class GitHub {
} }
async pushTag(tag: string) { async pushTag(tag: string) {
if (this.commitMode === "github-api") { try {
return this.octokit.rest.git if (!this.pushWithGitCli) {
.createRef({ await this.octokit.rest.git.createRef({
...context.repo, ...context.repo,
ref: `refs/tags/${tag}`, ref: `refs/tags/${tag}`,
sha: context.sha, sha: context.sha,
})
.catch((err) => {
// Assuming tag was manually pushed in custom publish script
core.warning(`Failed to create tag ${tag}: ${err.message}`);
}); });
} } else {
await exec("git", ["push", "origin", tag], { await exec("git", ["push", "origin", tag], {
cwd: this.cwd, cwd: this.cwd,
env: { env: {
...process.env, ...process.env,
...this.#getCliAuthEnv(), ...(await this.#getCliAuthEnv()),
} as Record<string, string>, } 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}`,
);
}
}
async prepareBranch(branch: 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 switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(context.sha, { cwd: this.cwd }); await reset(context.sha, { cwd: this.cwd });
} }
async pushChanges({ branch, message }: { branch: string; message: string }) { async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.commitMode === "github-api") { if (!this.pushWithGitCli) {
await commitChangesSinceBase({ await commitChangesSinceBase({
octokit: this.octokit, octokit: this.octokit,
...context.repo, ...context.repo,
@@ -154,18 +251,20 @@ export class GitHub {
base: { base: {
commit: context.sha, commit: context.sha,
}, },
force: true,
cwd: this.cwd, cwd: this.cwd,
}); });
return; return;
} }
if (!(await checkIfClean({ cwd: this.cwd }))) { if (!(await checkIfClean({ cwd: this.cwd }))) {
await this.ensureGitUser();
await commitAll(message, { cwd: this.cwd }); await commitAll(message, { cwd: this.cwd });
} }
await push(branch, { await push(branch, {
cwd: this.cwd, cwd: this.cwd,
env: { env: {
...process.env, ...process.env,
...this.#getCliAuthEnv(), ...(await this.#getCliAuthEnv()),
} as Record<string, string>, } as Record<string, string>,
}); });
} }
+20 -75
View File
@@ -1,27 +1,35 @@
import fs from "node:fs/promises";
import * as core from "@actions/core"; import * as core from "@actions/core";
import { GitHub } from "./github.ts"; import { GitHub } from "./github.ts";
import readChangesetState from "./readChangesetState.ts"; import readChangesetState from "./readChangesetState.ts";
import { runPublish, runVersion } from "./run.ts"; import { runPublish, runVersion } from "./run.ts";
import { import {
fileExists,
getOptionalInput, getOptionalInput,
getRequiredInput, getRequiredInput,
throwOnRemovedCommitModeInput,
throwOnRenamedInputs, throwOnRenamedInputs,
validateChangesetsCliVersion,
} from "./utils.ts"; } from "./utils.ts";
(async () => { try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
throwOnRenamedInputs({ throwOnRenamedInputs({
publish: "publish-script", publish: "publish-script",
version: "version-script", version: "version-script",
commit: "commit-mesage", commit: "commit-message",
title: "pr-title", title: "pr-title",
branch: "pr-base-branch", branch: "pr-base-branch",
prDraft: "pr-draft", prDraft: "pr-draft",
createGithubReleases: "create-github-releases", createGithubReleases: "create-github-releases",
commitMode: "commit-mode",
setupGitUser: "setup-git-user",
}); });
throwOnRemovedCommitModeInput();
const githubToken = getRequiredInput("github-token"); const githubToken = getRequiredInput("github-token");
if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) { if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) {
@@ -32,15 +40,8 @@ import {
); );
} }
// If the user needs to change the cwd, set `working-directory` in the step instead const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
const cwd = process.cwd();
const commitMode = getOptionalInput("commit-mode") ?? "git-cli";
const prDraft = getOptionalInput("pr-draft"); 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") { if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid pr-draft: ${prDraft}`); core.setFailed(`Invalid pr-draft: ${prDraft}`);
return; return;
@@ -48,16 +49,9 @@ import {
const github = new GitHub({ const github = new GitHub({
cwd, cwd,
githubToken, githubToken,
commitMode, pushWithGitCli,
}); });
let setupGitUser = core.getBooleanInput("setup-git-user");
if (setupGitUser) {
core.info("setting git user");
await github.setupUser();
}
let { changesets } = await readChangesetState(cwd); let { changesets } = await readChangesetState(cwd);
let publishScript = core.getInput("publish-script"); let publishScript = core.getInput("publish-script");
@@ -74,7 +68,7 @@ import {
switch (true) { switch (true) {
case !hasChangesets && !hasPublishScript: case !hasChangesets && !hasPublishScript:
core.info( core.info(
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.", "No changesets present or were removed by merging version PR. Not publishing because publish-script is not set.",
); );
return; return;
case !hasChangesets && hasPublishScript: { case !hasChangesets && hasPublishScript: {
@@ -82,51 +76,6 @@ import {
"No changesets found. Attempting to publish any unpublished packages to npm", "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( const createGithubReleases = core.getBooleanInput(
"create-github-releases", "create-github-releases",
); );
@@ -155,7 +104,7 @@ import {
} }
if (result.exitCode !== 0) { if (result.exitCode !== 0) {
core.error( throw new Error(
`Publish command exited with code ${result.exitCode}${ `Publish command exited with code ${result.exitCode}${
result.published result.published
? `, but some packages were published: ${result.publishedPackages ? `, but some packages were published: ${result.publishedPackages
@@ -164,12 +113,11 @@ import {
: "" : ""
}`, }`,
); );
process.exit(result.exitCode);
} }
return; return;
} }
case hasChangesets && !hasNonEmptyChangesets: case hasChangesets && !hasNonEmptyChangesets:
core.info("All changesets are empty; not creating PR"); core.info("All changesets are empty. Not creating PR");
return; return;
case hasChangesets: { case hasChangesets: {
const { pullRequestNumber } = await runVersion({ const { pullRequestNumber } = await runVersion({
@@ -188,7 +136,4 @@ import {
return; return;
} }
} }
})().catch((err) => { }
core.error(err);
core.setFailed(err.message);
});
+4 -2
View File
@@ -7,6 +7,7 @@ import {
downloadArtifact, downloadArtifact,
execChangesetsCli, execChangesetsCli,
getOptionalInput, getOptionalInput,
validateChangesetsCliVersion,
} from "../utils.ts"; } from "../utils.ts";
try { try {
@@ -16,10 +17,11 @@ try {
} }
async function main() { async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const publishPlanArtifactId = getOptionalInput("publish-plan-artifact-id"); const publishPlanArtifactId = getOptionalInput("publish-plan-artifact-id");
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())); const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
const outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`); const outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`);
+2 -2
View File
@@ -53,7 +53,7 @@ Latest commit: ${commitSha}
${getReleasePlanMessage(releasePlan)} ${getReleasePlanMessage(releasePlan)}
Not sure what this means? [Click here to learn what changesets are](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md). Not sure what this means? [Click here to learn what changesets are](https://changesets.dev/faq).
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`; [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)} ${getReleasePlanMessage(releasePlan)}
[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 to learn what changesets are, and how to add one](https://changesets.dev/faq).
[Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`; [Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
} }
+18 -31
View File
@@ -1,9 +1,9 @@
import { pathToFileURL } from "node:url"; import { pathToFileURL } from "node:url";
import type * as github from "@actions/github"; import type * as github from "@actions/github";
import { getReleasePlan } from "@changesets/get-release-plan"; import { getReleasePlan } from "@changesets/get-release-plan";
import { createFixture } from "fs-fixture";
import { exec } from "tinyexec"; import { exec } from "tinyexec";
import { describe, expect, it } from "vitest"; import { describe, expect, it } from "vitest";
import { gitdir, shallowClone, testdir } from "../test-utils.ts";
import { getPullRequestWorktree } from "./worktree.ts"; import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable< type PullRequestContext = NonNullable<
@@ -21,7 +21,7 @@ async function git(cwd: string, args: string[]) {
describe("getPullRequestWorktree", () => { describe("getPullRequestWorktree", () => {
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => { it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
// Local source repo // Local source repo
await using sourceRepoFixture = await createFixture({ await using sourceRepoFixture = await gitdir({
".changeset/config.json": JSON.stringify({}), ".changeset/config.json": JSON.stringify({}),
"package.json": JSON.stringify({ "package.json": JSON.stringify({
name: "repo", name: "repo",
@@ -35,46 +35,33 @@ describe("getPullRequestWorktree", () => {
}), }),
}); });
const sourceRepo = sourceRepoFixture.path; 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 // Simulate remote bare git server
await using originBareFixture = await createFixture(); await using originBareFixture = await testdir();
const originBare = originBareFixture.path; const originBare = originBareFixture.path;
await git(originBare, ["clone", "--bare", sourceRepo, originBare]); await git(originBare, [
"clone",
"--bare",
pathToFileURL(sourceRepo).toString(),
".",
]);
// Simulate checkout PR in github action // Simulate checkout PR in github action
await using checkoutRepoFixture = await createFixture(); await using checkoutRepoFixture = await shallowClone(originBare);
const checkoutRepo = checkoutRepoFixture.path; const checkoutRepo = checkoutRepoFixture.path;
await git(checkoutRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(originBare).toString(),
checkoutRepo,
]);
// Simulate remote fork bare git server // Simulate remote fork bare git server
await using forkBareFixture = await createFixture(); await using forkBareFixture = await testdir();
const forkBare = forkBareFixture.path; const forkBare = forkBareFixture.path;
await git(forkBare, ["clone", "--bare", originBare, forkBare]); await git(forkBare, [
await using forkRepoFixture = await createFixture();
const forkRepo = forkRepoFixture.path;
await git(forkRepo, [
"clone", "clone",
"--depth", "--bare",
"1", pathToFileURL(originBare).toString(),
"--branch", ".",
"main",
pathToFileURL(forkBare).toString(),
forkRepo,
]); ]);
await using forkRepoFixture = await shallowClone(forkBare);
const forkRepo = forkRepoFixture.path;
await git(forkRepo, ["config", "user.name", "Test User"]); await git(forkRepo, ["config", "user.name", "Test User"]);
await git(forkRepo, ["config", "user.email", "test@example.com"]); await git(forkRepo, ["config", "user.email", "test@example.com"]);
await git(forkRepo, ["checkout", "-b", "feature"]); await git(forkRepo, ["checkout", "-b", "feature"]);
+1 -16
View File
@@ -5,6 +5,7 @@ import path from "node:path";
import type * as github from "@actions/github"; import type * as github from "@actions/github";
import { isRepoShallow } from "@changesets/git"; import { isRepoShallow } from "@changesets/git";
import { exec } from "tinyexec"; import { exec } from "tinyexec";
import { moveDisposable, type WithAsyncDispose } from "../utils.ts";
type PullRequestContext = NonNullable< type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request typeof github.context.payload.pull_request
@@ -122,22 +123,6 @@ 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( export async function getPullRequestWorktree(
context: PullRequestContext, context: PullRequestContext,
cwd: string = process.cwd(), cwd: string = process.cwd(),
+6 -5
View File
@@ -7,6 +7,7 @@ import {
downloadArtifact, downloadArtifact,
getOptionalInput, getOptionalInput,
getRequiredInput, getRequiredInput,
validateChangesetsCliVersion,
} from "../utils.ts"; } from "../utils.ts";
try { try {
@@ -16,6 +17,9 @@ try {
} }
async function main() { async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const githubToken = getRequiredInput("github-token"); const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script"); const script = getOptionalInput("script");
const packDirArtifactId = getOptionalInput("pack-dir-artifact-id"); const packDirArtifactId = getOptionalInput("pack-dir-artifact-id");
@@ -30,11 +34,8 @@ async function main() {
); );
} }
// If the user needs to change the cwd, set `working-directory` in the step instead // The publish sub-action always uses the GitHub API for tag pushes.
const cwd = process.cwd(); 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 const fromPackDir = packDirArtifactId
? await downloadArtifact( ? await downloadArtifact(
+40
View File
@@ -0,0 +1,40 @@
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",
]);
});
});
+3 -3
View File
@@ -14,11 +14,11 @@ export default async function readChangesetState(
let changesets = await readChangesets(cwd); let changesets = await readChangesets(cwd);
if (preState !== undefined && preState.mode === "pre") { if (preState !== undefined && preState.mode === "pre") {
let changesetsToFilter = new Set(preState.changesets);
return { return {
preState, preState,
changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)), changesets: changesets.filter(
(changeset) => !changeset.id.startsWith("pre/"),
),
}; };
} }
+90 -6
View File
@@ -1,10 +1,13 @@
import path from "node:path"; import path from "node:path";
import * as core from "@actions/core";
import * as github from "@actions/github";
import type { Changeset } from "@changesets/types"; import type { Changeset } from "@changesets/types";
import { writeChangeset } from "@changesets/write"; import { writeChangeset } from "@changesets/write";
import { createFixture } from "fs-fixture"; import { exec } from "tinyexec";
import { beforeEach, describe, expect, it, vi } from "vitest"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { GitHub } from "./github.ts"; import { GitHub } from "./github.ts";
import { runVersion } from "./run.ts"; import { runPublish, runVersion } from "./run.ts";
import { gitdir } from "./test-utils.ts";
vi.mock("@actions/github", () => ({ vi.mock("@actions/github", () => ({
context: { context: {
@@ -20,6 +23,12 @@ vi.mock("@actions/github", () => ({
graphql: mockedGraphql, 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("@changesets/ghcommit"); vi.mock("@changesets/ghcommit");
let mockedGithubMethods = { let mockedGithubMethods = {
@@ -36,7 +45,7 @@ let mockedGraphql = vi.fn();
const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules"); const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules");
function createSimpleProjectFixture() { function createSimpleProjectFixture() {
return createFixture({ return gitdir({
node_modules: (api) => api.symlink(nodeModulesDir), node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({}), ".changeset/config.json": JSON.stringify({}),
"packages/pkg-a/package.json": JSON.stringify({ "packages/pkg-a/package.json": JSON.stringify({
@@ -61,7 +70,7 @@ function createSimpleProjectFixture() {
} }
function createIgnoredPackageFixture() { function createIgnoredPackageFixture() {
return createFixture({ return gitdir({
node_modules: (api) => api.symlink(nodeModulesDir), node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({ ".changeset/config.json": JSON.stringify({
ignore: ["changesets-dev-ignored-package-pkg-a"], ignore: ["changesets-dev-ignored-package-pkg-a"],
@@ -95,17 +104,85 @@ const createGithub = (cwd: string) =>
new GitHub({ new GitHub({
cwd, cwd,
githubToken: "@@GITHUB_TOKEN", githubToken: "@@GITHUB_TOKEN",
commitMode: "github-api", pushWithGitCli: false,
}); });
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(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
resetGithubContext();
});
afterEach(() => {
vi.unstubAllEnvs();
});
describe("publish", () => {
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({
script: 'node -e "void 0"',
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
});
expect(result).toEqual({ published: false, exitCode: 0 });
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining(
"GitHub releases and git tags cannot be created without this output",
),
);
});
it("throws when the built-in publish command does not create the output file", async () => {
await using fixture = await gitdir({
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
type: "module",
}),
"node_modules/@changesets/cli/bin.js": "",
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
}),
"package-lock.json": "",
});
const cwd = fixture.path;
await updateGithubContext(cwd);
vi.stubEnv("RUNNER_TEMP", cwd);
await expect(
runPublish({
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
}),
).rejects.toThrow("Failed to read changesets output at");
});
}); });
describe("version", () => { describe("version", () => {
it("creates simple PR", async () => { it("creates simple PR", async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -143,6 +220,7 @@ describe("version", () => {
it('creates a draft PR when prDraft is "create"', async () => { it('creates a draft PR when prDraft is "create"', async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -177,6 +255,7 @@ describe("version", () => {
it("only includes bumped packages in the PR body", async () => { it("only includes bumped packages in the PR body", async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -210,6 +289,7 @@ describe("version", () => {
it("doesn't include ignored package that got a dependency update in the PR body", async () => { it("doesn't include ignored package that got a dependency update in the PR body", async () => {
await using fixture = await createIgnoredPackageFixture(); await using fixture = await createIgnoredPackageFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -243,6 +323,7 @@ describe("version", () => {
it("does not include changelog entries if full message exceeds size limit", async () => { it("does not include changelog entries if full message exceeds size limit", async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -300,6 +381,7 @@ 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 () => { it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -357,6 +439,7 @@ 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 () => { it('updates an existing PR via GraphQL without converting it to draft when prDraft is "create"', async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
@@ -389,6 +472,7 @@ 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 () => { it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
await using fixture = await createSimpleProjectFixture(); await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path; const cwd = fixture.path;
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
+25 -7
View File
@@ -79,6 +79,8 @@ type ChangesetsOutputEvent = {
packageName: string; packageName: string;
}; };
class ChangesetsOutputReadError extends Error {}
type PublishResult = type PublishResult =
| { | {
published: true; published: true;
@@ -113,9 +115,10 @@ async function readChangesetsOutput(outputPath: string) {
try { try {
rawOutput = await fs.readFile(outputPath, "utf8"); rawOutput = await fs.readFile(outputPath, "utf8");
} catch (err) { } catch (err) {
throw new Error(`Failed to read changesets output at ${outputPath}`, { throw new ChangesetsOutputReadError(
cause: err, `Failed to read changesets output at ${outputPath}`,
}); { cause: err },
);
} }
const events: ChangesetsOutputEvent[] = []; const events: ChangesetsOutputEvent[] = [];
@@ -161,6 +164,10 @@ export async function runPublish({
cwd, cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
const { octokit } = github; 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; let changesetPublishOutput: ExecOutput;
const outputFile = path.join( const outputFile = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())), process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
@@ -195,7 +202,18 @@ export async function runPublish({
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x])); let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x]));
let output = await readChangesetsOutput(outputFile); let output: ChangesetsOutputEvent[];
try {
output = await readChangesetsOutput(outputFile);
} catch (err) {
if (!script || !(err instanceof ChangesetsOutputReadError)) {
throw err;
}
core.warning(
`${err.message}. GitHub releases and git tags cannot be created without this output. Ensure the custom publish script passes CHANGESETS_OUTPUT to the Changesets CLI.`,
);
output = [];
}
let releases = output.map((event) => { let releases = output.map((event) => {
let pkg = packagesByName.get(event.packageName); let pkg = packagesByName.get(event.packageName);
if (pkg === undefined) { if (pkg === undefined) {
@@ -383,7 +401,7 @@ export async function runVersion({
head: `${context.repo.owner}:${versionBranch}`, head: `${context.repo.owner}:${versionBranch}`,
base: branch, base: branch,
}); });
core.info( core.debug(
`Existing pull requests: ${JSON.stringify( `Existing pull requests: ${JSON.stringify(
existingPullRequests.data, existingPullRequests.data,
null, null,
@@ -409,7 +427,7 @@ export async function runVersion({
}); });
if (existingPullRequests.data.length === 0) { if (existingPullRequests.data.length === 0) {
core.info("creating pull request"); core.info("Creating pull request");
const { data: newPullRequest } = await octokit.rest.pulls.create({ const { data: newPullRequest } = await octokit.rest.pulls.create({
base: branch, base: branch,
head: versionBranch, head: versionBranch,
@@ -425,7 +443,7 @@ export async function runVersion({
} else { } else {
const [pullRequest] = existingPullRequests.data; const [pullRequest] = existingPullRequests.data;
core.info(`updating found pull request #${pullRequest.number}`); core.info(`Updating found pull request #${pullRequest.number}`);
const convertPullRequestToDraftMutation = const convertPullRequestToDraftMutation =
prDraft === "always" prDraft === "always"
? ` ? `
+11 -5
View File
@@ -4,7 +4,11 @@ import path from "node:path";
import artifact from "@actions/artifact"; import artifact from "@actions/artifact";
import * as core from "@actions/core"; import * as core from "@actions/core";
import readChangesetState from "../readChangesetState.ts"; import readChangesetState from "../readChangesetState.ts";
import { execChangesetsCli } from "../utils.ts"; import {
execChangesetsCli,
getOptionalInput,
validateChangesetsCliVersion,
} from "../utils.ts";
type ModeResult = type ModeResult =
| { | {
@@ -27,7 +31,10 @@ try {
} }
async function main() { async function main() {
const result = await getMode(); const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const result = await getMode(cwd);
core.setOutput("mode", result.mode); core.setOutput("mode", result.mode);
if (result.mode === "publish") { if (result.mode === "publish") {
const publishPlanArtifact = await artifact.uploadArtifact( const publishPlanArtifact = await artifact.uploadArtifact(
@@ -48,8 +55,8 @@ async function main() {
} }
} }
async function getMode(): Promise<ModeResult> { async function getMode(cwd: string): Promise<ModeResult> {
const { changesets } = await readChangesetState(); const { changesets } = await readChangesetState(cwd);
if (changesets.length > 0) { if (changesets.length > 0) {
const hasNonEmptyChangesets = changesets.some( const hasNonEmptyChangesets = changesets.some(
@@ -61,7 +68,6 @@ async function getMode(): Promise<ModeResult> {
return { mode: "none" }; return { mode: "none" };
} }
const cwd = process.cwd();
const publishPlanPath = path.join( const publishPlanPath = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())), process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
`changeset-publish-plan-${Date.now()}`, `changeset-publish-plan-${Date.now()}`,
+293
View File
@@ -0,0 +1,293 @@
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,
});
}
+72 -2
View File
@@ -1,5 +1,12 @@
import { expect, test } from "vitest"; import { createFixture } from "fs-fixture";
import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts"; import { afterEach, expect, test, vi } from "vitest";
import {
BumpLevels,
getChangelogEntry,
sortTheThings,
throwOnRemovedCommitModeInput,
validateChangesetsCliVersion,
} from "./utils.ts";
let changelog = `# @keystone-alpha/email let changelog = `# @keystone-alpha/email
@@ -68,6 +75,10 @@ let changelog = `# @keystone-alpha/email
- Update mjml-dependency - Update mjml-dependency
`; `;
afterEach(() => {
vi.unstubAllEnvs();
});
test("it works", () => { test("it works", () => {
let entry = getChangelogEntry(changelog, "3.0.0"); let entry = getChangelogEntry(changelog, "3.0.0");
expect(entry.content).toMatchSnapshot(); expect(entry.content).toMatchSnapshot();
@@ -100,3 +111,62 @@ test("it sorts the things right", () => {
]; ];
expect(things.sort(sortTheThings)).toMatchSnapshot(); 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({
name: "project",
devDependencies: { "@changesets/cli": "^2.29.7" },
}),
"package-lock.json": "",
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
test("accepts a Changesets CLI v3 contract without an installed CLI", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
});
await expect(
validateChangesetsCliVersion(fixture.path),
).resolves.toBeUndefined();
});
test("throws when the project has Changesets CLI v2 installed", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
version: "2.29.7",
}),
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
+82 -5
View File
@@ -10,6 +10,8 @@ import {
type ExecOutput, type ExecOutput,
} from "@actions/exec"; } from "@actions/exec";
import { getPackages, type Package } from "@manypkg/get-packages"; import { getPackages, type Package } from "@manypkg/get-packages";
import major from "semver/functions/major.js";
import subset from "semver/ranges/subset.js";
const require = createRequire(import.meta.url); const require = createRequire(import.meta.url);
@@ -117,11 +119,20 @@ export function isErrorWithCode(err: unknown, code: string) {
); );
} }
export function fileExists(filePath: string) { export type WithAsyncDispose<T> = T & {
return fs.access(filePath, fs.constants.F_OK).then( [Symbol.asyncDispose](): Promise<void>;
() => true, };
() => false,
); 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 getOptionalInput(name: string) { export function getOptionalInput(name: string) {
@@ -135,6 +146,23 @@ export function getRequiredInput(name: string) {
return core.getInput(name, { required: true }); 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 throwOnRenamedInputs(renames: Record<string, string>) { export function throwOnRenamedInputs(renames: Record<string, string>) {
const references: Record<string, string> = {}; const references: Record<string, string> = {};
@@ -154,6 +182,55 @@ export function throwOnRenamedInputs(renames: Record<string, string>) {
} }
} }
const changesetsCliCompatibilityError =
"This version of the Changesets action is designed to work with Changesets CLI v3. " +
"Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.";
export async function validateChangesetsCliVersion(cwd: string) {
const { rootPackage } = await getPackages(cwd);
const packageJson = rootPackage?.packageJson;
const declaredVersion =
packageJson?.devDependencies?.["@changesets/cli"] ??
packageJson?.dependencies?.["@changesets/cli"];
if (typeof declaredVersion === "string") {
const range = declaredVersion.startsWith("workspace:")
? declaredVersion.slice("workspace:".length)
: declaredVersion;
let isV2 = false;
try {
isV2 = subset(range, ">=2.0.0-0 <3.0.0-0", {
includePrerelease: true,
});
} catch {
// it could be a non-semver protocol
}
if (isV2) {
throw new Error(changesetsCliCompatibilityError);
}
}
let cliPackageJson;
try {
cliPackageJson = require(
require.resolve("@changesets/cli/package.json", { paths: [cwd] }),
);
} catch {
return;
}
if (
typeof cliPackageJson.version === "string" &&
major(cliPackageJson.version) === 2
) {
throw new Error(changesetsCliCompatibilityError);
}
}
function resolveChangesetsCli(cwd: string) { function resolveChangesetsCli(cwd: string) {
return require.resolve("@changesets/cli/bin.js", { return require.resolve("@changesets/cli/bin.js", {
paths: [cwd], paths: [cwd],
+12 -16
View File
@@ -1,7 +1,12 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { GitHub } from "../github.ts"; import { GitHub } from "../github.ts";
import { runVersion } from "../run.ts"; import { runVersion } from "../run.ts";
import { getOptionalInput, getRequiredInput } from "../utils.ts"; import {
getOptionalInput,
getRequiredInput,
throwOnRemovedCommitModeInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try { try {
await main(); await main();
@@ -10,37 +15,28 @@ try {
} }
async function main() { async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
throwOnRemovedCommitModeInput();
const githubToken = getRequiredInput("github-token"); const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script"); const script = getOptionalInput("script");
const commitMessage = getRequiredInput("commit-message"); const commitMessage = getRequiredInput("commit-message");
const prTitle = getRequiredInput("pr-title"); const prTitle = getRequiredInput("pr-title");
const prDraft = getOptionalInput("pr-draft"); const prDraft = getOptionalInput("pr-draft");
const prBaseBranch = getOptionalInput("pr-base-branch"); const prBaseBranch = getOptionalInput("pr-base-branch");
const commitMode = getOptionalInput("commit-mode") ?? "git-cli"; const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
const setupGitUser = core.getBooleanInput("setup-git-user");
// Validations // Validations
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") { if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
throw new Error(`Invalid pr-draft input: ${prDraft}`); throw new Error(`Invalid pr-draft input: ${prDraft}`);
} }
if (commitMode !== "git-cli" && commitMode !== "github-api") {
throw new Error(`Invalid commit-mode input: ${commitMode}`);
}
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
const github = new GitHub({ const github = new GitHub({
cwd, cwd,
githubToken, githubToken,
commitMode, pushWithGitCli,
}); });
if (setupGitUser) {
core.info("setting git user");
await github.setupUser();
}
const { pullRequestNumber } = await runVersion({ const { pullRequestNumber } = await runVersion({
script, script,
github, github,
+41 -1
View File
@@ -1,3 +1,43 @@
# changesets/action/version # changesets/action/version
TODO 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
+10 -10
View File
@@ -5,7 +5,9 @@ runs:
main: ../dist/version.js main: ../dist/version.js
inputs: inputs:
github-token: github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided 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.
required: false required: false
default: ${{ github.token }} default: ${{ github.token }}
script: script:
@@ -25,18 +27,16 @@ inputs:
pr-base-branch: pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`." description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false required: false
commit-mode: push-with-git-cli:
description: > description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI, Whether to use the Git CLI instead of the GitHub API to push release commits.
or "github-api" to push changes via the GitHub API. When using "github-api", Defaults to `false`. When using the GitHub API, commits are signed using GitHub's
all commits and tags are signed using GitHub's GPG key and attributed to the user GPG key and attributed to the user or app that owns the `github-token`.
or app who owns the GITHUB_TOKEN.
required: false required: false
default: "git-cli" default: false
setup-git-user: cwd:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true` description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false required: false
default: true
outputs: outputs:
pr-number: pr-number:
description: The pull request number that was created or updated description: The pull request number that was created or updated