Compare commits

...
128 Commits
Author SHA1 Message Date
github-actions[bot] 8f7aee55a0 v2.0.0-next.2 2026-06-24 10:38:52 +00:00
changesets-org-version-bot[bot]andgithub-actions[bot] b12c36a7bf Version Packages (next) (#671)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-24 10:28:35 +00:00
Mateusz Burzyński 5a8b9b721b Avoid putting the github token in the global .netrc file (#670)
* Avoid putting the github token in the global `.netrc` file

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

* introduce `getRequiredInput`

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

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

* fmt

---------

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

* Rename

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

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

* Rename base-branch to pr-base-branch

* add `pack` subaction

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

* rename CLI arg

* update rolldown config

* rename pack dir input/output

* tweak retendion days

---------

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


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

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

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

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

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


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

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

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

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

* Fix

* Update permissions

* Apply suggestions from code review

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

* comment

---------

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

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

* Update README with pull_request_target caution

Added caution about using pull_request_target and alternative options.

* update wording for executing untrusted code

* Format

---------

Co-authored-by: bluwy <bjornlu.dev@gmail.com>
2026-06-08 15:05:55 +00:00
github-actions[bot] b459b1eaa0 Version Packages (#637)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-03 07:02:05 +00:00
Mateusz Burzyński f9585d966a Update @changesets/ghcommit (#645)
* Update `@changesets/ghcommit`

* add changeset

* update ghcommit more
2026-06-02 13:54:38 +00:00
Mateusz Burzyński 020e8cc600 Use internal bot for versioning (#643)
* Use internal bot for versioning

* tweak `CODEOWNERS`
2026-06-02 10:22:42 +02:00
Bjorn Lu b072bccc4c Add simple PR comment sub-action (#636)
* Add simple PR comment sub-action

* Update rolldown config

* Add changeset

* Update readme

* Use TLA

* Add prefix

* fix merge

* Update
2026-05-30 19:39:39 +00:00
Bjorn LuandMateusz Burzyński 8795eee5ee Comment changeset status in PRs (#625)
* Initial implementation

* Fix

* fix

* fix

* Make it look nicer

* Update docs

* Rename to pr-status-comment

* Remove outputs

* Update path

* update name

* Checkout PR in a detached worktree (#626)

Co-authored-by: bluwy <bjornlu.dev@gmail.com>

* Move comment to separate job

* Loosen event requirement

* Update

* Apply suggestions from code review

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

* Use TLA

* use using

* Remove test log

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-29 12:27:24 +00:00
Mateusz BurzyńskiandBjorn Lu 34f64f6e2e Fixed an issue with GitHub releases not being created for successfully published packages when some packages failed to be published (#535)
* Fixed an issue with GitHub releases not being created for successfully published packages when some packages failed to be published

* Format

---------

Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
2026-05-29 06:48:06 +00:00
Bjorn Lu 1d54b9e660 Simplify getChangelogEntry (#632) 2026-05-27 15:41:11 +00:00
Bjorn Lu 031358f743 Update to typescript v6 (#633) 2026-05-25 17:30:08 +00:00
dependabot[bot] a0c05f7a4b Bump @changesets/changelog-github from 0.5.2 to 0.7.0 (#620)
Bumps [@changesets/changelog-github](https://github.com/changesets/changesets) from 0.5.2 to 0.7.0.
- [Release notes](https://github.com/changesets/changesets/releases)
- [Commits](https://github.com/changesets/changesets/compare/@changesets/read@0.5.2...@changesets/changelog-github@0.7.0)

---
updated-dependencies:
- dependency-name: "@changesets/changelog-github"
  dependency-version: 0.7.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-05-25 14:51:47 +00:00
Bjorn Lu a245e45ca5 Update non-breaking deps and minimumReleaseAgeExclude (#631) 2026-05-25 09:44:51 +00:00
Bjorn Lu e0c90aa7fb Fix version/publish arg parsing (#629) 2026-05-25 09:12:32 +00:00
Bjorn Lu d67d8d8799 Run format lint in CI (#630) 2026-05-25 09:11:00 +00:00
Bjorn Lu f1222b6286 Refactor to fs-fixture (#622) 2026-05-18 10:03:43 +00:00
Mateusz Burzyński 87481d361e Add shellEmulator to pnpm-workspace.yaml (#624) 2026-05-16 15:41:11 +00:00
Bjorn Lu e33c0e699d Update vscode settings (#623)
* Update vscode settings

* Update launch.json
2026-05-15 19:04:24 +00:00
Bjorn LuandMateusz Burzyński c13a48983a Use rolldown for bundling (#621)
* Use rolldown for bundling

* update vite

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-15 19:01:37 +00:00
Bjorn Lu 6c80731937 Migrate to oxfmt (#618)
* Migrate to oxfmt

* Enable import sorting

* trailingComma always
2026-05-15 11:48:55 +00:00
Mateusz Burzyński 03ba888eb8 Add zizmor workflow (#617)
* Add `zizmor` workflow

* fix issues

* fix one thing

* add permission comments

* add job names

* move zizmor to CI
2026-05-15 10:16:37 +00:00
Bjorn Lu aec1f01000 Update vitest to v4 (#619) 2026-05-15 08:53:32 +00:00
Marco PasqualettiandMateusz Burzyński 04ba326779 migrate to pnpm (#609)
* migrate to `pnpm`

* rename `simple-project` fixture packages to remove socket security errors

* add pnpm `dedupe` options

* update release-pr workflow

* update

* update snashots

* tweaks

* tweak

* tweak

* fix missing ci-setup

* tweak

* tweak deps

* update pnpm

* ok, Socket, let's rename them

* update snapshots

* rename again

* fmt

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-14 09:04:38 +00:00
Mateusz Burzyński ccba80bb5a Fix the ability to create GitHub releases in our own workflow (#614) 2026-05-07 10:05:44 +00:00
github-actions[bot]andMateusz Burzyński 84c24326ac Version Packages (#598)
* Version Packages

* add missing PR reference

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-07 09:43:16 +00:00
f5dbf72f96 Add draft mode support (#258)
* Add draft mode support

* Add doc

* fmt

* add it to action.yml

* fix bad merge?

* tweak changeset

* refactor

---------

Co-authored-by: Emma Hamilton <mitchell@hamil.town>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-07 11:35:24 +02:00
Mateusz Burzyński 91b911142e Protect publishes with env gate (#610)
* Protect publishes with env gate

* tweak CODEOWNERS and release-pr

* remove redundant permission

* fix syntax

* Use app with protection bypass for publishing

* handle forks better

* remove redundant permission
2026-05-07 09:16:30 +00:00
Mateusz Burzyński d4c53c2943 Fix CODEOWNERS pattern 2026-04-03 10:49:07 +02:00
Mateusz Burzyński 2ae596f3dd Tweak CI setup (#599) 2026-04-01 09:17:56 +02:00
Mateusz Burzyński 0784b0ec8f Add CODEOWNERS 2026-04-01 09:00:07 +02:00
Rafi AdnanandMateusz Burzyński 81b3f61ebf Fixed .changeset state being picked for the version command when cwd parameter is provided (#536)
* actually use cwd parameter when reading changeset state

* tweak changeset

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-03-31 17:47:34 +02:00
Oleksii ShytikovandMateusz Burzyński 6002dbd987 Fix reading .changeset directory from path provided in cwd parameter (#502)
* Adding informational message about resolved `cwd` location

* Reading changesets information from provided folder

* Adding changeset information

* Apply suggestion from @Andarist

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-03-31 17:38:41 +02:00
github-actions[bot] a7c500273b Version Packages (#565)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-12 12:25:27 +01:00
Mateusz Burzyński 935fe876b0 Automatically use the GitHub-provided token to allow most users to avoid explicit GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} configuration (#564) 2026-01-29 09:35:17 +01:00
Mateusz Burzyński 6af4a7ec08 Don't error on symlinks and executables when they don't have to be touched anyway (#563)
* Don't error on symlinks and executables when they don't have to be touched anyway

* tweak range
2026-01-28 09:02:44 +01:00
Mateusz Burzyński 746b247c1c Tweak logging related to NPM_TOKEN/OIDC auth (#566) 2026-01-28 07:35:01 +01:00
54220dd92c Conditionally append NPM_TOKEN to .npmrc (#545)
* fix: conditionally append NPM_TOKEN to .npmrc for trusted publishing support

The .npmrc generation now intelligently handles both traditional NPM token
authentication and trusted publishing scenarios:

- Only appends auth token to .npmrc when NPM_TOKEN is defined (not undefined)
- Uses strict comparison (!== undefined) instead of truthy checks
- Provides informative logging when no NPM_TOKEN is present
- Maintains full backward compatibility with existing workflows

This fixes issues with trusted publishing where OIDC tokens from GitHub
Actions are used instead of NPM_TOKEN, preventing 'undefined' from being
written to the registry auth configuration.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Update src/index.ts

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

* simplify

* tweak changeset

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-01-27 23:14:11 +01:00
github-actions[bot] 5e0dfa5699 Version Packages (#559)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-01-21 13:28:01 +01:00
Harsha VenugopalandMateusz Burzyński 342005d412 Upgrade from Node.js 20 to Node.js 24 LTS (#558)
* migrate nodejs from 20 to 24

* chore: update changeset

* Update .changeset/tall-flowers-fry.md

* Update .changeset/tall-flowers-fry.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-01-21 13:25:38 +01:00
github-actions[bot] 04d574e831 Version Packages (#480)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-05-17 18:42:20 +02:00
Mateusz Burzyński 08db198428 Fixed missed __dirname reference (#496) 2025-05-16 12:29:46 +02:00
Mateusz Burzyński 1ae3a21f70 Switch to bundling with Rollup (#495) 2025-05-16 12:25:02 +02:00
Mateusz Burzyński 5078b4b48b Migrate to ESM (#484)
* Migrate to ESM

* just use `require.resolve`

* reuse setup action

* checkout PR head for a sec

* ls things

* try a thing

* the dirname had a trailing whitespace, lol
2025-05-16 11:39:43 +02:00
Sam LanningandMateusz Burzyński 7ed1955546 Fixed situations in which cwd was specified as a relative path and used with (default) commitMode: git-cli (#486)
* fix: use latest ghcommit and fix cwd for git-cli

- `cwd` was not working correctly when commitMode was set to `git-cli`,
  as it was attempting to resolve the `cwd` twice.
  (This problem only occured when specifying a relative path for `cwd`.)
- Update `ghcommit`, and avoid calling `process.chdir()` to change the
  working directory. Instead, we now pass the `cwd` option everywhere.

fixes #475

* simplify

* Apply suggestions from code review

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-16 11:25:00 +02:00
Jake PelterandMateusz Burzyński 9690d7b6f2 Add LICENSE file (#491)
* add license file

* Update LICENSE

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-15 21:55:11 +02:00
Sam LanningandMateusz Burzyński 022692ba02 Fix PRs sometimes not getting reopened with commitMode: github-api (#488)
* Fix PRs sometimes not getting reopened

There was a race-condition that means sometimes
existing PRs would not be found,
and new PRs would be opened.
This has now been fixed by fetching existing PRs
before making any changes.

fixes #487

* Apply suggestions from code review

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-15 21:46:15 +02:00
Mateusz Burzyński 0564b8428f Removed fs-extra dependency (#481)
* Removed `fs-extra` dependency

* use `fs/promises` consistently
2025-05-15 21:41:09 +02:00
Mateusz Burzyński 9f7e23e7ee Setup Git user in release-pr workflow (#493) 2025-05-15 10:31:07 +02:00
Mateusz Burzyński 10ea96defe Use proper ndoe version in release-pr workflow (#492) 2025-05-15 10:22:33 +02:00
Mateusz Burzyński f6369c112a Add release-pr workflow (#490)
* Add `release-pr` workflow

* Add comments

* fix quotes
2025-05-15 09:42:54 +02:00
Mateusz Burzyński e82f42c2cc Migrate to Vitest (#483)
* Migrate to Vitest

* `skipLibCheck` for now
2025-05-11 20:59:28 +02:00
Mateusz Burzyński cf373e45c9 Switch to esbuild for bundling (#479)
* Switch to esbuild for bundling

* add changeset
2025-05-11 20:55:50 +02:00
Mateusz Burzyński ad037f48d0 Import only for semver/functions/lt (#482) 2025-05-11 12:21:44 +02:00
Younsang NaandMateusz Burzyński e9c36b6964 Avoid hitting a deprecation warning when encountering errors from @octokit/request-error (#461)
* fix: use status when http err

* tweak code

* add changeset

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-11 11:15:02 +02:00
Mateusz Burzyński c1f57e52f9 Run typecheck on CI (#478) 2025-05-11 11:01:53 +02:00
Mateusz Burzyński 9d933dcd11 Updated @actions/* and @octokit/* dependencies (#477) 2025-05-11 11:01:10 +02:00
dependabot[bot] b4d99d774e Bump @babel/runtime from 7.21.5 to 7.27.1 (#464)
Bumps [@babel/runtime](https://github.com/babel/babel/tree/HEAD/packages/babel-runtime) from 7.21.5 to 7.27.1.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.27.1/packages/babel-runtime)

---
updated-dependencies:
- dependency-name: "@babel/runtime"
  dependency-version: 7.27.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-10 23:27:40 +02:00
github-actions[bot] 42d5417623 Version Packages (#476)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-05-10 13:25:20 +02:00
Sam LanningandMateusz Burzyński 3c24abeab2 Make git add work consistently with subdirectories (#473)
* Make git add work consistently with subdirectories

Currently, depending on your `commitMode`,
when running the action with `cwd` set to a subdirectory of a repo,
the action will either:

- `git-cli`: add the files changed in the subdirectory only
- `github-api`: add files changed anywhere in the repository

This commit brings github-api in line with git-cli,
so that it only adds files in the current working directory.

* Explicitly set `cwd` for all exec calls

* Avoid using `ExecOptions` from `@actions/exec`

* Rename type

* remove redundant `filter`

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-10 12:34:27 +02:00
github-actions[bot] 7f0270e8f4 Version Packages (#468)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-05-08 15:25:41 +02:00
Herman JensenandMateusz Burzyński 15ab130606 Bump @changesets/ghcommit to v1.4.0 (#471)
* fix: bump @changesets/ghcommit to v1.4.0

* Update .changeset/dry-bugs-applaud.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-08 15:22:42 +02:00
Vx-VandMateusz Burzyński 6e575506e6 Do not pre-start github API request (#467)
* Do not pre-start github API request

* Create quiet-jeans-poke.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-06 23:07:15 +02:00
github-actions[bot] 5f15b43b42 Version Packages (#463)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-05-05 10:16:36 +02:00
Sam LanningandMateusz Burzyński 207dc3da2d Introduce an option to use the GitHub API to commit changes, for GPG (#391)
* Create tags on GitHub using API

To allow for signed tags to be created,
rather than use the git CLI to push tags,
manually push each tag using the GitHub API,
which will sign the tag using the built-in GitHub GPG key.

* Use ghcommit to push changes

To allow for all commits to be signed,
use the GitHub API to push changes.

* Add changeset version

* Allow tag publish to fail, assume it was manually published

* Add to changeset

* Update @s0/ghcommit

* Update ghcommit to fix missing ref bug

* Make using GitHub API Optional

Change this to a minor version bump,
with a new feature that allows for using the
GitHub API to create tags and commits.

* Use a strategy pattern for GitHub API vs CLI usage

* refactor git interactions

* fix mock thing

* usechangesets pkg

* switch to `commitMode`

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-02 15:32:14 +02:00
Changwan bd5d1d2a62 Remove unused variable (#460)
* unused variable

* double negative var

* Revert "double negative var"

This reverts commit 13cd17e381.
2025-04-22 07:22:46 +02:00
github-actions[bot] ff7179cf12 Version Packages (#449)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-03-10 11:53:19 +01:00
Bjorn Lu 8b16070fe3 Use full git email for github-actions bot (#448)
* Use full git email for github-actions bot

* Create fluffy-clocks-knock.md
2025-03-10 11:42:00 +01:00
Zachary Cowan 07dc948a9f Add Dependabot config file (#432) 2024-12-14 14:40:37 +01:00
github-actions[bot]andgithub-actions[bot] 31ff97e8ac Version Packages (#416)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-10-14 19:12:43 +02:00
Ben McCann 57ab80c611 Improve error message when attempting to publish without publish script defined (#415)
* Improve error message when attempting to publish without publish script defined

* Update src/index.ts

* Update src/index.ts
2024-10-14 18:44:02 +02:00
github-actions[bot]andgithub-actions[bot] 50750fa876 Version Packages (#394)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-08-26 19:01:26 +02:00
48ab0d2f2e Switch to pull request list API instead of search (#393)
* Switch to pull request list API instead of search

To reduce the amount of rate-limit that we use,
switch to a cheaper API for determining whether
an existing PR exists for a given branch.

* Ensure PR remains open when updating description

* Update .changeset/clean-bees-count.md

Co-authored-by: willo-icon <161356817+willo-icon@users.noreply.github.com>

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
Co-authored-by: willo-icon <161356817+willo-icon@users.noreply.github.com>
2024-08-26 18:38:29 +02:00
Thomas Beer 89b41e6c69 Fix typos in README.md (#384) 2024-07-30 15:02:29 +02:00
Trivikram Kamat c62ef9792f Use latest versions of checkout and setup-node actions (#359) 2024-03-26 21:11:40 +01:00
github-actions[bot]andgithub-actions[bot] 63ffd93140 Version Packages (#357)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-03-19 12:11:08 +10:00
Ernesto García f2660aa7e7 Feature: Allow custom branch (#255) 2024-03-19 08:57:05 +10:00
github-actions[bot]andgithub-actions[bot] e245972e63 Version Packages (#351)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-02-16 11:37:28 +01:00
m-shakaandMateusz Burzyński 9385be9e75 Bump node.js to 20 on the CI (#350)
* chore: bump nodejs from 16 to 20

* Create kind-sheep-grab.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2024-02-16 11:35:19 +01:00
Mateusz Burzyński 2bb9bcbd6b Update semver package (#307) 2023-06-23 13:19:12 +02:00
github-actions[bot]andgithub-actions[bot] cbef32198f Version Packages (#305)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-06-23 12:57:14 +02:00
Mark OmarovandMateusz Burzyński eb19e25e77 Updated a few dependencies to patch the security vulnerabilities that were reported for their older versions (#282)
* fix: patch vulnerabilities

* chore: add changeset

* fix: dependabot reported vulnerabilities

* Cleanup resolutions

* tweak changeset

* Update .changeset/wicked-apes-watch.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2023-06-23 12:55:59 +02:00
Mateusz Burzyński 49f9bd750b Upgrade @octokit/plugin-throttling and fix type errors (#294) 2023-05-14 16:56:41 +02:00
github-actions[bot]andgithub-actions[bot] 28271921f0 Version Packages (#292)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-05-10 07:26:55 +02:00
Mateusz Burzyński ba5ea93f34 Replace Parcel with ncc 2023-05-09 17:44:11 +02:00
Mateusz Burzyński 4e64830a00 Update Jest 2023-05-09 17:32:35 +02:00
Viktor VarlandandMateusz Burzyński db8a1099bc Wire up @octokit/plugin-throttling with all GitHub Octokit instances (#291)
* fix: use throttling-wired octokit everywhere

* test: fix run.test.ts

* Update .changeset/new-worms-knock.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2023-05-09 17:21:08 +02:00
github-actions[bot]andgithub-actions[bot] 4cb1c2fbde Version Packages (#290)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-05-09 06:47:54 +02:00
Viktor VarlandandMateusz Burzyński 8b2818674d Use logging provided by @actions/core (#289)
* chore: migrate to logging from @actions/core

* Update src/index.ts

* Update .changeset/blue-hornets-marry.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2023-05-08 23:42:00 +02:00
github-actions[bot]andgithub-actions[bot] ab485bff43 Version Packages (#288)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-05-06 11:20:22 +02:00
Viktor VarlandandMateusz Burzyński 225a1e8cbc Add a throttling plugin to the used Octokit instance to retry requests after hitting secondary rate limits (#286)
* fix: prevent hitting github secondary rate limits

Adds the octokit plugin for throttling / rate-limiting to fix the
problem where action runs get blocked with a 403 error[1].

The `github.getOctokit`[2] function accepts a list of plugins, so this
passes in the `throttling` plugin[3] to be hooked into the octokit
instance.

It also needs some configuration to setup the `throttle` mechanisms,
passed in to the `getOctokit` function.

[1]: https://github.com/changesets/action/issues/192
[2]: https://github.com/actions/toolkit/blob/main/packages/github/src/github.ts#LL18C40-L18C40
[3]: https://github.com/octokit/plugin-throttling.js

* refactor: change rate limit callback signatures

Based on additional docs, the callbacks seem to have changes to their
signatures[1]. This change aligns this implementation with the docs[2].

[1]: https://octokit.github.io/rest.js/v19#throttling
[2]: https://github.com/octokit/plugin-throttling.js/blob/v5.1.1/src/index.ts#L90-L91

* chore: add changeset

* wire up typed throttle options

* Upgrade TS

* refactor: use console based logging

* Update .changeset/rotten-carrots-pump.md

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2023-05-06 10:52:18 +02:00
Mateusz Burzyński 595655c3ea Update more examples with references to the latest versions of core actions 2022-12-05 14:55:10 +01:00
allbetter-max da3a687419 Update examples in the docs to use new versions of other core actions like checkout and setup-node (#237) 2022-12-05 14:53:04 +01:00
github-actions[bot]andgithub-actions[bot] c831d73dde Version Packages (#232)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-11-08 10:30:21 +01:00
Mateusz Burzyński b78f480998 Upgrade @actions/* dependencies (#123)
* Upgrade `@actions/*` dependencies

* bumps deps again

* add changeset
2022-11-08 10:26:23 +01:00
github-actions[bot]andgithub-actions[bot] ca3c2e0bbf Version Packages (#208)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-11-02 10:27:24 +01:00
Ian SandersandMateusz Burzyński bff53cc50c Add is:pull-request to search query when looking for existing PR (#228)
* Add `is:pull-request` to search query when looking for existing PR

* Create sharp-pens-matter.md

* Update .changeset/sharp-pens-matter.md

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-11-02 10:23:46 +01:00
David GlasserandMateusz Burzyński 8ec7804f3e Create changeset for #216 (#223)
* Create changeset for #216

* Tweak changeset

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-11-02 10:18:49 +01:00
Quinn J NeumiillerandMateusz Burzyński 398d7edfb1 Use node16 (#216)
* Use node16 in actions

* fixup! Use node16 in actions

* remove `engines.npm`

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-09-15 10:36:58 +02:00
David GlasserandMateusz Burzyński 8c3f5f5637 Skip creating a PR when all existing changesets are empty (#206)
* Don't create a PR if all changesets are empty

Fixes #205.

Note that this maintains the previous behavior that if there are any
changesets (even empty ones), the action does not publish packages.

* Create three-needles-protect.md

* Update .changeset/three-needles-protect.md

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-08-18 23:10:27 +02:00
Brian Espinosa 6a46d2c283 Update README to reference baseBranch, use "main" as default in examples (#180)
* chore(docs): Update README to reference baseBranch

- Adds reference to the `baseBranch` config in the Changesets docs
- Updates all references in examples to `main` instead of `master`
  - `main` is now the default branch in new GitHub projects
  - This change aligns with the comment in the `baseBranch` section of Changesets docs

* remove commit sha from docs URL
2022-06-11 10:00:48 +02:00
Patrick McElhaney fa2875d617 Remove unnecessary email config from README (#186)
The `email=my@email.com` line isn't necessary. It doesn't seem to be a real configuration option and as far as I can tell npm ignores it. 

fixes #185
2022-05-24 13:39:08 +02:00
John Undersander 5252f6fe5d Document createGithubReleases input (#165) 2022-05-16 15:34:21 +10:00
github-actions[bot]andgithub-actions[bot] 3914e56b03 Version Packages (#169)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-05-10 11:11:10 +02:00
Nicola MolinariandMateusz Burzyński 521c27bf86 Automatically adjust GitHub PR message if it exceeds a size limit of 60k characters by omitting some of the changelog information (#157)
* fix: body max length

* docs: improve logs

* docs: changeset

* refactor: changeset message to omit some info if message exceeds size limit

* refactor: minor adjustments based on feedback

* Apply nits from code review

* Fixed tests

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-05-10 11:06:04 +02:00
Mateusz Burzyński 2ccdaef0d0 Change trigger's event type to pull_request in the CI action (#181) 2022-05-10 10:39:50 +02:00
Royston Shufflebotham 26d7bf0c4b Remove suggestions of using fetch-depth: 0 (#177)
Changesets automatically deepens a shallow clone as necessary,
so we don't need to recommend a complete deep clone in order
for changsets to work.

Fixes: #97
2022-04-29 12:53:40 +02:00
David RegisterandMateusz Burzyński 993a0a090d Added pullRequestNumber to the action's outputs (#167)
* feat: set pullRequesstNumber as action output

* chore: add changeset

* fix: feedback from pr review

* Update .changeset/long-mayflies-yell.md

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

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-04-07 19:10:26 +02:00
github-actions[bot] c7c59f0c6f Version Packages (#163) 2022-03-15 15:11:12 +01:00
Russell Bicknell 52c9ce75d9 Change directory to cwd before running git user setup. (#161) 2022-03-15 15:07:12 +01:00
Will WeaverandMateusz Burzyński b0aaf6aed5 Document hasChangesets output (#136)
* Add shouldPublish output

* Update README.md

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

* Remove changeset

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-03-14 15:27:53 +01:00
Mateusz Burzyński 5766bae8d9 Add concurrency to the local Changesets workflow 2022-03-04 10:27:57 +01:00
90 changed files with 7330 additions and 10254 deletions
-6
View File
@@ -1,6 +0,0 @@
{
"presets": [
["@babel/preset-env", { "targets": { "node": 10 } }],
"@babel/preset-typescript"
]
}
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": minor
---
Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Removed compatibility support for old Changesets v1.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": major
---
Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
+17
View File
@@ -0,0 +1,17 @@
{
"mode": "pre",
"tag": "next",
"initialVersions": {
"@changesets/action": "1.9.0"
},
"changesets": [
"all-cars-grin",
"eight-clocks-pull",
"eighty-doors-swim",
"git-cli-auth-header",
"git-cli-server-url",
"lemon-turtles-itch",
"ready-mangos-boil",
"silent-tips-dance"
]
}
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
+5
View File
@@ -0,0 +1,5 @@
---
"@changesets/action": patch
---
Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
+5
View File
@@ -0,0 +1,5 @@
/.github/workflows/** @Andarist @bluwy @emmatown
/action.yml @Andarist @bluwy @emmatown
/scripts/bump.ts @Andarist @bluwy @emmatown
/scripts/release.ts @Andarist @bluwy @emmatown
/scripts/release-pr.ts @Andarist @bluwy @emmatown
+24
View File
@@ -0,0 +1,24 @@
name: Setup CI
description: Setup CI
inputs:
skip-cache:
description: "Whether to skip the cache"
required: false
default: "false"
runs:
using: composite
steps:
- name: Set up pnpm
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version-file: ".node-version"
package-manager-cache: ${{ inputs.skip-cache != 'true' }}
cache: ${{ inputs.skip-cache != 'true' && 'pnpm' || '' }}
- name: Install dependencies
shell: bash
run: pnpm install --frozen-lockfile
+32
View File
@@ -0,0 +1,32 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "monthly"
cooldown:
default-days: 7
open-pull-requests-limit: 10
versioning-strategy: increase
groups:
production-dependencies:
dependency-type: "production"
update-types:
- minor
- patch
development-dependencies:
dependency-type: "development"
update-types:
- minor
- patch
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
cooldown:
default-days: 7
open-pull-requests-limit: 5
groups:
github-actions:
patterns:
- "*"
+85 -15
View File
@@ -1,24 +1,94 @@
name: Node CI name: CI
on: [push] on:
pull_request:
# merge queue is required so all commits on target branches trigger this workflow
# despite lack of the push event trigger here
merge_group:
branches:
- main
- next
# merge group rulesets don't allow wildcards so in settings each maintenance branch needs to be added separately
- "maintenance/v*" # branch rulesets don't support v[0-9]+
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.sha }}
cancel-in-progress: true
jobs: jobs:
build: lint-workflows:
timeout-minutes: 20 name: Lint workflows
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
actions: read # only required in private repos
security-events: write # allow writing security events
steps: steps:
- name: Checkout Repo - name: Checkout repository
uses: actions/checkout@v2 uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Use Node.js 14
uses: actions/setup-node@v1
with: with:
node-version: 14.x persist-credentials: false
- name: Install Dependencies - name: Run zizmor
run: yarn --frozen-lockfile uses: zizmorcore/zizmor-action@5f14fd08f7cf1cb1609c1e344975f152c7ee938d # v0.5.6
with:
persona: pedantic
annotations: true
advanced-security: false
test:
name: Test
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Test - name: Test
run: yarn test run: pnpm test
typecheck:
name: Typecheck
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Typecheck
run: pnpm typecheck
lint:
name: Lint
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Format
run: pnpm format
ci-ok:
name: CI OK
runs-on: ubuntu-latest
if: always()
needs: [lint-workflows, test, typecheck, lint]
steps:
- name: Exit with error if some jobs are not successful
run: exit 1
if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
+88
View File
@@ -0,0 +1,88 @@
name: Publish
on:
push:
branches:
- main
- next
- "maintenance/v*" # branch rulesets don't support v[0-9]+
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
queue: max
permissions: {} # each job should define its own permission explicitly
jobs:
version:
name: Version
runs-on: ubuntu-latest
environment: version
timeout-minutes: 20
outputs:
hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
permissions:
contents: read # to check out repo (actions/checkout)
steps:
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to create version commits (changesets/action)
permission-pull-requests: write # to create pull request (changesets/action)
- name: Create or update release pull request
id: changesets
uses: ./
with:
github-token: ${{ steps.app-token.outputs.token }}
version: pnpm bump
publish:
name: Publish
if: needs.version.outputs.hasChangesets == 'false'
needs: version
runs-on: ubuntu-latest
environment: marketplace
timeout-minutes: 20
permissions:
contents: write # to create release and have it authored by github-actions (changesets/action)
steps:
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to bypass branch and tag protection rules (release.ts)
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- name: Publish to marketplace
uses: ./
with:
github-token: ${{ steps.app-token.outputs.token }}
publish: pnpm release
+251
View File
@@ -0,0 +1,251 @@
name: Release PR
on:
issue_comment:
types: [created]
concurrency:
group: ${{ github.workflow }}-${{ github.run_id }}
cancel-in-progress: true
permissions: {}
jobs:
release_check:
name: Validate release request
if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr')
timeout-minutes: 5
runs-on: ubuntu-latest
permissions:
contents: read # to inspect the pull request commit state (changesets/action)
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: read # to inspect the pull request head state (changesets/action)
steps:
- id: report_in_progress
run: |
in_progress_reaction_id=$(gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='eyes' --jq '.id')
echo "in_progress_reaction_id=$in_progress_reaction_id" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- id: parse_command
run: |
if [[ "$COMMENT_BODY" =~ ^/release-pr[[:space:]]+([0-9a-fA-F]{7,40})[[:space:]]*$ ]]
then
echo "requested_sha=${BASH_REMATCH[1]}" >> "$GITHUB_OUTPUT"
else
echo "Expected '/release-pr <sha>' where <sha> is a 7-40 character commit SHA."
exit 1
fi
env:
COMMENT_BODY: ${{ github.event.comment.body }}
- id: check_authorization
run: |
if [[ "$AUTHOR_ASSOCIATION" == 'MEMBER' || "$AUTHOR_ASSOCIATION" == 'OWNER' || "$AUTHOR_ASSOCIATION" == 'COLLABORATOR' ]]
then
echo "User is authorized to release"
else
echo "User is not authorized to release"
exit 1
fi
env:
AUTHOR_ASSOCIATION: ${{ github.event.comment.author_association }}
- id: resolve_requested_sha
run: |
requested_sha=$(echo "$REQUESTED_SHA" | tr '[:upper:]' '[:lower:]')
mapfile -t matches < <(
gh api "/repos/$GH_REPO/pulls/$ISSUE_NUMBER/commits" --paginate --jq '.[].sha' |
awk -v sha="$requested_sha" 'index(tolower($0), sha) == 1 { print $0 }'
)
if [[ ${#matches[@]} -eq 0 ]]
then
echo "Requested SHA $REQUESTED_SHA is not part of this pull request."
exit 1
fi
if [[ ${#matches[@]} -gt 1 ]]
then
echo "Requested SHA $REQUESTED_SHA is ambiguous for this pull request."
exit 1
fi
resolved_sha="${matches[0]}"
pr_head_sha=$(gh pr view "$ISSUE_NUMBER" --json headRefOid --jq '.headRefOid')
if [[ "$resolved_sha" != "$pr_head_sha" ]]
then
echo "Requested SHA $resolved_sha is not the current PR head $pr_head_sha."
exit 1
fi
echo "resolved_sha=$resolved_sha" >> "$GITHUB_OUTPUT"
echo "pr_head_sha=$pr_head_sha" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
REQUESTED_SHA: ${{ steps.parse_command.outputs.requested_sha }}
- id: get_pr_head_repository
run: |
head_repository=$(gh pr view "$ISSUE_NUMBER" --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')
echo "head_repository=$head_repository" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
outputs:
in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }}
requested_sha: ${{ steps.parse_command.outputs.requested_sha }}
resolved_sha: ${{ steps.resolve_requested_sha.outputs.resolved_sha }}
pr_head_sha: ${{ steps.resolve_requested_sha.outputs.pr_head_sha }}
head_repository: ${{ steps.get_pr_head_repository.outputs.head_repository }}
release:
name: Release snapshot
if: github.repository == 'changesets/action'
timeout-minutes: 20
runs-on: ubuntu-latest
needs: release_check
permissions:
contents: write # to create the release commit and publish snapshot artifacts (changesets/action)
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write # to comment on the pull request with the release result (changesets/action)
steps:
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to push the release snapshot branch (release-pr.ts)
- name: Check out repo
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Fetch validated commit from pull request head repository
run: |
git remote add pr-head "https://github.com/$HEAD_REPOSITORY.git"
git fetch --no-tags pr-head "$RESOLVED_SHA"
env:
HEAD_REPOSITORY: ${{ needs.release_check.outputs.head_repository }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Checkout validated commit
run: git checkout --detach "$RESOLVED_SHA"
env:
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Check if Version Packages PR
id: check_version_packages
run: |
version_packages=$(gh pr view "$ISSUE_NUMBER" --json headRefName --jq '.headRefName|startswith("changeset-release/")')
echo "version_packages=$version_packages" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Reset Version Packages PR
if: steps.check_version_packages.outputs.version_packages == 'true'
run: git reset --hard HEAD~1
- name: Create snapshot version
run: pnpm changeset version --snapshot "pr$ISSUE_NUMBER"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Build
run: pnpm build
- name: Setup Git user
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Release snapshot version
run: pnpm release:pr
env:
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
- name: Add success reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='rocket'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- name: Comment success
run: |
published_commit="$(git rev-parse HEAD)"
body="The release for \`$RESOLVED_SHA\` triggered by [this comment]($COMMENT_URL) has [succeeded]($RUN_URL). Published commit: [$GH_REPO@$published_commit](https://github.com/$GH_REPO/commit/$published_commit)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
report-failure-if-needed:
name: Report failure
needs: [release_check, release]
timeout-minutes: 2
runs-on: ubuntu-latest
if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure')
permissions:
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write # to comment on the pull request with the failure result (changesets/action)
steps:
- name: Add failure reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='-1'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- name: Comment failure
run: |
body="The release for \`$REQUESTED_SHA\` triggered by [this comment]($COMMENT_URL) has [failed]($RUN_URL)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
REQUESTED_SHA: ${{ needs.release_check.outputs.requested_sha }}
-33
View File
@@ -1,33 +0,0 @@
name: Version or Publish
on:
push:
branches:
- main
jobs:
changesets:
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v2
- name: Use Node.js 14
uses: actions/setup-node@v1
with:
node-version: 14.x
- name: Install Dependencies
run: yarn --frozen-lockfile
- name: Build
run: yarn build
- name: Create Release Pull Request or Publish
id: changesets
uses: ./
with:
version: yarn bump
publish: yarn release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+1
View File
@@ -0,0 +1 @@
v24.11.0
+7
View File
@@ -0,0 +1,7 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"printWidth": 80,
"sortImports": {
"newlinesBetween": false
}
}
+16
View File
@@ -0,0 +1,16 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Debug Current Test File",
"autoAttachChildProcesses": true,
"skipFiles": [],
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
"args": ["run", "${relativeFile}"],
"smartStep": true,
"console": "integratedTerminal"
}
]
}
+4
View File
@@ -0,0 +1,4 @@
{
"js/ts.tsdk.path": "node_modules/typescript/lib",
"editor.defaultFormatter": "oxc.oxc-vscode"
}
+216
View File
@@ -1,5 +1,221 @@
# @changesets/action # @changesets/action
## 2.0.0-next.2
### Patch Changes
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
## 2.0.0-next.1
### Patch Changes
- [#663](https://github.com/changesets/action/pull/663) [`ccb3811`](https://github.com/changesets/action/commit/ccb38113eaaa4a13eb6aabe09520e49cc8519b84) Thanks [@Andarist](https://github.com/Andarist)! - Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
- [#662](https://github.com/changesets/action/pull/662) [`5c88881`](https://github.com/changesets/action/commit/5c88881fff1f0d8b055d4a2d3a74a8ce843db6f3) Thanks [@Andarist](https://github.com/Andarist)! - Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
- [#666](https://github.com/changesets/action/pull/666) [`dc29b73`](https://github.com/changesets/action/commit/dc29b738b532d9e95f46b9bf493e2e3fdf48a7ed) Thanks [@Andarist](https://github.com/Andarist)! - Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
## 2.0.0-next.0
### Major Changes
- [#657](https://github.com/changesets/action/pull/657) [`4f718b5`](https://github.com/changesets/action/commit/4f718b5921490b1efeb015a81abb6a4633892851) Thanks [@Andarist](https://github.com/Andarist)! - Removed compatibility support for old Changesets v1.
- [#659](https://github.com/changesets/action/pull/659) [`5649ff4`](https://github.com/changesets/action/commit/5649ff41b8eb1b7a281011e45df781c6d4628fd0) Thanks [@bluwy](https://github.com/bluwy)! - Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
### Minor Changes
- [#656](https://github.com/changesets/action/pull/656) [`a12d90d`](https://github.com/changesets/action/commit/a12d90de8394e63c952622b2fd3f98c8729c48b0) Thanks [@bluwy](https://github.com/bluwy)! - Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
## 1.9.0
### Minor Changes
- [#636](https://github.com/changesets/action/pull/636) [`b072bcc`](https://github.com/changesets/action/commit/b072bccc4c664a373c42168eed9139dce1e003b1) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-comment` sub-action to comment on PRs
- [#625](https://github.com/changesets/action/pull/625) [`8795eee`](https://github.com/changesets/action/commit/8795eee5eee884e887d352ac673a515ffe35aaa6) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-status` sub-action to generate the changeset status comment for PRs as an alternative to the [Changesets Bot](https://github.com/apps/changeset-bot).
### Patch Changes
- [#535](https://github.com/changesets/action/pull/535) [`34f64f6`](https://github.com/changesets/action/commit/34f64f6e2e1e47ddc183f174aa27c197aa47f520) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with GitHub releases not being created for successfully published packages when _some_ packages failed to be published to the registry.
- [#632](https://github.com/changesets/action/pull/632) [`1d54b9e`](https://github.com/changesets/action/commit/1d54b9e660e435237accbcae0b4581af3be641b4) Thanks [@bluwy](https://github.com/bluwy)! - Simplify internal implementation to get changelog entries for a package version
- [#629](https://github.com/changesets/action/pull/629) [`e0c90aa`](https://github.com/changesets/action/commit/e0c90aa7fbd0cc26931a679c5abe9bbc0deb0b50) Thanks [@bluwy](https://github.com/bluwy)! - Fix custom version and publish command argument parsing
- [#645](https://github.com/changesets/action/pull/645) [`f9585d9`](https://github.com/changesets/action/commit/f9585d966a9c7d2f668b97199990de6f885823cf) Thanks [@Andarist](https://github.com/Andarist)! - Improved force-push handling when using `commitMode: "github-api"` so updating an existing branch no longer temporarily resets the target branch to the base commit, avoiding cases where GitHub closes open pull requests during the update. This should remove a possibility of a GitHub state race that caused the force-pushed PRs not being reopened.
## 1.8.0
### Minor Changes
- [#258](https://github.com/changesets/action/pull/258) [`f5dbf72`](https://github.com/changesets/action/commit/f5dbf72f96949cb0daf45152f0f63062df70e97d) Thanks [@tom-sherman](https://github.com/tom-sherman)! - Support draft version PR modes with a new `prDraft` input. Use `create` to create new version PRs as drafts, or `always` to also convert existing version PRs back to draft when updating them.
### Patch Changes
- [#502](https://github.com/changesets/action/pull/502) [`6002dbd`](https://github.com/changesets/action/commit/6002dbd987f49a3c0a134910d9c7bca975b79977) Thanks [@oshytiko](https://github.com/oshytiko)! - Fixed initial `.changeset` state being picked up, when `cwd` parameter is provided
- [#536](https://github.com/changesets/action/pull/536) [`81b3f61`](https://github.com/changesets/action/commit/81b3f61ebffcb868f73e4c0b2682517149c834a2) Thanks [@radnan](https://github.com/radnan)! - Fixed `.changeset` state being picked for the version command when `cwd` parameter is provided
## 1.7.0
### Minor Changes
- [#564](https://github.com/changesets/action/pull/564) [`935fe87`](https://github.com/changesets/action/commit/935fe876b0054dfc962ac86bcddf028460040d46) Thanks [@Andarist](https://github.com/Andarist)! - Automatically use the GitHub-provided token to allow most users to avoid explicit `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` configuration.
### Patch Changes
- [#545](https://github.com/changesets/action/pull/545) [`54220dd`](https://github.com/changesets/action/commit/54220dd92c06e7da112b139f95d8beb933e4cdde) Thanks [@ryanbas21](https://github.com/ryanbas21)! - The `.npmrc` generation now intelligently handles both traditional NPM token authentication and trusted publishing scenarios by only appending the auth token when `NPM_TOKEN` is defined. This prevents 'undefined' from being written to the registry configuration when using OIDC tokens from GitHub Actions trusted publishing.
- [#563](https://github.com/changesets/action/pull/563) [`6af4a7e`](https://github.com/changesets/action/commit/6af4a7ec080d23ac6b304f69b67fd0aa92e089e7) Thanks [@Andarist](https://github.com/Andarist)! - Don't error on already committed symlinks and executables that stay untouched
## 1.6.0
### Minor Changes
- [#558](https://github.com/changesets/action/pull/558) [`342005d`](https://github.com/changesets/action/commit/342005d41242bccd9dd9ae8d3679efce96af48ae) Thanks [@harsha-venugopal-ledn](https://github.com/harsha-venugopal-ledn)! - Upgrade from Node.js 20 to Node.js 24 LTS
## 1.5.3
### Patch Changes
- [#477](https://github.com/changesets/action/pull/477) [`9d933dc`](https://github.com/changesets/action/commit/9d933dcd11c284ac49a835db884c3c1008b2b96f) Thanks [@Andarist](https://github.com/Andarist)! - Updated `@actions/*` and `@octokit/*` dependencies.
- [#479](https://github.com/changesets/action/pull/479) [`cf373e4`](https://github.com/changesets/action/commit/cf373e45c90a0cc564cd2770de3e9a3a4cdd4603) Thanks [@Andarist](https://github.com/Andarist)! - Switched to `esbuild` for bundling the dist file. This led to 45% file size reduction.
- [#488](https://github.com/changesets/action/pull/488) [`022692b`](https://github.com/changesets/action/commit/022692ba027b33bf46d4d41907a317fbf04461a7) Thanks [@s0](https://github.com/s0)! - Fix PRs sometimes not getting reopened with `commitMode: github-api`
There was a race-condition that means sometimes existing PRs would not be found,
and new PRs would be opened. This has now been fixed by fetching existing PRs
before making any changes.
- [#486](https://github.com/changesets/action/pull/486) [`7ed1955`](https://github.com/changesets/action/commit/7ed195554624ebd75c08aa477b53110f61cc78f7) Thanks [@s0](https://github.com/s0)! - Fixed situations in which `cwd` was specified as a relative path and used with (default) `commitMode: git-cli`
- [#461](https://github.com/changesets/action/pull/461) [`e9c36b6`](https://github.com/changesets/action/commit/e9c36b696406360bf04204ad32e3dcf3ad752b77) Thanks [@nayounsang](https://github.com/nayounsang)! - Avoid hitting a deprecation warning when encountering errors from `@octokit/request-error`
## 1.5.2
### Patch Changes
- [#473](https://github.com/changesets/action/pull/473) [`3c24abe`](https://github.com/changesets/action/commit/3c24abeab26da6335c181222faa2ea485a092cf8) Thanks [@s0](https://github.com/s0)! - Make git add work consistently with subdirectories
Ensure that when running the action from a subdirectory of a repository,
only the files from that directory are added, regardless of `commitMode`.
## 1.5.1
### Patch Changes
- [#471](https://github.com/changesets/action/pull/471) [`15ab130`](https://github.com/changesets/action/commit/15ab1306067a396fa9ba7ad363e8a041d457782a) Thanks [@h3rmanj](https://github.com/h3rmanj)! - Bump `@changesets/ghcommit` to v1.4.0, which fixes an issue running this action in monorepos with `commitMode: github-api`
- [#467](https://github.com/changesets/action/pull/467) [`6e57550`](https://github.com/changesets/action/commit/6e575506e63f9e69e475d3eccfdd61b448efc8ae) Thanks [@Vx-V](https://github.com/Vx-V)! - Avoid searching for an existing pull request early.
## 1.5.0
### Minor Changes
- [#391](https://github.com/changesets/action/pull/391) [`207dc3d`](https://github.com/changesets/action/commit/207dc3da2d1907cae0454ce123935401332be72b) Thanks [@s0](https://github.com/s0)! - Introduce a new input `commitMode` that allows using the GitHub API for pushing tags and commits instead of the Git CLI.
When used with `"github-api"` value all tags and commits will be attributed to the user whose GITHUB_TOKEN is used, and also signed using GitHub's internal GPG key.
## 1.4.10
### Patch Changes
- [#448](https://github.com/changesets/action/pull/448) [`8b16070`](https://github.com/changesets/action/commit/8b16070fe386eed3456c83eeed9460160432cf26) Thanks [@bluwy](https://github.com/bluwy)! - Use full git email (`41898282+github-actions[bot]@users.noreply.github.com`) for github-actions bot when making commits
## 1.4.9
### Patch Changes
- [#415](https://github.com/changesets/action/pull/415) [`57ab80c`](https://github.com/changesets/action/commit/57ab80c61104c270bebc125910ae32da3a5aca46) Thanks [@benmccann](https://github.com/benmccann)! - Improve error message when attempting to publish without publish script defined
## 1.4.8
### Patch Changes
- [#393](https://github.com/changesets/action/pull/393) [`48ab0d2`](https://github.com/changesets/action/commit/48ab0d2f2e77ae169182d022591ef5c18c931ff2) Thanks [@s0](https://github.com/s0)! - Ensure the PR remains open when updated
- [#393](https://github.com/changesets/action/pull/393) [`48ab0d2`](https://github.com/changesets/action/commit/48ab0d2f2e77ae169182d022591ef5c18c931ff2) Thanks [@s0](https://github.com/s0)! - Switch to cheaper API for querying existing PRs
## 1.4.7
### Patch Changes
- [#255](https://github.com/changesets/action/pull/255) [`f2660aa`](https://github.com/changesets/action/commit/f2660aa7e78365f53dbeb4cfa774c1499ec6483a) Thanks [@ernestognw](https://github.com/ernestognw)! - Allow customize PR `branch` field
## 1.4.6
### Patch Changes
- [#350](https://github.com/changesets/action/pull/350) [`9385be9`](https://github.com/changesets/action/commit/9385be9e757839189ea5ee63ec4e3caa8a6ca71b) Thanks [@m-shaka](https://github.com/m-shaka)! - Bump the used node.js from 16 to 20
## 1.4.5
### Patch Changes
- [#282](https://github.com/changesets/action/pull/282) [`eb19e25`](https://github.com/changesets/action/commit/eb19e25e7797cf33dc2de4caa071e85a8057a0f0) Thanks [@mark-omarov](https://github.com/mark-omarov)! - Updated a few dependencies to patch the security vulnerabilities that were reported for their older versions.
## 1.4.4
### Patch Changes
- [#291](https://github.com/changesets/action/pull/291) [`db8a109`](https://github.com/changesets/action/commit/db8a1099bc0ba1dd6f46a5b9df4212e4f69e78c9) Thanks [@varl](https://github.com/varl)! - Wire up [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) with all GitHub Octokit instances
## 1.4.3
### Patch Changes
- [#289](https://github.com/changesets/action/pull/289) [`8b28186`](https://github.com/changesets/action/commit/8b2818674de86a7fc69aebb9ed6b486ee32eb96e) Thanks [@varl](https://github.com/varl)! - Use logging provided by `@actions/core`
## 1.4.2
### Patch Changes
- [#286](https://github.com/changesets/action/pull/286) [`225a1e8`](https://github.com/changesets/action/commit/225a1e8cbcabb7b585174ba0ad806549db40d4cd) Thanks [@varl](https://github.com/varl)! - This patch implements the [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) plugin and [wires
it up with the internal GitHub Octokit instance](https://github.com/actions/toolkit/tree/457303960f03375db6f033e214b9f90d79c3fe5c/packages/github#extending-the-octokit-instance).
This plugin is recommended by [the Octokit docs](://octokit.github.io/rest.js/v19#throttling) as it implements all the GitHub [best practices for integrators](https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28).
This should help with `changesets/action` gitting spurious secondary rate limits and failing CI jobs, for which the only known workaround is to simply re-run the job.
## 1.4.1
### Patch Changes
- [#123](https://github.com/changesets/action/pull/123) [`b78f480`](https://github.com/changesets/action/commit/b78f48099899f0a853c5d9cd3feb21a5440babbd) Thanks [@Andarist](https://github.com/Andarist)! - Updated `@actions/*` dependencies to avoid using deprecated features of the runner.
## 1.4.0
### Minor Changes
- [#216](https://github.com/changesets/action/pull/216) [`398d7ed`](https://github.com/changesets/action/commit/398d7ed) Thanks [@quinnjn](https://github.com/quinnjn)! - Execute action with node16 instead of node12.
### Patch Changes
- [#228](https://github.com/changesets/action/pull/228) [`bff53cc`](https://github.com/changesets/action/commit/bff53cc50c1ebb33f8f558f9de2e0eb9a99230c6) Thanks [@iansan5653](https://github.com/iansan5653)! - Add `is:pull-request` to search query when looking for existing PR. This fixes an issue with user-owned PATs.
* [#206](https://github.com/changesets/action/pull/206) [`8c3f5f5`](https://github.com/changesets/action/commit/8c3f5f5637a95a2327e78d5dabcf357978aedcbb) Thanks [@glasser](https://github.com/glasser)! - Skip creating a PR when all existing changesets are empty.
## 1.3.0
### Minor Changes
- [#167](https://github.com/changesets/action/pull/167) [`993a0a0`](https://github.com/changesets/action/commit/993a0a090df78cee07481d3886dcd8b29deb9567) Thanks [@dmregister](https://github.com/dmregister)! - Added `pullRequestNumber` to the action's outputs
### Patch Changes
- [#157](https://github.com/changesets/action/pull/157) [`521c27b`](https://github.com/changesets/action/commit/521c27bf86ec53547d6a350d208fbbbc9d576fbc) Thanks [@emmenko](https://github.com/emmenko)! - Automatically adjust GitHub PR message if it exceeds a size limit of 60k characters by omitting some of the changelog information.
## 1.2.2
### Patch Changes
- [#161](https://github.com/changesets/action/pull/161) [`52c9ce7`](https://github.com/changesets/action/commit/52c9ce75d9d8a14ea2d75e4157b0c15b7a4ac313) Thanks [@bicknellr](https://github.com/bicknellr)! - Change directory to `cwd` before running git user setup. This fixes an issue when the action starts its execution not in a git repository.
## 1.2.1 ## 1.2.1
### Patch Changes ### Patch Changes
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) Changesets team and other contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+92 -43
View File
@@ -1,6 +1,14 @@
# Changesets Release Action # Changesets Release Action
This action for [Changesets](https://github.com/atlassian/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on master, 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. > [!IMPORTANT]
> This is the development branch for `changesets/action` v2 compatible with Changesets v3. For the v1 code compatible with Changesets v2, check out the [`maintenance/v1`](https://github.com/changesets/action/tree/maintenance/v1) branch.
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details:
- [pr-status](./pr-status/README.md): Generate changeset status in PRs.
- [pr-comment](./pr-comment/README.md): Comment on PRs.
## Usage ## Usage
@@ -11,14 +19,17 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a
- commit - The commit message to use. Default to `Version Packages` - commit - The commit message to use. Default to `Version Packages`
- title - The pull request title. 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` - 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()` - 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 ### Outputs
- published - A boolean value to indicate whether a publishing is happened or not - published - A boolean value to indicate whether a publishing has happened or not
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` - 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"}]`
### Example workflow: ### Example workflow
#### Without Publishing #### Without Publishing
@@ -30,7 +41,7 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }} concurrency: ${{ github.workflow }}-${{ github.ref }}
@@ -40,23 +51,21 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v2 uses: actions/checkout@v6
with:
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
fetch-depth: 0
- name: Setup Node.js 12.x - name: Setup pnpm
uses: actions/setup-node@v2 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 12.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### With Publishing #### With Publishing
@@ -69,7 +78,7 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }} concurrency: ${{ github.workflow }}-${{ github.ref }}
@@ -79,27 +88,26 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v2 uses: actions/checkout@v6
with:
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
fetch-depth: 0
- name: Setup Node.js 12.x - name: Setup pnpm
uses: actions/setup-node@v2 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 12.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request or Publish to npm - name: Create Release Pull Request or Publish to npm
id: changesets id: changesets
uses: changesets/action@v1 uses: changesets/action@v2
with: with:
# This expects you to have a script called release which does a build for your packages and calls changeset publish # This expects you to have a script called release which does a build for your packages and calls changeset publish
publish: yarn release publish: pnpm release
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Send a Slack notification if a publish happens - name: Send a Slack notification if a publish happens
@@ -110,7 +118,7 @@ jobs:
By default the GitHub Action creates a `.npmrc` file with the following content: By default the GitHub Action creates a `.npmrc` file with the following content:
``` ```txt
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN} //registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
``` ```
@@ -121,13 +129,55 @@ For example, you can add a step before running the Changesets GitHub Action:
- name: Creating .npmrc - name: Creating .npmrc
run: | run: |
cat << EOF > "$HOME/.npmrc" cat << EOF > "$HOME/.npmrc"
email=my@email.com
//registry.npmjs.org/:_authToken=$NPM_TOKEN //registry.npmjs.org/:_authToken=$NPM_TOKEN
EOF EOF
env: env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 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 #### With version script
If you need to add additional logic to the version command, you can do so by using a version script. If you need to add additional logic to the version command, you can do so by using a version script.
@@ -140,7 +190,7 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }} concurrency: ${{ github.workflow }}-${{ github.ref }}
@@ -150,25 +200,24 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v2 uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup Node.js 12.x - name: Setup pnpm
uses: actions/setup-node@v2 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 12.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@v2
with: with:
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`. # this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
version: yarn version version: pnpm version
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### With Yarn 2 / Plug'n'Play #### With Yarn 2 / Plug'n'Play
@@ -176,8 +225,8 @@ jobs:
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI: 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 ```yaml
- uses: changesets/action@v1 - uses: changesets/action@v2
with: with:
version: yarn changeset version version: yarn changeset version
... # ...
``` ```
@@ -1,4 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json",
"ignore": ["ignored-package-pkg-a"]
}
@@ -1,8 +0,0 @@
{
"private": true,
"name": "ignored-package",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -1,7 +0,0 @@
{
"name": "ignored-package-pkg-a",
"version": "1.0.0",
"dependencies": {
"ignored-package-pkg-b": "1.0.0"
}
}
@@ -1,4 +0,0 @@
{
"name": "ignored-package-pkg-b",
"version": "1.0.0"
}
@@ -1,3 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json"
}
-8
View File
@@ -1,8 +0,0 @@
{
"private": true,
"name": "simple-project",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -1,7 +0,0 @@
{
"name": "simple-project-pkg-a",
"version": "1.0.0",
"dependencies": {
"simple-project-pkg-b": "1.0.0"
}
}
@@ -1,4 +0,0 @@
{
"name": "simple-project-pkg-b",
"version": "1.0.0"
}
+23 -4
View File
@@ -1,18 +1,19 @@
name: Changesets name: Changesets
description: A GitHub action to automate releases with Changesets description: A GitHub action to automate releases with Changesets
runs: runs:
using: "node12" using: "node24"
main: "dist/index.js" main: "dist/index.js"
inputs: inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
publish: publish:
description: "The command to use to build and publish packages" description: "The command to use to build and publish packages"
required: false required: false
version: version:
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided" description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
required: false required: false
cwd:
description: Sets the cwd for the node process. Default to `process.cwd()`
required: false
commit: commit:
description: | description: |
The commit message. Default to `Version Packages` The commit message. Default to `Version Packages`
@@ -28,12 +29,30 @@ inputs:
description: "A boolean value to indicate whether to create Github releases after `publish` or not" description: "A boolean value to indicate whether to create Github releases after `publish` or not"
required: false required: false
default: true default: true
commitMode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
all commits and tags are signed using GitHub's GPG key and attributed to the user
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
branch:
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
required: false
prDraft:
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
required: false
outputs: outputs:
published: published:
description: A boolean value to indicate whether a publishing is happened or not description: A boolean value to indicate whether a publishing is happened or not
publishedPackages: publishedPackages:
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"}]`
hasChangesets:
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
pullRequestNumber:
description: The pull request number that was created or updated
branding: branding:
icon: "package" icon: "package"
color: "blue" color: "blue"
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+2
View File
@@ -0,0 +1,2 @@
import{_ as e,g as t,h as n,m as r,p as i,v as a}from"./get-packages.cjs-Dvdg-NAr.js";import{n as o,r as s,t as c}from"./run-Cekyj2rz.js";import{r as l,s as u}from"./utils-DQTbg3yF.js";import{t as d}from"./readChangesetState-D8jsqLyj.js";import f from"node:fs/promises";(async()=>{let p=process.env.GITHUB_TOKEN||n(`github-token`);if(!p){e(`Please add the GITHUB_TOKEN to the changesets action`);return}let m=process.cwd(),h=u(`commitMode`)??`git-cli`,g=u(`prDraft`);if(h!==`git-cli`&&h!==`github-api`){e(`Invalid commit mode: ${h}`);return}if(g!==void 0&&g!==`always`&&g!==`create`){e(`Invalid prDraft: ${g}`);return}let _=new s({cwd:m,githubToken:p,commitMode:h});r(`setupGitUser`)&&(t(`setting git user`),await _.setupUser());let{changesets:v}=await d(m),y=n(`publish`),b=v.length!==0,x=v.some(e=>e.releases.length>0),S=!!y;switch(a(`published`,`false`),a(`publishedPackages`,`[]`),a(`hasChangesets`,String(b)),!0){case!b&&!S:t(`No changesets present or were removed by merging release PR. Not publishing because no publish script found.`);return;case!b&&S:{if(t(`No changesets found. Attempting to publish any unpublished packages to npm`),process.env.NPM_TOKEN){let e=`${process.env.HOME}/.npmrc`;await l(e)?(t(`Found existing user .npmrc file`),(await f.readFile(e,`utf8`)).split(`
`).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 f.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 f.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=await c({script:y,github:_,createGithubReleases:r(`createGithubReleases`),cwd:m});e.published&&(a(`published`,`true`),a(`publishedPackages`,JSON.stringify(e.publishedPackages))),e.exitCode!==0&&(i(`Publish command exited with code ${e.exitCode}${e.published?`, but some packages were published: ${e.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`),process.exit(e.exitCode));return}case b&&!x:t(`All changesets are empty; not creating PR`);return;case b:{let{pullRequestNumber:e}=await o({script:u(`version`),github:_,cwd:m,prTitle:u(`title`),commitMessage:u(`commit`),hasPublishScript:S,prDraft:g,branch:u(`branch`)});a(`pullRequestNumber`,String(e));return}}})().catch(t=>{i(t),e(t.message)});export{};
+1
View File
@@ -0,0 +1 @@
import{_ as e,v as t}from"./get-packages.cjs-Dvdg-NAr.js";import{f as n,n as r,s as i,t as a}from"./utils-DQTbg3yF.js";import o from"node:fs/promises";import s from"node:path";import c from"node:os";try{await l()}catch(t){e(t.message)}async function l(){let e=i(`publish-plan-artifact-id`),r=process.cwd(),a=process.env.RUNNER_TEMP??await o.realpath(c.tmpdir()),l=s.join(a,`changeset-pack-${Date.now()}`);await u(r,{outDir:l,publishPlanPath:e?await d(a,Number(e)):void 0});let p=await n.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`);t(`pack-dir-artifact-id`,String(p.id))}async function u(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 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{};
+1
View File
@@ -0,0 +1 @@
import{_ as e,c as t,g as n,l as r,v as i}from"./get-packages.cjs-Dvdg-NAr.js";import{c as a,s as o}from"./utils-DQTbg3yF.js";try{await s()}catch(t){e(t.message)}async function s(){let e=t.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=o(`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=r(s),h;d&&(n(`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?(n(`Updating existing comment (id: ${h})...`),await m.rest.issues.updateComment({...p,comment_id:h}),i(`comment-id`,h)):(n(`Creating new comment...`),i(`comment-id`,(await m.rest.issues.createComment(p)).data.id)),n(`Done!`)}function c(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
+39
View File
File diff suppressed because one or more lines are too long
+1
View File
@@ -0,0 +1 @@
import{_ as e,m as t,v as n}from"./get-packages.cjs-Dvdg-NAr.js";import{r,t as i}from"./run-Cekyj2rz.js";import{c as a,s as o,t as s}from"./utils-DQTbg3yF.js";import c from"node:fs/promises";import l from"node:os";try{await u()}catch(t){e(t.message)}async function u(){let e=a(`github-token`),u=o(`script`),d=o(`pack-dir-artifact-id`),f=t(`create-github-releases`),p=process.cwd(),m=await i({script:u,github:new r({cwd:p,githubToken:e,commitMode:`github-api`}),createGithubReleases:f,cwd:p,fromPackDir:d?await s(process.env.RUNNER_TEMP??await c.realpath(l.tmpdir()),Number(d),`changeset-pack`):void 0});if(m.published?(n(`published`,`true`),n(`published-packages`,JSON.stringify(m.publishedPackages))):n(`published`,`false`),m.exitCode!==0)throw Error(`Publish command exited with code ${m.exitCode}${m.published?`, but some packages were published: ${m.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`)}export{};
+1
View File
@@ -0,0 +1 @@
import{o as e,t}from"./changesets-read.esm-D6fW_L6x.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};
+149
View File
File diff suppressed because one or more lines are too long
+1
View File
@@ -0,0 +1 @@
import{_ as e,v as t}from"./get-packages.cjs-Dvdg-NAr.js";import{f as n,n as r}from"./utils-DQTbg3yF.js";import{t as i}from"./readChangesetState-D8jsqLyj.js";import a from"node:fs/promises";import o from"node:path";import s from"node:os";try{await c()}catch(t){e(t.message)}async function c(){let e=await l();if(t(`mode`,e.mode),e.mode===`publish`){let r=await n.uploadArtifact(o.basename(e.publishPlanPath,`.json`),[e.publishPlanPath],o.dirname(e.publishPlanPath),{skipArchive:!0,retentionDays:30});if(r.id===void 0)throw Error(`Publish plan artifact upload did not return an artifact id`);t(`publish-plan-artifact-id`,String(r.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(),n=o.join(process.env.RUNNER_TEMP??await a.realpath(s.tmpdir()),`changeset-publish-plan-${Date.now()}`,`publish-plan.json`);return await r([`publish-plan`,`--output`,n],{cwd:t,env:process.env}),(await u(n)).length===0?{mode:`none`}:{mode:`publish`,publishPlanPath:n}}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{};
+80
View File
File diff suppressed because one or more lines are too long
+1
View File
@@ -0,0 +1 @@
import{_ as e,g as t,m as n,v as r}from"./get-packages.cjs-Dvdg-NAr.js";import{n as i,r as a}from"./run-Cekyj2rz.js";import{c as o,s}from"./utils-DQTbg3yF.js";try{await c()}catch(t){e(t.message)}async function c(){let e=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=n(`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:e,commitMode:p});m&&(t(`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});r(`pr-number`,String(_))}export{};
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/pack
TODO
+15
View File
@@ -0,0 +1,15 @@
name: Changesets - Pack
description: Pack publishable packages into tarballs
runs:
using: node24
main: ../dist/pack.js
inputs:
publish-plan-artifact-id:
description: "Artifact id for a publish plan generated by the select-mode subaction"
required: false
outputs:
pack-dir-artifact-id:
description: "Artifact id for the packed output directory"
branding:
icon: package
color: blue
+44 -41
View File
@@ -1,52 +1,55 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "1.2.1", "version": "2.0.0-next.2",
"main": "dist/index.js",
"license": "MIT", "license": "MIT",
"devDependencies": { "type": "module",
"@changesets/changelog-github": "^0.4.2", "main": "dist/index.js",
"@changesets/cli": "^2.20.0",
"@changesets/write": "^0.1.6",
"fixturez": "^1.1.0",
"parcel": "^1.12.3",
"prettier": "^2.0.5",
"typescript": "^3.5.3"
},
"scripts": { "scripts": {
"build": "parcel build ./src/index.ts --no-source-maps --target=node --bundle-node-modules", "build": "rolldown -c",
"test": "jest", "test": "vitest",
"test:watch": "yarn test --watch", "test:watch": "pnpm test --watch",
"typecheck": "tsc",
"format": "oxfmt --check",
"format:fix": "oxfmt",
"changeset": "changeset", "changeset": "changeset",
"bump": "node ./scripts/bump.js", "bump": "node --experimental-strip-types ./scripts/bump.ts",
"release": "node ./scripts/release.js" "release": "node --experimental-strip-types ./scripts/release.ts",
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts"
}, },
"dependencies": { "dependencies": {
"@actions/core": "^1.3.0", "@actions/artifact": "^6.2.1",
"@actions/exec": "^1.1.0", "@actions/core": "^3.0.1",
"@actions/github": "^4.0.0", "@actions/exec": "^3.0.0",
"@babel/core": "^7.13.10", "@actions/github": "^9.1.1",
"@babel/preset-env": "^7.13.10", "@changesets/get-release-plan": "^4.0.16",
"@babel/preset-typescript": "^7.13.0", "@changesets/ghcommit": "^2.1.1",
"@changesets/pre": "^1.0.9", "@changesets/git": "^3.0.4",
"@changesets/read": "^0.5.3", "@changesets/pre": "^2.0.2",
"@changesets/read": "^0.6.7",
"@manypkg/get-packages": "^1.1.3", "@manypkg/get-packages": "^1.1.3",
"@types/fs-extra": "^8.0.0", "@octokit/core": "^7.0.6",
"@types/jest": "^24.0.18", "@octokit/plugin-throttling": "^11.0.3",
"@types/node": "^12.7.1", "human-id": "^4.1.3",
"@types/semver": "^6.0.2", "markdown-table": "^3.0.4",
"babel-jest": "^24.9.0", "semver": "^7.8.1",
"fs-extra": "^8.1.0", "tinyexec": "^1.2.4"
"husky": "^3.0.3",
"jest": "^24.9.0",
"mdast-util-to-string": "^1.0.6",
"remark-parse": "^7.0.1",
"remark-stringify": "^7.0.3",
"resolve-from": "^5.0.0",
"semver": "^6.3.0",
"unified": "^8.3.2"
}, },
"husky": { "devDependencies": {
"hooks": {} "@changesets/changelog-github": "^0.7.0",
"@changesets/cli": "^2.31.0",
"@changesets/types": "^6.1.0",
"@changesets/write": "^0.4.0",
"@tsconfig/node24": "^24.0.4",
"@types/node": "^24.12.4",
"@types/semver": "^7.7.1",
"fs-fixture": "^2.13.0",
"oxfmt": "^0.48.0",
"rolldown": "^1.0.1",
"typescript": "^6.0.3",
"vitest": "^4.1.6"
}, },
"prettier": {} "engines": {
"node": ">=24"
},
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a"
} }
+3355
View File
File diff suppressed because it is too large Load Diff
+13
View File
@@ -0,0 +1,13 @@
blockExoticSubdeps: true
dedupePeers: true
dedupePeerDependents: true
minimumReleaseAge: 10080
minimumReleaseAgeExclude:
- "@changesets/ghcommit@2.1.1"
overrides:
lightningcss: "-" # we do not bundle any css
postcss: "-" # we do not bundle any css
shellEmulator: true
trustPolicy: no-downgrade
+52
View File
@@ -0,0 +1,52 @@
# @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 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).
See the [action metadata](action.yml) for details on the inputs and outputs.
## Example setup
```yaml
name: PR Comment
on:
pull_request:
jobs:
pr-comment:
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
steps:
- uses: changesets/action/pr-comment@v1
with:
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.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: my-tag
```
If you want to always create new comments, pass an empty value to `update-id`.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: ""
```
+25
View File
@@ -0,0 +1,25 @@
name: Changesets - PR Comment
description: A simple GitHub Action to comment on PRs
runs:
using: node24
main: ../dist/pr-comment.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
body:
description: "The comment body to post on the PR."
required: true
update-id:
description: >
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.
required: false
default: "changesets-action-pr-comment"
outputs:
comment-id:
description: "The comment id of the comment that was created or updated."
branding:
icon: message-circle
color: blue
+71
View File
@@ -0,0 +1,71 @@
# 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.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages.
See the [action metadata](action.yml) for details on the inputs and outputs.
> [!CAUTION]
> **This action uses `pull_request_target` by default to support PRs from forks.**
>
> **Do not run untrusted code** when using the `pull_request_target` event.
>
> The example below only **_checks out_** and **_reads_** code, and does not **_execute_** any code from the fork.
>
> Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs:
```yaml
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.
## Example setup
```yaml
# .github/workflows/comment-changesets-pr-status.yml
name: Comment Changesets status in PRs
on:
pull_request_target:
permissions: {} # require explicitly stating all permissions in each job
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
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.
+12
View File
@@ -0,0 +1,12 @@
name: Changesets - PR Status
description: Generate the changesets status in PRs
runs:
using: node24
main: ../dist/pr-status.js
inputs: {}
outputs:
comment-body:
description: The generated comment body to present the changesets status in PRs.
branding:
icon: package
color: blue
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/publish
TODO
+29
View File
@@ -0,0 +1,29 @@
name: Changesets - Publish
description: Publish packages to npm
runs:
using: node24
main: ../dist/publish.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
script:
description: "The command to use to publish packages"
required: false
pack-dir-artifact-id:
description: "Artifact id for packed publish output generated by the pack subaction"
required: false
create-github-releases:
description: "Whether to create Github releases after publish"
required: false
default: true
outputs:
published:
description: "A boolean value to indicate whether a publishing has happened or not"
published-packages:
description: >
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
branding:
icon: package
color: blue
+21
View File
@@ -0,0 +1,21 @@
import { defineConfig } from "rolldown";
export default defineConfig({
input: {
index: "src/index.ts",
pack: "src/pack/index.ts",
"pr-status": "src/pr-status/index.ts",
"pr-comment": "src/pr-comment/index.ts",
"select-mode": "src/select-mode/index.ts",
version: "src/version/index.ts",
publish: "src/publish/index.ts",
},
output: {
dir: "dist",
format: "esm",
cleanDir: true,
minify: true,
comments: false,
},
platform: "node",
});
-19
View File
@@ -1,19 +0,0 @@
const fs = require("fs");
const path = require("path");
const { exec } = require("@actions/exec");
process.chdir(path.join(__dirname, ".."));
(async () => {
await exec("changeset", ["version"]);
const releaseLine = `v${require("../package.json").version.split(".")[0]}`;
const readmePath = path.join(__dirname, "..", "README.md");
const content = fs.readFileSync(readmePath, "utf8");
const updatedContent = content.replace(
/changesets\/action@[^\s]+/g,
`changesets/action@${releaseLine}`
);
fs.writeFileSync(readmePath, updatedContent);
})();
+18
View File
@@ -0,0 +1,18 @@
import fs from "node:fs";
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
process.chdir(path.join(import.meta.dirname, ".."));
await exec("changeset", ["version"]);
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const readmePath = path.join(import.meta.dirname, "..", "README.md");
const content = fs.readFileSync(readmePath, "utf8");
const updatedContent = content.replace(
/changesets\/action@[^\s]+/g,
`changesets/action@${releaseLine}`,
);
fs.writeFileSync(readmePath, updatedContent);
+32
View File
@@ -0,0 +1,32 @@
import { Buffer } from "node:buffer";
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = "pr-release";
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, ".."));
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec(
"git",
["push", "--force", "origin", `HEAD:refs/heads/${releaseLine}`],
{
env: gitEnv,
},
);
-41
View File
@@ -1,41 +0,0 @@
const path = require("path");
const { exec, getExecOutput } = require("@actions/exec");
const { version } = require("../package.json");
const tag = `v${version}`;
const releaseLine = `v${version.split(".")[0]}`;
process.chdir(path.join(__dirname, ".."));
(async () => {
const { exitCode, stderr } = await getExecOutput(
`git`,
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
{
ignoreReturnCode: true,
}
);
if (exitCode === 0) {
console.log(
`Action is not being published because version ${tag} is already published`
);
return;
}
if (exitCode !== 2) {
throw new Error(`git ls-remote exited with ${exitCode}:\n${stderr}`);
}
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("changeset", ["tag"]);
await exec("git", [
"push",
"--force",
"--follow-tags",
"origin",
`HEAD:refs/heads/${releaseLine}`,
]);
})();
+67
View File
@@ -0,0 +1,67 @@
import { Buffer } from "node:buffer";
import path from "node:path";
import { exec, getExecOutput } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const isPrerelease = pkgJson.version.includes("-");
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, ".."));
(async () => {
const { exitCode, stderr } = await getExecOutput(
`git`,
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
{
ignoreReturnCode: true,
},
);
if (exitCode === 0) {
console.log(
`Action is not being published because version ${tag} is already published`,
);
return;
}
if (exitCode !== 2) {
throw new Error(`git ls-remote exited with ${exitCode}:\n${stderr}`);
}
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("changeset", ["tag"]);
if (isPrerelease) {
await exec("git", ["push", "origin", `refs/tags/${tag}`], {
env: gitEnv,
});
return;
}
await exec(
"git",
[
"push",
"--force",
"--follow-tags",
"origin",
`HEAD:refs/heads/${releaseLine}`,
],
{
env: gitEnv,
},
);
})();
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/select-mode
TODO
+14
View File
@@ -0,0 +1,14 @@
name: Changesets - Select Mode
description: Whether to version or publish in the current repo state
runs:
using: node24
main: ../dist/select-mode.js
inputs: {}
outputs:
mode:
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
publish-plan-artifact-id:
description: "Artifact id for the generated publish plan when mode is `publish`"
branding:
icon: package
color: blue
+181 -26
View File
@@ -1,29 +1,51 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`version creates simple PR 1`] = ` exports[`version > creates a draft PR when prDraft is "create" 1`] = `
Array [ [
Object { {
"base": "some-branch", "base": "some-branch",
"body": "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 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 some-branch, this PR will be updated. "body": "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 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 some-branch, this PR will be updated.
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
"draft": true,
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > creates simple PR 1`] = `
[
{
"base": "some-branch",
"body": "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 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 some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature
### Patch Changes ### Patch Changes
- Updated dependencies - Updated dependencies
- simple-project-pkg-b@1.1.0 - changesets-dev-simple-project-pkg-b@1.1.0
## changesets-dev-simple-project-pkg-b@1.1.0
## simple-project-pkg-b@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
", "draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -32,19 +54,17 @@ Array [
] ]
`; `;
exports[`version doesn't include ignored package that got a dependency update in the PR body 1`] = ` exports[`version > does not include any release information if a message with simplified release info exceeds size limit 1`] = `
Array [ [
Object { {
"base": "some-branch", "base": "some-branch",
"body": "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 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 some-branch, this PR will be updated. "body": "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 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 some-branch, this PR will be updated.
# Releases # Releases
## ignored-package-pkg-b@1.1.0
### Minor Changes > All release information have been omitted from this message, as the content exceeds the size limit.",
"draft": false,
- Awesome feature
",
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -53,19 +73,21 @@ Array [
] ]
`; `;
exports[`version only includes bumped packages in the PR body 1`] = ` exports[`version > does not include changelog entries if full message exceeds size limit 1`] = `
Array [ [
Object { {
"base": "some-branch", "base": "some-branch",
"body": "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 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 some-branch, this PR will be updated. "body": "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 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 some-branch, this PR will be updated.
# Releases # Releases
## simple-project-pkg-a@1.1.0
### Minor Changes > The changelog information of each package has been omitted from this message, as the content exceeds the size limit.
## changesets-dev-simple-project-pkg-a@1.1.0
- Awesome feature
", ",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -73,3 +95,136 @@ Array [
}, },
] ]
`; `;
exports[`version > doesn't include ignored package that got a dependency update in the PR body 1`] = `
[
{
"base": "some-branch",
"body": "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 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 some-branch, this PR will be updated.
# Releases
## changesets-dev-ignored-package-pkg-b@1.1.0
### Minor Changes
- Awesome feature",
"draft": false,
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > only includes bumped packages in the PR body 1`] = `
[
{
"base": "some-branch",
"body": "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 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 some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature",
"draft": false,
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > updates an existing PR via GraphQL and converts it to draft when prDraft is "always" 1`] = `
[
"
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
",
{
"body": "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 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 some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature",
"pullRequestId": "PR_kwDOA",
"title": "Version Packages",
},
]
`;
exports[`version > updates an existing PR via GraphQL without converting it to draft when prDraft is "create" 1`] = `
[
"
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
",
{
"body": "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 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 some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature",
"pullRequestId": "PR_kwDOA",
"title": "Version Packages",
},
]
`;
+11 -13
View File
@@ -1,18 +1,18 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`it sorts the things right 1`] = ` exports[`it sorts the things right 1`] = `
Array [ [
Object { {
"highestLevel": 3, "highestLevel": 3,
"name": "c", "name": "c",
"private": false, "private": false,
}, },
Object { {
"highestLevel": 1, "highestLevel": 1,
"name": "b", "name": "b",
"private": false, "private": false,
}, },
Object { {
"highestLevel": 3, "highestLevel": 3,
"name": "a", "name": "a",
"private": true, "private": true,
@@ -23,23 +23,21 @@ Array [
exports[`it works 1`] = ` exports[`it works 1`] = `
"### Major Changes "### Major Changes
- [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779): - [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779):
- Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated - Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated
### Patch Changes ### Patch Changes
- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5): - [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):
- Update dependencies - Update dependencies"
"
`; `;
exports[`it works 2`] = ` exports[`it works 2`] = `
"### Patch Changes "### Patch Changes
- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b): - [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):
Move frontmatter in docs into comments Move frontmatter in docs into comments"
"
`; `;
-64
View File
@@ -1,64 +0,0 @@
import { exec } from "@actions/exec";
import { execWithOutput } from "./utils";
export const setupUser = async () => {
await exec("git", [
"config",
"user.name",
`"github-actions[bot]"`,
]);
await exec("git", [
"config",
"user.email",
`"github-actions[bot]@users.noreply.github.com"`,
]);
};
export const pullBranch = async (branch: string) => {
await exec("git", ["pull", "origin", branch]);
};
export const push = async (
branch: string,
{ force }: { force?: boolean } = {}
) => {
await exec(
"git",
["push", "origin", `HEAD:${branch}`, force && "--force"].filter<string>(
Boolean as any
)
);
};
export const pushTags = async () => {
await exec("git", ["push", "origin", "--tags"]);
};
export const switchToMaybeExistingBranch = async (branch: string) => {
let { stderr } = await execWithOutput("git", ["checkout", branch], {
ignoreReturnCode: true,
});
let isCreatingBranch = !stderr
.toString()
.includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch]);
}
};
export const reset = async (
pathSpec: string,
mode: "hard" | "soft" | "mixed" = "hard"
) => {
await exec("git", ["reset", `--${mode}`, pathSpec]);
};
export const commitAll = async (message: string) => {
await exec("git", ["add", "."]);
await exec("git", ["commit", "-m", message]);
};
export const checkIfClean = async (): Promise<boolean> => {
const { stdout } = await execWithOutput("git", ["status", "--porcelain"]);
return !stdout.length;
};
+179
View File
@@ -0,0 +1,179 @@
import { Buffer } from "node:buffer";
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import { context } from "@actions/github";
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
import { setupOctokit, type Octokit } from "./octokit.ts";
export type CommitMode = "git-cli" | "github-api";
type GitOptions = {
cwd: string;
env?: Record<string, string>;
};
const push = async (branch: string, options: GitOptions) => {
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
};
const switchToMaybeExistingBranch = async (
branch: string,
options: GitOptions,
) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true,
...options,
});
let isCreatingBranch = !stderr
.toString()
.includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch], options);
}
};
const reset = async (pathSpec: string, options: GitOptions) => {
await exec("git", ["reset", `--hard`, pathSpec], options);
};
const commitAll = async (message: string, options: GitOptions) => {
await exec("git", ["add", "."], options);
await exec("git", ["commit", "-m", message], options);
};
const checkIfClean = async (options: GitOptions): Promise<boolean> => {
const { stdout } = await getExecOutput(
"git",
["status", "--porcelain"],
options,
);
return !stdout.length;
};
export class GitHub {
readonly #githubToken: string;
readonly octokit: Octokit;
readonly cwd: string;
readonly commitMode: CommitMode;
constructor(options: {
githubToken: string;
cwd: string;
commitMode?: CommitMode;
}) {
this.#githubToken = options.githubToken;
this.cwd = options.cwd;
this.commitMode = options.commitMode ?? "git-cli";
this.octokit = setupOctokit(options.githubToken);
}
getToken() {
return this.#githubToken;
}
#getCliAuthEnv(): Record<string, string> {
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
"base64",
);
const serverUrl = (
context.serverUrl ??
process.env.GITHUB_SERVER_URL ??
"https://github.com"
).replace(/\/+$/, "");
const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0);
if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) {
throw new Error(
`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`,
);
}
return {
GIT_CONFIG_COUNT: String(gitConfigCount + 1),
[`GIT_CONFIG_KEY_${gitConfigCount}`]: `http.${serverUrl}/.extraheader`,
[`GIT_CONFIG_VALUE_${gitConfigCount}`]: `AUTHORIZATION: basic ${basic}`,
};
}
async setupUser() {
if (this.commitMode === "github-api") {
return;
}
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
cwd: this.cwd,
});
await exec(
"git",
[
"config",
"user.email",
`"41898282+github-actions[bot]@users.noreply.github.com"`,
],
{
cwd: this.cwd,
},
);
}
async pushTag(tag: string) {
if (this.commitMode === "github-api") {
return this.octokit.rest.git
.createRef({
...context.repo,
ref: `refs/tags/${tag}`,
sha: context.sha,
})
.catch((err) => {
// Assuming tag was manually pushed in custom publish script
core.warning(`Failed to create tag ${tag}: ${err.message}`);
});
}
await exec("git", ["push", "origin", tag], {
cwd: this.cwd,
env: {
...process.env,
...this.#getCliAuthEnv(),
} as Record<string, string>,
});
}
async prepareBranch(branch: string) {
if (this.commitMode === "github-api") {
// Preparing a new local branch is not necessary when using the API
return;
}
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(context.sha, { cwd: this.cwd });
}
async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.commitMode === "github-api") {
/**
* Only add files form the current working directory
*
* This will emulate the behavior of `git add .`,
* used in {@link commitAll}.
*/
const addFromDirectory = this.cwd;
return commitChangesFromRepo({
octokit: this.octokit,
...context.repo,
branch,
message,
base: {
commit: context.sha,
},
cwd: this.cwd,
force: true,
});
}
if (!(await checkIfClean({ cwd: this.cwd }))) {
await commitAll(message, { cwd: this.cwd });
}
await push(branch, {
cwd: this.cwd,
env: {
...process.env,
...this.#getCliAuthEnv(),
} as Record<string, string>,
});
}
}
+104 -51
View File
@@ -1,42 +1,53 @@
import fs from "node:fs/promises";
import * as core from "@actions/core"; import * as core from "@actions/core";
import fs from "fs-extra"; import { GitHub } from "./github.ts";
import * as gitUtils from "./gitUtils"; import readChangesetState from "./readChangesetState.ts";
import { runPublish, runVersion } from "./run"; import { runPublish, runVersion } from "./run.ts";
import readChangesetState from "./readChangesetState"; import { fileExists, getOptionalInput } from "./utils.ts";
const getOptionalInput = (name: string) => core.getInput(name) || undefined;
(async () => { (async () => {
let githubToken = process.env.GITHUB_TOKEN; // to maintain compatibility with workflows created before github-token input was introduced
// it's important to prefer the explicitly set GITHUB_TOKEN over the default token coming from github.token
let githubToken = process.env.GITHUB_TOKEN || core.getInput("github-token");
if (!githubToken) { if (!githubToken) {
core.setFailed("Please add the GITHUB_TOKEN to the changesets action"); core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
return; return;
} }
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
const prDraft = getOptionalInput("prDraft");
if (commitMode !== "git-cli" && commitMode !== "github-api") {
core.setFailed(`Invalid commit mode: ${commitMode}`);
return;
}
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid prDraft: ${prDraft}`);
return;
}
const github = new GitHub({
cwd,
githubToken,
commitMode,
});
let setupGitUser = core.getBooleanInput("setupGitUser"); let setupGitUser = core.getBooleanInput("setupGitUser");
if (setupGitUser) { if (setupGitUser) {
console.log("setting git user"); core.info("setting git user");
await gitUtils.setupUser(); await github.setupUser();
} }
console.log("setting GitHub credentials"); let { changesets } = await readChangesetState(cwd);
await fs.writeFile(
`${process.env.HOME}/.netrc`,
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
);
const inputCwd = core.getInput("cwd");
if (inputCwd) {
console.log("changing directory to the one given as the input");
process.chdir(inputCwd);
}
let { changesets } = await readChangesetState();
let publishScript = core.getInput("publish"); let publishScript = core.getInput("publish");
let hasChangesets = changesets.length !== 0; let hasChangesets = changesets.length !== 0;
const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0,
);
let hasPublishScript = !!publishScript; let hasPublishScript = !!publishScript;
core.setOutput("published", "false"); core.setOutput("published", "false");
@@ -45,68 +56,110 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
switch (true) { switch (true) {
case !hasChangesets && !hasPublishScript: case !hasChangesets && !hasPublishScript:
console.log("No changesets found"); core.info(
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
);
return; return;
case !hasChangesets && hasPublishScript: { case !hasChangesets && hasPublishScript: {
console.log( core.info(
"No changesets found, attempting to publish any unpublished packages to npm" "No changesets found. Attempting to publish any unpublished packages to npm",
); );
let userNpmrcPath = `${process.env.HOME}/.npmrc`; if (process.env.NPM_TOKEN) {
if (fs.existsSync(userNpmrcPath)) { const userNpmrcPath = `${process.env.HOME}/.npmrc`;
console.log("Found existing user .npmrc file");
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8"); if (await fileExists(userNpmrcPath)) {
const authLine = userNpmrcContent.split("\n").find((line) => { core.info("Found existing user .npmrc file");
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105 const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line); const authLine = userNpmrcContent.split("\n").find((line) => {
}); // check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
if (authLine) { return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
console.log( });
"Found existing auth token for the npm registry in the user .npmrc file" 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 { } else {
console.log( core.info(
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one" "No user .npmrc file found, creating one with NPM_TOKEN used as auth token",
); );
fs.appendFileSync( await fs.writeFile(
userNpmrcPath, userNpmrcPath,
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n` `//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 { } else {
console.log("No user .npmrc file found, creating one"); core.info(
fs.writeFileSync( "No NPM_TOKEN or OIDC available - assuming npm is already authenticated",
userNpmrcPath,
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
); );
} }
const result = await runPublish({ const result = await runPublish({
script: publishScript, script: publishScript,
githubToken, github,
createGithubReleases: core.getBooleanInput("createGithubReleases"), createGithubReleases: core.getBooleanInput("createGithubReleases"),
cwd,
}); });
if (result.published) { if (result.published) {
core.setOutput("published", "true"); core.setOutput("published", "true");
core.setOutput( core.setOutput(
"publishedPackages", "publishedPackages",
JSON.stringify(result.publishedPackages) JSON.stringify(result.publishedPackages),
); );
} }
if (result.exitCode !== 0) {
core.error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
process.exit(result.exitCode);
}
return; return;
} }
case hasChangesets: case hasChangesets && !hasNonEmptyChangesets:
await runVersion({ core.info("All changesets are empty; not creating PR");
return;
case hasChangesets: {
const { pullRequestNumber } = await runVersion({
script: getOptionalInput("version"), script: getOptionalInput("version"),
githubToken, github,
cwd,
prTitle: getOptionalInput("title"), prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit"), commitMessage: getOptionalInput("commit"),
hasPublishScript, hasPublishScript,
prDraft,
branch: getOptionalInput("branch"),
}); });
core.setOutput("pullRequestNumber", String(pullRequestNumber));
return; return;
}
} }
})().catch((err) => { })().catch((err) => {
console.error(err); core.error(err);
core.setFailed(err.message); core.setFailed(err.message);
}); });
+41
View File
@@ -0,0 +1,41 @@
import * as core from "@actions/core";
import { getOctokit } from "@actions/github";
import { throttling } from "@octokit/plugin-throttling";
export const setupOctokit = (githubToken: string) => {
return getOctokit(
githubToken,
{
throttle: {
onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
core.warning(
`Request quota exhausted for request ${options.method} ${options.url}`,
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
onSecondaryRateLimit: (
retryAfter,
options: any,
octokit,
retryCount,
) => {
core.warning(
`SecondaryRateLimit detected for request ${options.method} ${options.url}`,
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
},
},
throttling,
);
};
export type Octokit = ReturnType<typeof setupOctokit>;
+86
View File
@@ -0,0 +1,86 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import {
downloadArtifact,
execChangesetsCli,
getOptionalInput,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
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 outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`);
await pack(cwd, {
outDir,
publishPlanPath: publishPlanArtifactId
? await downloadPublishPlanArtifact(tmpDir, Number(publishPlanArtifactId))
: undefined,
});
const packDirArtifact = await artifact.uploadArtifact(
`changeset-pack-${Date.now()}`,
await getFiles(outDir),
outDir,
{
retentionDays: 30,
},
);
if (packDirArtifact.id === undefined) {
throw new Error("Packed artifact upload did not return an artifact id");
}
core.setOutput("pack-dir-artifact-id", String(packDirArtifact.id));
}
async function pack(
cwd: string,
args: {
outDir: string;
publishPlanPath?: string;
},
) {
const cliArgs = ["pack", "--out-dir", args.outDir];
if (args.publishPlanPath) {
cliArgs.push("--from-publish-plan", args.publishPlanPath);
}
await execChangesetsCli(cliArgs, {
cwd,
env: process.env,
});
}
async function downloadPublishPlanArtifact(tmpDir: string, artifactId: number) {
const downloadPath = await downloadArtifact(
tmpDir,
artifactId,
"changeset-publish-plan",
);
return path.join(downloadPath, "publish-plan.json");
}
async function getFiles(dir: string): Promise<string[]> {
const entries = await fs.readdir(dir, { withFileTypes: true });
const files = await Promise.all(
entries.map(async (entry) => {
const entryPath = path.join(dir, entry.name);
if (entry.isDirectory()) {
return getFiles(entryPath);
}
return [entryPath];
}),
);
return files.flat();
}
+78
View File
@@ -0,0 +1,78 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
import { getOptionalInput, getRequiredInput } from "../utils.ts";
type Octokit = ReturnType<typeof github.getOctokit>;
type CreateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
>;
type UpdateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
>;
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
const githubToken = getRequiredInput("github-token");
const body = getRequiredInput("body");
const updateId = getOptionalInput("update-id");
const commentMarker = updateId ? getCommentMarker(updateId) : null;
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
const commentParam: CreateCommentParams | UpdateCommentParams = {
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
body: commentBody,
};
const octokit = github.getOctokit(githubToken);
let existingCommentId: number | undefined;
if (commentMarker) {
core.info("Checking for existing comment...");
existingCommentId = await octokit.rest.issues
.listComments({
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
})
.then((res) => {
const comment = res.data.find((c) => c.body?.includes(commentMarker));
return comment?.id;
});
}
if (existingCommentId) {
core.info(`Updating existing comment (id: ${existingCommentId})...`);
await octokit.rest.issues.updateComment({
...commentParam,
comment_id: existingCommentId,
});
core.setOutput("comment-id", existingCommentId);
} else {
core.info("Creating new comment...");
const result = await octokit.rest.issues.createComment(commentParam);
core.setOutput("comment-id", result.data.id);
}
core.info("Done!");
}
function getCommentMarker(updateId: string) {
const prefix = "changesets-action-pr-comment";
return prefix === updateId
? `<!-- ${prefix} -->`
: `<!-- ${prefix}:${updateId} -->`;
}
+23
View File
@@ -0,0 +1,23 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
import { getCommentMessage } from "./message.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
core.info("Creating comment message...");
const commentBody = await getCommentMessage(context);
core.setOutput("comment-body", commentBody);
core.info("Done!");
}
+120
View File
@@ -0,0 +1,120 @@
import * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import type {
ComprehensiveRelease,
ReleasePlan,
VersionType,
} from "@changesets/types";
import { markdownTable } from "markdown-table";
import {
getNewChangesetTemplateContent,
getNewChangesetUrl,
} from "./template.ts";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
export async function getCommentMessage(context: PullRequestContext) {
await using worktree = await getPullRequestWorktree(context);
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
const templateContent = await getNewChangesetTemplateContent(
worktree.cwd,
worktree.baseRef,
context.title,
);
const newChangesetUrl = getNewChangesetUrl(
context.head.repo.html_url,
context.head.ref,
templateContent,
);
if (releasePlan.changesets.length > 0) {
return getApproveMessage(context.head.sha, newChangesetUrl, releasePlan);
} else {
return getAbsentMessage(context.head.sha, newChangesetUrl, releasePlan);
}
}
function getApproveMessage(
commitSha: string,
newChangesetUrl: string,
releasePlan: ReleasePlan,
) {
return `\
### 🦋 Changeset detected
Latest commit: ${commitSha}
**The changes in this PR will be included in the next version bump.**
${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).
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`;
}
function getAbsentMessage(
commitSha: string,
newChangesetUrl: string,
releasePlan: ReleasePlan,
) {
return `\
### ⚠️ No Changeset found
Latest commit: ${commitSha}
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
${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 if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
}
function getReleasePlanMessage(releasePlan: ReleasePlan) {
const publishableReleases = releasePlan.releases.filter(
(r) => r.type !== "none",
) as (ComprehensiveRelease & { type: Exclude<VersionType, "none"> })[];
const table = markdownTable([
["Name", "Type"],
...publishableReleases.map((release) => {
return [
release.name,
{
major: "Major",
minor: "Minor",
patch: "Patch",
}[release.type],
];
}),
]);
let summary = "This PR includes ";
if (releasePlan.changesets.length === 0) {
summary += "no changesets";
} else {
summary += `changesets to release ${publishableReleases.length} package`;
if (publishableReleases.length !== 1) {
summary += "s";
}
}
return `\
<details>
<summary>${summary}</summary>
${
publishableReleases.length > 0
? table
: "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
}
</details>`;
}
+30
View File
@@ -0,0 +1,30 @@
import { getChangedPackagesSinceRef } from "@changesets/git";
import { humanId } from "human-id";
export function getNewChangesetUrl(
headRepoUrl: string,
headRef: string,
templateContent: string,
) {
const fileName = humanId({ separator: "-", capitalize: false });
return `${headRepoUrl}/new/${headRef}?filename=.changeset/${fileName}.md&value=${encodeURIComponent(templateContent)}`;
}
export async function getNewChangesetTemplateContent(
cwd: string,
baseRef: string,
prTitle: string,
) {
const changedPackages = await getChangedPackagesSinceRef({
cwd,
ref: baseRef,
});
return `\
---
${changedPackages.map((p) => `"${p.packageJson.name}": patch`).join("\n")}
---
${prTitle}
`;
}
+148
View File
@@ -0,0 +1,148 @@
import { pathToFileURL } from "node:url";
import type * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import { createFixture } from "fs-fixture";
import { exec } from "tinyexec";
import { describe, expect, it } from "vitest";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
async function git(cwd: string, args: string[]) {
const output = await exec("git", args, {
nodeOptions: { cwd },
throwOnError: true,
});
return output.stdout.trim();
}
describe("getPullRequestWorktree", () => {
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
// Local source repo
await using sourceRepoFixture = await createFixture({
".changeset/config.json": JSON.stringify({}),
"package.json": JSON.stringify({
name: "repo",
private: true,
workspaces: ["packages/*"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
});
const sourceRepo = sourceRepoFixture.path;
await git(sourceRepo, ["init", "-b", "main"]);
await git(sourceRepo, ["config", "user.name", "Test User"]);
await git(sourceRepo, ["config", "user.email", "test@example.com"]);
await git(sourceRepo, ["add", "."]);
await git(sourceRepo, ["commit", "-m", "base"]);
// Simulate remote bare git server
await using originBareFixture = await createFixture();
const originBare = originBareFixture.path;
await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
// Simulate checkout PR in github action
await using checkoutRepoFixture = await createFixture();
const checkoutRepo = checkoutRepoFixture.path;
await git(checkoutRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(originBare).toString(),
checkoutRepo,
]);
// Simulate remote fork bare git server
await using forkBareFixture = await createFixture();
const forkBare = forkBareFixture.path;
await git(forkBare, ["clone", "--bare", originBare, forkBare]);
await using forkRepoFixture = await createFixture();
const forkRepo = forkRepoFixture.path;
await git(forkRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(forkBare).toString(),
forkRepo,
]);
await git(forkRepo, ["config", "user.name", "Test User"]);
await git(forkRepo, ["config", "user.email", "test@example.com"]);
await git(forkRepo, ["checkout", "-b", "feature"]);
await forkRepoFixture.mkdir("packages/pkg-a/src");
await forkRepoFixture.writeFile(
"packages/pkg-a/src/index.ts",
"export const value = 1;\n",
);
await forkRepoFixture.writeFile(
".changeset/add-pkg-a.md",
`\
---
"pkg-a": patch
---
Add pkg-a
`,
);
await git(forkRepo, ["add", "."]);
await git(forkRepo, ["commit", "-m", "feature"]);
await git(forkRepo, ["push", "origin", "feature"]);
// Run tests
const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
const context = {
number: 123,
base: {
ref: "main",
repo: {
clone_url: pathToFileURL(originBare).toString(),
},
},
head: {
ref: "feature",
repo: {
clone_url: pathToFileURL(forkBare).toString(),
},
},
};
await using worktree = await getPullRequestWorktree(
context satisfies PullRequestContext as PullRequestContext,
checkoutRepo,
);
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
expect(currentHead).not.toBe(originalHead);
const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
expect(currentBranch).toBe("");
const releases = releasePlan.releases.map((release) => ({
name: release.name,
type: release.type,
newVersion: release.newVersion,
}));
expect(releases).toEqual([
{
name: "pkg-a",
type: "patch",
newVersion: "1.0.1",
},
]);
expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
});
});
+165
View File
@@ -0,0 +1,165 @@
import { randomUUID } from "node:crypto";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import type * as github from "@actions/github";
import { isRepoShallow } from "@changesets/git";
import { exec } from "tinyexec";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
type WorktreeInfo = {
baseRef: string;
cwd: string;
};
type TinyexecOptions = Parameters<typeof exec>[2];
function git(cwd: string, args: string[], opts: TinyexecOptions = {}) {
return exec("git", args, {
nodeOptions: { cwd, ...opts.nodeOptions },
throwOnError: true,
...opts,
});
}
interface Ref {
fetchSource: string;
local: string;
remote: string;
}
function getRefs(context: PullRequestContext): Record<"base" | "head", Ref> {
const suffix = `${context.number}-${randomUUID()}`;
return {
base: {
fetchSource: "origin",
local: `refs/changesets-action-pr-status/base/${suffix}`,
remote: `refs/heads/${context.base.ref}`,
},
head: {
fetchSource: context.head.repo.clone_url,
local: `refs/changesets-action-pr-status/head/${suffix}`,
remote: `refs/heads/${context.head.ref}`,
},
};
}
async function deepenRef(cwd: string, ref: Ref, deepenBy: number) {
await git(cwd, [
"fetch",
"--no-tags",
`--deepen=${deepenBy}`,
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
}
async function ensureMergeBase(args: {
cwd: string;
refs: ReturnType<typeof getRefs>;
deepenBy?: number;
}) {
const { cwd, refs, deepenBy = 50 } = args;
while (true) {
const mergeBase = await git(cwd, ["merge-base", refs.base.local, "HEAD"], {
throwOnError: false,
});
if (mergeBase.exitCode === 0) {
return mergeBase.stdout.trim();
}
if (!(await isRepoShallow({ cwd }))) {
throw new Error(
`Failed to find merge base between "${refs.base.local}" and HEAD, and the repository is no longer shallow.`,
);
}
await deepenRef(cwd, refs.base, deepenBy);
await deepenRef(cwd, refs.head, deepenBy);
}
}
async function mkdtemp(prefix: string) {
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
return {
dir,
async [Symbol.asyncDispose]() {
await fs.rm(dir, { recursive: true, force: true });
},
};
}
async function tempRef(cwd: string, ref: Ref) {
await git(cwd, [
"fetch",
"--no-tags",
"--depth=1",
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["update-ref", "-d", ref.local], { throwOnError: false });
},
};
}
async function tempWorktree(cwd: string, dir: string, ref: Ref) {
await git(cwd, ["worktree", "add", "--detach", dir, ref.local]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["worktree", "remove", "--force", dir], {
throwOnError: false,
});
},
};
}
type WithAsyncDispose<T> = T & {
[Symbol.asyncDispose](): Promise<void>;
};
function moveDisposable<T extends object>(
stack: AsyncDisposableStack,
value: T,
): WithAsyncDispose<T> {
const moved = stack.move();
return Object.assign(value, {
async [Symbol.asyncDispose]() {
await moved.disposeAsync();
},
});
}
export async function getPullRequestWorktree(
context: PullRequestContext,
cwd: string = process.cwd(),
): Promise<WithAsyncDispose<WorktreeInfo>> {
await using stack = new AsyncDisposableStack();
const worktreeDir = stack.use(
await mkdtemp("changesets-action-pr-status-"),
).dir;
const refs = getRefs(context);
stack.use(await tempRef(cwd, refs.base));
stack.use(await tempRef(cwd, refs.head));
stack.use(await tempWorktree(cwd, worktreeDir, refs.head));
await ensureMergeBase({
cwd: worktreeDir,
refs,
});
return moveDisposable(stack, {
baseRef: refs.base.local,
cwd: worktreeDir,
});
}
+67
View File
@@ -0,0 +1,67 @@
import fs from "node:fs/promises";
import os from "node:os";
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runPublish } from "../run.ts";
import {
downloadArtifact,
getOptionalInput,
getRequiredInput,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const packDirArtifactId = getOptionalInput("pack-dir-artifact-id");
const createGithubReleases = core.getBooleanInput("create-github-releases");
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
// NOTE: Always use API mode here as publish does not need a commit-mode.
const github = new GitHub({ cwd, githubToken, commitMode: "github-api" });
const fromPackDir = packDirArtifactId
? await downloadArtifact(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
Number(packDirArtifactId),
"changeset-pack",
)
: undefined;
const result = await runPublish({
script,
github,
createGithubReleases,
cwd,
fromPackDir,
});
if (result.published) {
core.setOutput("published", "true");
core.setOutput(
"published-packages",
JSON.stringify(result.publishedPackages),
);
} else {
core.setOutput("published", "false");
}
if (result.exitCode !== 0) {
throw new Error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
}
}
+9 -7
View File
@@ -1,6 +1,6 @@
import { PreState, NewChangeset } from "@changesets/types";
import { readPreState } from "@changesets/pre"; import { readPreState } from "@changesets/pre";
import readChangesets from "@changesets/read"; import readChangesets from "@changesets/read";
import type { PreState, NewChangeset } from "@changesets/types";
export type ChangesetState = { export type ChangesetState = {
preState: PreState | undefined; preState: PreState | undefined;
@@ -8,20 +8,22 @@ export type ChangesetState = {
}; };
export default async function readChangesetState( export default async function readChangesetState(
cwd: string = process.cwd() cwd: string = process.cwd(),
): Promise<ChangesetState> { ): Promise<ChangesetState> {
let preState = await readPreState(cwd); let preState = await readPreState(cwd);
let isInPreMode = preState !== undefined && preState.mode === "pre";
let changesets = await readChangesets(cwd); let changesets = await readChangesets(cwd);
if (isInPreMode) { if (preState !== undefined && preState.mode === "pre") {
let changesetsToFilter = new Set(preState.changesets); let changesetsToFilter = new Set(preState.changesets);
changesets = changesets.filter((x) => !changesetsToFilter.has(x.id));
return {
preState,
changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)),
};
} }
return { return {
preState: isInPreMode ? preState : undefined, preState: undefined,
changesets, changesets,
}; };
} }
+319 -49
View File
@@ -1,12 +1,12 @@
import fixturez from "fixturez"; import path from "node:path";
import * as github from "@actions/github"; import type { Changeset } from "@changesets/types";
import fs from "fs-extra";
import path from "path";
import writeChangeset from "@changesets/write"; import writeChangeset from "@changesets/write";
import { Changeset } from "@changesets/types"; import { createFixture } from "fs-fixture";
import { runVersion } from "./run"; import { beforeEach, describe, expect, it, vi } from "vitest";
import { GitHub } from "./github.ts";
import { runVersion } from "./run.ts";
jest.mock("@actions/github", () => ({ vi.mock("@actions/github", () => ({
context: { context: {
repo: { repo: {
owner: "changesets", owner: "changesets",
@@ -15,100 +15,190 @@ jest.mock("@actions/github", () => ({
ref: "refs/heads/some-branch", ref: "refs/heads/some-branch",
sha: "xeac7", sha: "xeac7",
}, },
getOctokit: jest.fn(), getOctokit: () => ({
rest: mockedGithubMethods,
graphql: mockedGraphql,
}),
})); }));
jest.mock("./gitUtils"); vi.mock("@changesets/ghcommit/git");
let mockedGithubMethods = { let mockedGithubMethods = {
search: {
issuesAndPullRequests: jest.fn(),
},
pulls: { pulls: {
create: jest.fn(), create: vi.fn(),
list: vi.fn(),
}, },
repos: { repos: {
createRelease: jest.fn(), createRelease: vi.fn(),
}, },
}; };
(github.getOctokit as any).mockImplementation(() => mockedGithubMethods); let mockedGraphql = vi.fn();
let f = fixturez(__dirname); const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules");
function createSimpleProjectFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-simple-project-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
function createIgnoredPackageFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({
ignore: ["changesets-dev-ignored-package-pkg-a"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-ignored-package-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "ignored-package",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
const linkNodeModules = async (cwd: string) => {
await fs.symlink(
path.join(__dirname, "..", "node_modules"),
path.join(cwd, "node_modules")
);
};
const writeChangesets = (changesets: Changeset[], cwd: string) => { const writeChangesets = (changesets: Changeset[], cwd: string) => {
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd))); return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
}; };
const createGithub = (cwd: string) =>
new GitHub({
cwd,
githubToken: "@@GITHUB_TOKEN",
commitMode: "github-api",
});
beforeEach(() => { beforeEach(() => {
jest.clearAllMocks(); vi.clearAllMocks();
}); });
describe("version", () => { describe("version", () => {
it("creates simple PR", async () => { it("creates simple PR", async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
{ {
name: "simple-project-pkg-b", name: "changesets-dev-simple-project-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", github: createGithub(cwd),
cwd, cwd,
}); });
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
}); });
it("only includes bumped packages in the PR body", async () => { it('creates a draft PR when prDraft is "create"', async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", github: createGithub(cwd),
cwd,
prDraft: "create",
});
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
});
it("only includes bumped packages in the PR body", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
github: createGithub(cwd),
cwd, cwd,
}); });
@@ -116,33 +206,213 @@ 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 () => {
let cwd = f.copy("ignored-package"); await using fixture = await createIgnoredPackageFixture();
linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
{ {
releases: [ releases: [
{ {
name: "ignored-package-pkg-b", name: "changesets-dev-ignored-package-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", github: createGithub(cwd),
cwd, cwd,
}); });
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
}); });
it("does not include changelog entries if full message exceeds size limit", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: `# Non manus superum
## Nec cornibus aequa numinis multo onerosior adde
Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
dictis, qua, in.
In modo. Nomen illa membra.
> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
> dividite proculcat facit, visa.
Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`,
},
],
cwd,
);
await runVersion({
github: createGithub(cwd),
cwd,
prBodyMaxCharacters: 1000,
});
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
/The changelog information of each package has been omitted from this message/,
);
});
it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: `# Non manus superum
## Nec cornibus aequa numinis multo onerosior adde
Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
dictis, qua, in.
In modo. Nomen illa membra.
> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
> dividite proculcat facit, visa.
Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`,
},
],
cwd,
);
await runVersion({
github: createGithub(cwd),
cwd,
prBodyMaxCharacters: 500,
});
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
/All release information have been omitted from this message, as the content exceeds the size limit/,
);
});
it('updates an existing PR via GraphQL without converting it to draft when prDraft is "create"', async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
github: createGithub(cwd),
cwd,
prDraft: "create",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
github: createGithub(cwd),
cwd,
prDraft: "always",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
}); });
+313 -186
View File
@@ -1,58 +1,72 @@
import { exec } from "@actions/exec"; import fs from "node:fs/promises";
import * as github from "@actions/github"; import path from "node:path";
import fs from "fs-extra"; import * as core from "@actions/core";
import { getPackages, Package } from "@manypkg/get-packages";
import path from "path";
import * as semver from "semver";
import { import {
getChangelogEntry, exec,
execWithOutput, getExecOutput,
type ExecOptions,
type ExecOutput,
} from "@actions/exec";
import { context } from "@actions/github";
import type { PreState } from "@changesets/types";
import { type Package, getPackages } from "@manypkg/get-packages";
import type { GitHub } from "./github.ts";
import type { Octokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts";
import {
execChangesetsCli,
getChangedPackages, getChangedPackages,
sortTheThings, getChangelogEntry,
getExecOutputChangesetsCli,
getVersionsByDirectory, getVersionsByDirectory,
} from "./utils"; isErrorWithCode,
import * as gitUtils from "./gitUtils"; sortTheThings,
import readChangesetState from "./readChangesetState"; } from "./utils.ts";
import resolveFrom from "resolve-from";
// GitHub Issues/PRs messages have a max size limit on the
// message body payload.
// `body is too long (maximum is 65536 characters)`.
// To avoid that, we ensure to cap the message to 60k chars.
const MAX_CHARACTERS_PER_MESSAGE = 60000;
const createRelease = async ( const createRelease = async (
octokit: ReturnType<typeof github.getOctokit>, octokit: Octokit,
{ pkg, tagName }: { pkg: Package; tagName: string } { pkg, tagName }: { pkg: Package; tagName: string },
) => { ) => {
let changelog;
try { try {
let changelogFileName = path.join(pkg.dir, "CHANGELOG.md"); changelog = await fs.readFile(path.join(pkg.dir, "CHANGELOG.md"), "utf8");
let changelog = await fs.readFile(changelogFileName, "utf8");
let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version);
if (!changelogEntry) {
// we can find a changelog but not the entry for this version
// if this is true, something has probably gone wrong
throw new Error(
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`
);
}
await octokit.repos.createRelease({
name: tagName,
tag_name: tagName,
body: changelogEntry.content,
prerelease: pkg.packageJson.version.includes("-"),
...github.context.repo,
});
} catch (err) { } catch (err) {
// if we can't find a changelog, the user has probably disabled changelogs if (isErrorWithCode(err, "ENOENT")) {
if (err.code !== "ENOENT") { // if we can't find a changelog, the user has probably disabled changelogs
throw err; return;
} }
throw err;
} }
let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version);
if (!changelogEntry) {
// we can find a changelog but not the entry for this version
// if this is true, something has probably gone wrong
throw new Error(
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`,
);
}
await octokit.rest.repos.createRelease({
name: tagName,
tag_name: tagName,
body: changelogEntry.content,
prerelease: pkg.packageJson.version.includes("-"),
...context.repo,
});
}; };
type PublishOptions = { type PublishOptions = {
script: string; script?: string;
githubToken: string; fromPackDir?: string;
createGithubReleases: boolean; createGithubReleases: boolean;
cwd?: string; github: GitHub;
cwd: string;
}; };
type PublishedPackage = { name: string; version: string }; type PublishedPackage = { name: string; version: string };
@@ -61,27 +75,44 @@ type PublishResult =
| { | {
published: true; published: true;
publishedPackages: PublishedPackage[]; publishedPackages: PublishedPackage[];
exitCode: number;
} }
| { | {
published: false; published: false;
exitCode: number;
}; };
export async function runPublish({ export async function runPublish({
script, script,
githubToken, fromPackDir,
github,
createGithubReleases, createGithubReleases,
cwd = process.cwd(), cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
let octokit = github.getOctokit(githubToken); const { octokit } = github;
let [publishCommand, ...publishArgs] = script.split(/\s+/); let changesetPublishOutput: ExecOutput;
const execOptions: ExecOptions = {
cwd,
ignoreReturnCode: true,
env: { ...process.env, GITHUB_TOKEN: github.getToken() },
};
let changesetPublishOutput = await execWithOutput( if (script) {
publishCommand, changesetPublishOutput = await getExecOutput(
publishArgs, script,
{ cwd } undefined,
); execOptions,
);
await gitUtils.pushTags(); } else {
const args = ["publish"];
if (fromPackDir) {
args.push("--from-pack-dir", fromPackDir);
}
changesetPublishOutput = await getExecOutputChangesetsCli(
args,
execOptions,
);
}
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = []; let releasedPackages: Package[] = [];
@@ -100,7 +131,7 @@ export async function runPublish({
if (pkg === undefined) { if (pkg === undefined) {
throw new Error( throw new Error(
`Package "${pkgName}" not found.` + `Package "${pkgName}" not found.` +
"This is probably a bug in the action, please open an issue" "This is probably a bug in the action, please open an issue",
); );
} }
releasedPackages.push(pkg); releasedPackages.push(pkg);
@@ -108,19 +139,18 @@ export async function runPublish({
if (createGithubReleases) { if (createGithubReleases) {
await Promise.all( await Promise.all(
releasedPackages.map((pkg) => releasedPackages.map(async (pkg) => {
createRelease(octokit, { const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
pkg, await github.pushTag(tagName);
tagName: `${pkg.packageJson.name}@${pkg.packageJson.version}`, await createRelease(octokit, { pkg, tagName });
}) }),
)
); );
} }
} else { } else {
if (packages.length === 0) { if (packages.length === 0) {
throw new Error( throw new Error(
`No package found.` + `No package found.` +
"This is probably a bug in the action, please open an issue" "This is probably a bug in the action, please open an issue",
); );
} }
let pkg = packages[0]; let pkg = packages[0];
@@ -132,10 +162,9 @@ export async function runPublish({
if (match) { if (match) {
releasedPackages.push(pkg); releasedPackages.push(pkg);
if (createGithubReleases) { if (createGithubReleases) {
await createRelease(octokit, { const tagName = `v${pkg.packageJson.version}`;
pkg, await github.pushTag(tagName);
tagName: `v${pkg.packageJson.version}`, await createRelease(octokit, { pkg, tagName });
});
} }
break; break;
} }
@@ -149,151 +178,249 @@ export async function runPublish({
name: pkg.packageJson.name, name: pkg.packageJson.name,
version: pkg.packageJson.version, version: pkg.packageJson.version,
})), })),
exitCode: changesetPublishOutput.exitCode,
}; };
} }
return { published: false }; return { published: false, exitCode: changesetPublishOutput.exitCode };
} }
const requireChangesetsCliPkgJson = (cwd: string) => { type GetMessageOptions = {
try { hasPublishScript: boolean;
return require(resolveFrom(cwd, "@changesets/cli/package.json")); branch: string;
} catch (err) { changedPackagesInfo: {
if (err && err.code === "MODULE_NOT_FOUND") { highestLevel: number;
throw new Error( private: boolean;
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?` content: string;
); header: string;
} }[];
throw err; prBodyMaxCharacters: number;
} preState?: PreState;
}; };
type VersionOptions = { export async function getVersionPrBody({
script?: string; hasPublishScript,
githubToken: string; preState,
cwd?: string; changedPackagesInfo,
prTitle?: string; prBodyMaxCharacters,
commitMessage?: string; branch,
hasPublishScript?: boolean; }: GetMessageOptions) {
}; let messageHeader = `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 ${
hasPublishScript
export async function runVersion({ ? `the packages will be published to npm automatically`
script, : `publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing)`
githubToken, }. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${branch}, this PR will be updated.
cwd = process.cwd(), `;
prTitle = "Version Packages", let messagePrestate = !!preState
commitMessage = "Version Packages", ? `⚠️⚠️⚠️⚠️⚠️⚠️
hasPublishScript = false,
}: VersionOptions) {
let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
let branch = github.context.ref.replace("refs/heads/", "");
let versionBranch = `changeset-release/${branch}`;
let octokit = github.getOctokit(githubToken);
let { preState } = await readChangesetState(cwd);
await gitUtils.switchToMaybeExistingBranch(versionBranch);
await gitUtils.reset(github.context.sha);
let versionsByDirectory = await getVersionsByDirectory(cwd);
if (script) {
let [versionCommand, ...versionArgs] = script.split(/\s+/);
await exec(versionCommand, versionArgs, { cwd });
} else {
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semver.lt(changesetsCliPkgJson.version, "2.0.0")
? "bump"
: "version";
await exec("node", [resolveFrom(cwd, "@changesets/cli/bin.js"), cmd], {
cwd,
});
}
let searchQuery = `repo:${repo}+state:open+head:${versionBranch}+base:${branch}`;
let searchResultPromise = octokit.search.issuesAndPullRequests({
q: searchQuery,
});
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
let prBodyPromise = (async () => {
return (
`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 ${
hasPublishScript
? `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 ${branch}, this PR will be updated.
${
!!preState
? `
⚠️⚠️⚠️⚠️⚠️⚠️
\`${branch}\` 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 \`${branch}\`. \`${branch}\` 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 \`${branch}\`.
⚠️⚠️⚠️⚠️⚠️⚠️ ⚠️⚠️⚠️⚠️⚠️⚠️
` `
: "" : "";
} let messageReleasesHeading = `# Releases`;
# Releases
` +
(
await Promise.all(
changedPackages.map(async (pkg) => {
let changelogContents = await fs.readFile(
path.join(pkg.dir, "CHANGELOG.md"),
"utf8"
);
let entry = getChangelogEntry( let fullMessage = [
changelogContents, messageHeader,
pkg.packageJson.version messagePrestate,
); messageReleasesHeading,
return { ...changedPackagesInfo.map((info) => `${info.header}\n\n${info.content}`),
highestLevel: entry.highestLevel, ].join("\n");
private: !!pkg.packageJson.private,
content:
`## ${pkg.packageJson.name}@${pkg.packageJson.version}\n\n` +
entry.content,
};
})
)
)
.filter((x) => x)
.sort(sortTheThings)
.map((x) => x.content)
.join("\n ")
);
})();
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`; // Check that the message does not exceed the size limit.
// If not, omit the changelog entries of each package.
// project with `commit: true` setting could have already committed files if (fullMessage.length > prBodyMaxCharacters) {
if (!(await gitUtils.checkIfClean())) { fullMessage = [
const finalCommitMessage = `${commitMessage}${ messageHeader,
!!preState ? ` (${preState.tag})` : "" messagePrestate,
}`; messageReleasesHeading,
await gitUtils.commitAll(finalCommitMessage); `\n> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.\n`,
...changedPackagesInfo.map((info) => `${info.header}\n\n`),
].join("\n");
} }
await gitUtils.push(versionBranch, { force: true }); // Check (again) that the message is within the size limit.
// If not, omit all release content this time.
if (fullMessage.length > prBodyMaxCharacters) {
fullMessage = [
messageHeader,
messagePrestate,
messageReleasesHeading,
`\n> All release information have been omitted from this message, as the content exceeds the size limit.`,
].join("\n");
}
let searchResult = await searchResultPromise; return fullMessage;
console.log(JSON.stringify(searchResult.data, null, 2)); }
if (searchResult.data.items.length === 0) {
console.log("creating pull request"); type VersionOptions = {
await octokit.pulls.create({ script?: string;
github: GitHub;
cwd?: string;
prTitle?: string;
commitMessage?: string;
hasPublishScript?: boolean;
prBodyMaxCharacters?: number;
prDraft?: "always" | "create";
branch?: string;
};
type RunVersionResult = {
pullRequestNumber: number;
};
export async function runVersion({
script,
github,
cwd = process.cwd(),
prTitle = "Version Packages",
commitMessage = "Version Packages",
hasPublishScript = false,
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
branch = context.ref.replace("refs/heads/", ""),
prDraft,
}: VersionOptions): Promise<RunVersionResult> {
const { octokit } = github;
let versionBranch = `changeset-release/${branch}`;
let { preState } = await readChangesetState(cwd);
await github.prepareBranch(versionBranch);
let versionsByDirectory = await getVersionsByDirectory(cwd);
const env = { ...process.env, GITHUB_TOKEN: github.getToken() };
if (script) {
await exec(script, undefined, { cwd, env });
} else {
await execChangesetsCli(["version"], { cwd, env });
}
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
let changedPackagesInfoPromises = Promise.all(
changedPackages.map(async (pkg) => {
let changelogContents = await fs.readFile(
path.join(pkg.dir, "CHANGELOG.md"),
"utf8",
);
let entry = getChangelogEntry(changelogContents, pkg.packageJson.version);
return {
highestLevel: entry.highestLevel,
private: !!pkg.packageJson.private,
content: entry.content,
header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`,
};
}),
);
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
const finalCommitMessage = `${commitMessage}${
!!preState ? ` (${preState.tag})` : ""
}`;
/**
* Fetch any existing pull requests that are open against the branch,
* before we push any changes that may inadvertently close the existing PRs.
*
* (`@changesets/ghcommit` has to reset the branch to the same commit as the base,
* which GitHub will then react to by closing the PRs)
*/
const existingPullRequests = await octokit.rest.pulls.list({
...context.repo,
state: "open",
head: `${context.repo.owner}:${versionBranch}`,
base: branch,
});
core.info(
`Existing pull requests: ${JSON.stringify(
existingPullRequests.data,
null,
2,
)}`,
);
await github.pushChanges({
branch: versionBranch,
message: finalCommitMessage,
});
const changedPackagesInfo = (await changedPackagesInfoPromises)
.filter((x) => x)
.sort(sortTheThings);
let prBody = await getVersionPrBody({
hasPublishScript,
preState,
branch,
changedPackagesInfo,
prBodyMaxCharacters,
});
if (existingPullRequests.data.length === 0) {
core.info("creating pull request");
const { data: newPullRequest } = await octokit.rest.pulls.create({
base: branch, base: branch,
head: versionBranch, head: versionBranch,
title: finalPrTitle, title: finalPrTitle,
body: await prBodyPromise, body: prBody,
...github.context.repo, draft: prDraft !== undefined,
...context.repo,
}); });
return {
pullRequestNumber: newPullRequest.number,
};
} else { } else {
octokit.pulls.update({ const [pullRequest] = existingPullRequests.data;
pull_number: searchResult.data.items[0].number,
core.info(`updating found pull request #${pullRequest.number}`);
const convertPullRequestToDraftMutation =
prDraft === "always"
? `
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}`
: "";
const updatePullRequestMutation = `
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
${convertPullRequestToDraftMutation}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
`;
await octokit.graphql(updatePullRequestMutation, {
pullRequestId: pullRequest.node_id,
title: finalPrTitle, title: finalPrTitle,
body: await prBodyPromise, body: prBody,
...github.context.repo,
}); });
console.log("pull request found");
return {
pullRequestNumber: pullRequest.number,
};
} }
} }
+119
View File
@@ -0,0 +1,119 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import readChangesetState from "../readChangesetState.ts";
import { execChangesetsCli } from "../utils.ts";
type ModeResult =
| {
mode: "none";
}
| {
mode: "version";
}
| {
mode: "publish";
publishPlanPath: string;
};
type PublishPlan = unknown[];
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const result = await getMode();
core.setOutput("mode", result.mode);
if (result.mode === "publish") {
const publishPlanArtifact = await artifact.uploadArtifact(
path.basename(result.publishPlanPath, ".json"),
[result.publishPlanPath],
path.dirname(result.publishPlanPath),
{
skipArchive: true,
retentionDays: 30,
},
);
if (publishPlanArtifact.id === undefined) {
throw new Error(
"Publish plan artifact upload did not return an artifact id",
);
}
core.setOutput("publish-plan-artifact-id", String(publishPlanArtifact.id));
}
}
async function getMode(): Promise<ModeResult> {
const { changesets } = await readChangesetState();
if (changesets.length > 0) {
const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0,
);
if (hasNonEmptyChangesets) {
return { mode: "version" };
}
return { mode: "none" };
}
const cwd = process.cwd();
const publishPlanPath = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
`changeset-publish-plan-${Date.now()}`,
// we need a stable filename here (in a unique dirname) so the artifact download can find this cleanly
"publish-plan.json",
);
await execChangesetsCli(["publish-plan", "--output", publishPlanPath], {
cwd,
env: process.env,
});
const publishPlan = await readPublishPlan(publishPlanPath);
if (publishPlan.length === 0) {
return { mode: "none" };
}
return {
mode: "publish",
publishPlanPath,
};
}
async function readPublishPlan(publishPlanPath: string): Promise<PublishPlan> {
let rawPlan: string;
try {
rawPlan = await fs.readFile(publishPlanPath, "utf8");
} catch (err) {
throw new Error(`Failed to read publish plan at ${publishPlanPath}`, {
cause: err,
});
}
let plan: unknown;
try {
plan = JSON.parse(rawPlan);
} catch (err) {
throw new Error(`Failed to parse publish plan at ${publishPlanPath}`, {
cause: err,
});
}
if (
typeof plan !== "object" ||
plan === null ||
!("version" in plan) ||
typeof plan.version !== "number" ||
!("plan" in plan) ||
!Array.isArray(plan.plan)
) {
throw new Error(
`Invalid publish plan at ${publishPlanPath}: expected { version: number; plan: unknown[] }`,
);
}
return plan.plan;
}
+2 -1
View File
@@ -1,4 +1,5 @@
import { getChangelogEntry, BumpLevels, sortTheThings } from "./utils"; import { expect, test } from "vitest";
import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts";
let changelog = `# @keystone-alpha/email let changelog = `# @keystone-alpha/email
+136 -73
View File
@@ -1,10 +1,17 @@
import unified from "unified"; import fs from "node:fs/promises";
import remarkParse from "remark-parse"; import { createRequire } from "node:module";
import remarkStringify from "remark-stringify"; import path from "node:path";
// @ts-ignore import artifact from "@actions/artifact";
import mdastToString from "mdast-util-to-string"; import * as core from "@actions/core";
import { exec } from "@actions/exec"; import {
import { getPackages, Package } from "@manypkg/get-packages"; exec,
getExecOutput,
type ExecOptions as ActionsExecOptions,
type ExecOutput,
} from "@actions/exec";
import { getPackages, type Package } from "@manypkg/get-packages";
const require = createRequire(import.meta.url);
export const BumpLevels = { export const BumpLevels = {
dep: 0, dep: 0,
@@ -20,7 +27,7 @@ export async function getVersionsByDirectory(cwd: string) {
export async function getChangedPackages( export async function getChangedPackages(
cwd: string, cwd: string,
previousVersions: Map<string, string> previousVersions: Map<string, string>,
) { ) {
let { packages } = await getPackages(cwd); let { packages } = await getPackages(cwd);
let changedPackages = new Set<Package>(); let changedPackages = new Set<Package>();
@@ -36,86 +43,61 @@ export async function getChangedPackages(
} }
export function getChangelogEntry(changelog: string, version: string) { export function getChangelogEntry(changelog: string, version: string) {
let ast = unified().use(remarkParse).parse(changelog);
let highestLevel: number = BumpLevels.dep; let highestLevel: number = BumpLevels.dep;
let headingStartInfo: { index: number; depth: number } | undefined;
let nodes = ast.children as Array<any>;
let headingStartInfo:
| {
index: number;
depth: number;
}
| undefined;
let endIndex: number | undefined; let endIndex: number | undefined;
for (let i = 0; i < nodes.length; i++) { // Iterate through each headings and code blocks (for skipping its contents)
let node = nodes[i]; const regex = /^(#{1,6})\s(.*)$|^(`{3,})/gm;
if (node.type === "heading") { let match: RegExpExecArray | null;
let stringified: string = mdastToString(node); while ((match = regex.exec(changelog)) != null) {
let match = stringified.toLowerCase().match(/(major|minor|patch)/); // Skip over code blocks so we don't match any headings inside of them
if (match !== null) { if (match[3]) {
let level = BumpLevels[match[0] as "major" | "minor" | "patch"]; const endOfCodeBlockRegex = new RegExp(`^${match[3]}`, "gm");
highestLevel = Math.max(level, highestLevel); endOfCodeBlockRegex.lastIndex = regex.lastIndex;
} const endMatch = endOfCodeBlockRegex.exec(changelog);
if (headingStartInfo === undefined && stringified === version) { if (endMatch) {
headingStartInfo = { // Start next search for headings after the end of the code block
index: i, regex.lastIndex = endOfCodeBlockRegex.lastIndex;
depth: node.depth,
};
continue; continue;
} } else {
if ( // Can't find end of code block, probably malformed
endIndex === undefined &&
headingStartInfo !== undefined &&
headingStartInfo.depth === node.depth
) {
endIndex = i;
break; break;
} }
} }
}
if (headingStartInfo) {
ast.children = (ast.children as any).slice(
headingStartInfo.index + 1,
endIndex
);
}
return {
content: unified().use(remarkStringify).stringify(ast),
highestLevel: highestLevel,
};
}
export async function execWithOutput( const headingDepth = match[1].length;
command: string, const headingText = match[2].trim();
args?: string[],
options?: { ignoreReturnCode?: boolean; cwd?: string } // Search for the highest bump level in the entire changelog
) { const levelMatch = /(major|minor|patch)/.exec(headingText.toLowerCase());
let myOutput = ""; if (levelMatch != null) {
let myError = ""; const level = BumpLevels[levelMatch[0] as "major" | "minor" | "patch"];
highestLevel = Math.max(level, highestLevel);
}
// Search for heading of the entry
if (headingText === version) {
headingStartInfo = { index: regex.lastIndex, depth: headingDepth };
continue;
}
// If we've found the entry heading, search for the closing heading with the same depth
if (headingStartInfo && headingDepth === headingStartInfo.depth) {
endIndex = match.index;
break;
}
}
return { return {
code: await exec(command, args, { content: changelog.slice(headingStartInfo?.index, endIndex).trim(),
listeners: { highestLevel,
stdout: (data: Buffer) => {
myOutput += data.toString();
},
stderr: (data: Buffer) => {
myError += data.toString();
},
},
...options,
}),
stdout: myOutput,
stderr: myError,
}; };
} }
export function sortTheThings( export function sortTheThings(
a: { private: boolean; highestLevel: number }, a: { private: boolean; highestLevel: number },
b: { private: boolean; highestLevel: number } b: { private: boolean; highestLevel: number },
) { ) {
if (a.private === b.private) { if (a.private === b.private) {
return b.highestLevel - a.highestLevel; return b.highestLevel - a.highestLevel;
@@ -125,3 +107,84 @@ export function sortTheThings(
} }
return -1; return -1;
} }
export function isErrorWithCode(err: unknown, code: string) {
return (
typeof err === "object" &&
err !== null &&
"code" in err &&
err.code === code
);
}
export function fileExists(filePath: string) {
return fs.access(filePath, fs.constants.F_OK).then(
() => true,
() => false,
);
}
export function getOptionalInput(name: string) {
// normalize empty string default return value of `core.getInput` to undefined
return core.getInput(name) || undefined;
}
export function getRequiredInput(name: string) {
// it's just a small utility wrapper, mainly introduced for usage parity with our custom `getOptionalInput`
// note: `core.getBooleanInput` gets used directly as it already normalizes the return value nicely
return core.getInput(name, { required: true });
}
function resolveChangesetsCli(cwd: string) {
return require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
});
}
interface ExecOptions extends Omit<ActionsExecOptions, "env"> {
env?: Record<string, string | undefined>;
}
export function execChangesetsCli(args: string[], options?: ExecOptions) {
return exec(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export function getExecOutputChangesetsCli(
args: string[],
options?: ExecOptions,
): Promise<ExecOutput> {
return getExecOutput(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export async function downloadArtifact(
tmpDir: string,
artifactId: number,
name: string,
) {
if (!Number.isInteger(artifactId) || artifactId <= 0) {
throw new Error(
`Invalid ${JSON.stringify(name)} artifact id: ${artifactId}`,
);
}
const downloadPath = path.join(tmpDir, `${name}-${artifactId}-${Date.now()}`);
const result = await artifact.downloadArtifact(artifactId, {
path: downloadPath,
});
if (!result.downloadPath) {
throw new Error(
`${JSON.stringify(name)} artifact download did not return a path for artifact ${artifactId}`,
);
}
return result.downloadPath;
}
+57
View File
@@ -0,0 +1,57 @@
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runVersion } from "../run.ts";
import { getOptionalInput, getRequiredInput } from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const commitMessage = getRequiredInput("commit-message");
const prTitle = getRequiredInput("pr-title");
const prDraft = getOptionalInput("pr-draft");
const prBaseBranch = getOptionalInput("pr-base-branch");
const commitMode = getOptionalInput("commit-mode") ?? "git-cli";
const setupGitUser = core.getBooleanInput("setup-git-user");
// Validations
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
throw new Error(`Invalid pr-draft input: ${prDraft}`);
}
if (commitMode !== "git-cli" && commitMode !== "github-api") {
throw new Error(`Invalid commit-mode input: ${commitMode}`);
}
// If the user needs to change the cwd, set `working-directory` in the step instead
const cwd = process.cwd();
const github = new GitHub({
cwd,
githubToken,
commitMode,
});
if (setupGitUser) {
core.info("setting git user");
await github.setupUser();
}
const { pullRequestNumber } = await runVersion({
script,
github,
cwd,
prTitle,
commitMessage,
// TODO: Use neutral message for PR description
hasPublishScript: true,
prDraft,
branch: prBaseBranch,
});
core.setOutput("pr-number", String(pullRequestNumber));
}
+7 -59
View File
@@ -1,63 +1,11 @@
{ {
"extends": "@tsconfig/node24/tsconfig.json",
"compilerOptions": { "compilerOptions": {
/* Basic Options */ "allowImportingTsExtensions": true,
// "incremental": true, /* Enable incremental compilation */ "erasableSyntaxOnly": true,
"target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */, "verbatimModuleSyntax": true,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, "strict": true,
// "lib": [], /* Specify library files to be included in the compilation. */ "noEmit": true,
// "allowJs": true, /* Allow javascript files to be compiled. */ "types": ["node"]
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
"noEmit": true /* Do not emit outputs. */,
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
"isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,
/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
} }
} }
-17
View File
@@ -1,17 +0,0 @@
type Opts = {
glob?: string | Array<string>;
root?: string;
cleanup?: boolean;
};
declare module "fixturez" {
export default function (
cwd: string,
opts?: Opts
): {
find: (a: string) => string;
temp: () => string;
copy: (a: string) => string;
cleanup: () => any;
};
}
+3
View File
@@ -0,0 +1,3 @@
# changesets/action/version
TODO
+43
View File
@@ -0,0 +1,43 @@
name: Changesets - Version
description: Version packages
runs:
using: node24
main: ../dist/version.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
script:
description: "The command to use to version packages"
required: false
commit-message:
description: "The commit message. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-title:
description: "The pull request title. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-draft:
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
required: false
pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false
commit-mode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
all commits and tags are signed using GitHub's GPG key and attributed to the user
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
setup-git-user:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
required: false
default: true
outputs: {}
branding:
icon: package
color: blue
-9461
View File
File diff suppressed because it is too large Load Diff