Compare commits

...
91 Commits
Author SHA1 Message Date
github-actions[bot] c48e67d110 v1.6.0 2026-01-21 12:28:33 +00: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
github-actions[bot]andgithub-actions[bot] 69dae4d9ca Version Packages (#145)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-03-04 08:30:04 +01:00
Mateusz Burzyński 56bd5e54f8 Add concurrency option to the exampels in the README (#156) 2022-03-04 07:27:33 +01:00
Mateusz Burzyński 898d125cee Updated all Changesets dependencies (#144) 2022-01-27 07:36:21 +01:00
github-actions[bot]andgithub-actions[bot] e8ffc2d207 Version Packages (#140)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-01-23 14:27:10 +01:00
David RegisterandMateusz Burzyński 1ed9bc24b7 Added cwd input option (#134)
* feat: add cwd for projects that not in the root directory

* docs: add cwd to README

* reword the added log

* tweak changeset

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-01-23 14:25:45 +01:00
An PhiandMateusz Burzyński 5c0997b25e Added createGithubReleases input option (defaults to true) to control whether to create Github releases during publish or not (#130)
* allow skipping creation of Github releases

* fixes for PR review

* minor improvements

* add changeset

* nits

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2022-01-23 11:07:42 +01:00
github-actions[bot]andgithub-actions[bot] f4afbea27e Version Packages (#129)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-01-07 16:41:51 +01:00
Jack LeslieandMitchell Hamilton d3db9eceaf Added setupGitUser option to enable or disable setting up a default git user (#131)
* custom git user option

* Create two-dolls-promise.md

* Update two-dolls-promise.md

* change input name and update default

* Update .changeset/two-dolls-promise.md

Co-authored-by: Mitchell Hamilton <mitchell@hamil.town>
2022-01-07 15:27:29 +01:00
Mateusz Burzyński e0c51a52b8 Fix changeset author attribution 2021-12-23 11:31:32 +01:00
Mateusz BurzyńskiandDhruvdutt Jadhav 19373036c4 Setup the git user in the local config instead of the global one (#128)
* Update gitUtils.ts

* add changeset

Co-authored-by: Dhruvdutt Jadhav <dhruvdutt.jadhav@razorpay.com>
2021-12-23 11:21:40 +01:00
Mateusz Burzyński 37c2edd85b Fixed the checkout repo step in ci.yml 2021-11-26 14:18:16 +01:00
Mitchell Hamilton 5556dd0a57 Reference specific versions of other actions (#122) 2021-11-26 10:23:11 +01:00
2eadeb0ff8 Version Packages (#119)
* Version Packages

* Fixup version bump

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2021-11-25 18:07:53 +01:00
Mateusz Burzyński 3ea945d945 Rename version script to bump 2021-11-25 18:02:16 +01:00
Mateusz Burzyński 77633d0426 Fixed how local action is referenced from the workflow file 2021-11-25 17:53:46 +01:00
Mateusz BurzyńskiandNicola Molinari 05c863d3f9 Switch to Changesets-based release process (#118)
* Switch to Changesets-based release process

* Bump version

* drop unused variable

* Update .github/workflows/version-or-publish.yml

Co-authored-by: Nicola Molinari <nicola.molinari@commercetools.com>

* Push also to a release line branch when releasing

* Change node version used in the version-or-publish workflow

* Switch to using the local action

Co-authored-by: Nicola Molinari <nicola.molinari@commercetools.com>

* build the action before trying to use it the workflow

* Add changeset and actually setup Changesets, lol

Co-authored-by: Nicola Molinari <nicola.molinari@commercetools.com>
2021-11-25 17:51:48 +01:00
35 changed files with 3070 additions and 9606 deletions
-6
View File
@@ -1,6 +0,0 @@
{
"presets": [
["@babel/preset-env", { "targets": { "node": 10 } }],
"@babel/preset-typescript"
]
}
+8
View File
@@ -0,0 +1,8 @@
# Changesets
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
+13
View File
@@ -0,0 +1,13 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.6.2/schema.json",
"changelog": [
"@changesets/changelog-github",
{ "repo": "changesets/action" }
],
"commit": false,
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
+14
View File
@@ -0,0 +1,14 @@
name: Setup CI
runs:
using: composite
steps:
- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version-file: ".node-version"
cache: yarn
- name: Install dependencies
shell: bash
run: yarn install --frozen-lockfile
+11
View File
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
+11 -8
View File
@@ -1,6 +1,10 @@
name: Node CI name: Node CI
on: [push] on:
push:
branches:
- main
pull_request:
jobs: jobs:
build: build:
@@ -9,15 +13,14 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- name: Use Node.js 12
uses: actions/setup-node@v1
with: with:
node-version: 12.x ref: ${{ github.event.pull_request.head.sha }}
- name: Install dependencies - uses: ./.github/actions/ci-setup
run: yarn
- name: Typecheck
run: yarn typecheck
- name: Test - name: Test
run: yarn test run: yarn test
+102
View File
@@ -0,0 +1,102 @@
name: Release PR
on:
issue_comment:
types: [created]
jobs:
release_check:
if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr')
runs-on: ubuntu-latest
steps:
- id: report_in_progress
run: |
echo "in_progress_reaction_id=$(gh api /repos/${{github.repository}}/issues/comments/${{github.event.comment.id}}/reactions -f content='eyes' --jq '.id')" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- 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 }}
outputs:
in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }}
release:
if: github.repository == 'changesets/action'
timeout-minutes: 20
runs-on: ubuntu-latest
needs: release_check
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/ci-setup
- name: Checkout pull request
run: gh pr checkout ${{ github.event.issue.number }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Check if Version Packages PR
id: check_version_packages
run: |
echo "version_packages=$(gh pr view ${{ github.event.issue.number }} --json headRefName --jq '.headRefName|startswith("changeset-release/")')" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Reset Version Packages PR
if: steps.check_version_packages.outputs.version_packages == 'true'
run: git reset --hard HEAD~1
- run: yarn changeset version --snapshot pr${{ github.event.issue.number }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Build
run: yarn 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: yarn run release:pr
- run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='rocket'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh api -X DELETE /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions/${{ needs.release_check.outputs.in_progress_reaction_id }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh pr comment ${{ github.event.issue.number }} --body "The [${{ github.repository }}@$(git rev-parse HEAD)](https://github.com/${{ github.repository }}/commit/$(git rev-parse HEAD)) release triggered by [this comment](${{ github.event.comment.url }}) has [succeeded](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})."
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
report-failure-if-needed:
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')
steps:
- run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='-1'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh api -X DELETE /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions/${{ needs.release_check.outputs.in_progress_reaction_id }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh pr comment ${{ github.event.issue.number }} --body "The release triggered by [this comment](${{ github.event.comment.url }}) has [failed](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})."
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
+27
View File
@@ -0,0 +1,27 @@
name: Version or Publish
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
changesets:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/ci-setup
- 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 }}
+3 -1
View File
@@ -1,4 +1,6 @@
node_modules node_modules
.parcel-cache .parcel-cache
.cache .cache
*.log *.log
dist/
+1
View File
@@ -0,0 +1 @@
v24.11.0
+16
View File
@@ -0,0 +1,16 @@
{
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Debug Current Test File",
"autoAttachChildProcesses": true,
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
"args": ["run", "${relativeFile}"],
"smartStep": true,
"console": "integratedTerminal"
}
]
}
+3
View File
@@ -0,0 +1,3 @@
{
"typescript.tsdk": "node_modules/typescript/lib"
}
+173
View File
@@ -0,0 +1,173 @@
# @changesets/action
## 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
### Patch Changes
- [#144](https://github.com/changesets/action/pull/144) [`898d125`](https://github.com/changesets/action/commit/898d125cee6ba00c6a11b6cadca512752c6c910c) Thanks [@Andarist](https://github.com/Andarist)! - Updated all Changesets dependencies. This should fix parsing issues for completely empty summaries that has been fixed in `@changesets/parse@0.3.11`.
## 1.2.0
### Minor Changes
- [#130](https://github.com/changesets/action/pull/130) [`5c0997b`](https://github.com/changesets/action/commit/5c0997b25e175ecf5e1723ba07210bbcea5d92fb) Thanks [@akphi](https://github.com/akphi)! - Added `createGithubReleases` input option (defaults to `true`) to control whether to create Github releases during publish or not.
* [#134](https://github.com/changesets/action/pull/134) [`1ed9bc2`](https://github.com/changesets/action/commit/1ed9bc24b7a56462c183eb815c8f4bdf0e2e5785) Thanks [@dmregister](https://github.com/dmregister)! - Added `cwd` input option that can be used in projects that are not in the root directory.
## 1.1.0
### Minor Changes
- [#128](https://github.com/changesets/action/pull/128) [`1937303`](https://github.com/changesets/action/commit/19373036c4bad4b0183344b6f2623a3b0e42da6c) Thanks [@dhruvdutt](https://github.com/dhruvdutt)! - Setup the git user in the local config instead of the global one.
* [#131](https://github.com/changesets/action/pull/131) [`d3db9ec`](https://github.com/changesets/action/commit/d3db9eceaf41d42c56d5370d504c86851627188f) Thanks [@jacklesliewise](https://github.com/jacklesliewise)! - Added `setupGitUser` option to enable or disable setting up a default git user
## 1.0.0
### Major Changes
- [#118](https://github.com/changesets/action/pull/118) [`05c863d`](https://github.com/changesets/action/commit/05c863d3f980125585016a593b5cb45b27d19c2c) Thanks [@Andarist](https://github.com/Andarist)! - From now on this action will be released using the Changesets-based workflow (using itself). Thanks to that we'll have a good release history. The users will be able to find specific versions of the action and will be able to track changes over time. It also improves the security as the build artifact will always get built in the CI environment, using a frozen lockfile.
+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.
+73 -30
View File
@@ -1,6 +1,6 @@
# 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. 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.
## Usage ## Usage
@@ -10,10 +10,14 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided - version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- commit - The commit message to use. Default to `Version Packages` - 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`
- 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()`
### 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:
@@ -28,7 +32,9 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs: jobs:
release: release:
@@ -36,21 +42,18 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@master uses: actions/checkout@v3
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 Node.js 20
uses: actions/setup-node@master uses: actions/setup-node@v3
with: with:
node-version: 12.x node-version: 20
- name: Install Dependencies - name: Install Dependencies
run: yarn run: yarn
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@master uses: changesets/action@v1
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
@@ -65,7 +68,9 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs: jobs:
release: release:
@@ -73,22 +78,19 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@master uses: actions/checkout@v3
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 Node.js 20.x
uses: actions/setup-node@master uses: actions/setup-node@v3
with: with:
node-version: 12.x node-version: 20.x
- name: Install Dependencies - name: Install Dependencies
run: yarn run: yarn
- 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@master uses: changesets/action@v1
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: yarn release
@@ -115,13 +117,54 @@ 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@v3
- name: Setup Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x
- name: Install Dependencies
run: yarn
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Publish
if: steps.changesets.outputs.hasChangesets == 'false'
# You can do something when a publish should happen.
run: yarn 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.
@@ -134,7 +177,9 @@ name: Release
on: on:
push: push:
branches: branches:
- master - main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs: jobs:
release: release:
@@ -142,20 +187,18 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@master uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Node.js 12.x - name: Setup Node.js 20.x
uses: actions/setup-node@master uses: actions/setup-node@v3
with: with:
node-version: 12.x node-version: 20.x
- name: Install Dependencies - name: Install Dependencies
run: yarn run: yarn
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@master uses: changesets/action@v1
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: yarn version
@@ -168,7 +211,7 @@ 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@master - uses: changesets/action@v1
with: with:
version: yarn changeset version version: yarn changeset version
... ...
+27 -1
View File
@@ -1,7 +1,7 @@
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:
publish: publish:
@@ -10,6 +10,9 @@ inputs:
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`
@@ -17,12 +20,35 @@ inputs:
title: title:
description: The pull request title. Default to `Version Packages` description: The pull request title. Default to `Version Packages`
required: false required: false
setupGitUser:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
required: false
default: true
createGithubReleases:
description: "A boolean value to indicate whether to create Github releases after `publish` or not"
required: false
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
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"
+55 -909
View File
File diff suppressed because one or more lines are too long
+46 -31
View File
@@ -1,50 +1,65 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "0.1.0", "version": "1.6.0",
"main": "dist/index.js", "main": "dist/index.js",
"type": "module",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"@changesets/cli": "^2.9.1", "@changesets/changelog-github": "^0.5.1",
"@changesets/write": "^0.1.3", "@changesets/cli": "^2.29.3",
"@changesets/write": "^0.4.0",
"@rollup/plugin-commonjs": "^28.0.3",
"@rollup/plugin-json": "^6.1.0",
"@rollup/plugin-node-resolve": "^16.0.1",
"@rollup/plugin-terser": "^0.4.4",
"@types/node": "^22.15.17",
"@types/semver": "^7.5.0",
"builtin-modules": "^5.0.0",
"esbuild": "^0.25.4",
"fixturez": "^1.1.0", "fixturez": "^1.1.0",
"parcel": "^1.12.3", "husky": "^3.0.3",
"prettier": "^2.0.5", "prettier": "^2.0.5",
"typescript": "^3.5.3" "rollup": "^4.40.2",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
}, },
"scripts": { "scripts": {
"build": "parcel build ./src/index.ts --no-source-maps --target=node --bundle-node-modules", "build": "rollup -c",
"test": "jest", "test": "vitest",
"test:watch": "yarn test --watch" "test:watch": "yarn test --watch",
"typecheck": "tsc",
"changeset": "changeset",
"bump": "node --experimental-strip-types ./scripts/bump.ts",
"release": "node --experimental-strip-types ./scripts/release.ts",
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts"
},
"engines": {
"node": ">= 24"
}, },
"dependencies": { "dependencies": {
"@actions/core": "^1.2.4", "@actions/core": "^1.11.1",
"@actions/exec": "^1.0.4", "@actions/exec": "^1.1.1",
"@actions/github": "^4.0.0", "@actions/github": "^6.0.1",
"@babel/core": "^7.13.10", "@changesets/ghcommit": "^2.0.0",
"@babel/preset-env": "^7.13.10", "@changesets/pre": "^2.0.2",
"@babel/preset-typescript": "^7.13.0", "@changesets/read": "^0.6.5",
"@changesets/pre": "^1.0.4", "@manypkg/get-packages": "^1.1.3",
"@changesets/read": "^0.4.6", "@octokit/core": "^5.2.1",
"@manypkg/get-packages": "^1.1.1", "@octokit/plugin-throttling": "^8.0.0",
"@types/fs-extra": "^8.0.0", "@types/mdast": "^3.0.0",
"@types/jest": "^24.0.18",
"@types/node": "^12.7.1",
"@types/semver": "^6.0.2",
"babel-jest": "^24.9.0",
"fs-extra": "^8.1.0",
"husky": "^3.0.3",
"jest": "^24.9.0",
"mdast-util-to-string": "^1.0.6", "mdast-util-to-string": "^1.0.6",
"remark-parse": "^7.0.1", "remark-parse": "^7.0.1",
"remark-stringify": "^7.0.3", "remark-stringify": "^7.0.3",
"resolve-from": "^5.0.0", "semver": "^7.5.3",
"semver": "^6.3.0",
"unified": "^8.3.2" "unified": "^8.3.2"
}, },
"husky": { "husky": {
"hooks": { "hooks": {}
"pre-commit": "yarn build && git add dist/index.js"
}
}, },
"prettier": {} "prettier": {},
"resolutions": {
"trim": "^0.0.3",
"y18n": "^4.0.1"
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
} }
+38
View File
@@ -0,0 +1,38 @@
import { defineConfig } from "rollup";
import commonjs from "@rollup/plugin-commonjs";
import nodeResolve from "@rollup/plugin-node-resolve";
import terser from "@rollup/plugin-terser";
import json from "@rollup/plugin-json";
import { transform } from "esbuild";
import builtinModulesList from "builtin-modules";
const builtinModules = new Set(builtinModulesList);
export default defineConfig({
input: "src/index.ts",
output: {
dir: "dist",
format: "esm",
},
external: (id) => builtinModules.has(id),
plugins: [
nodeResolve({
preferBuiltins: false,
}),
json(),
commonjs(),
{
name: "esbuild",
async transform(code, id) {
if (!/\.(mts|cts|ts|tsx)$/.test(id)) {
return null;
}
const result = await transform(code, {
loader: "ts",
});
return result.code;
},
},
terser(),
],
});
+18
View File
@@ -0,0 +1,18 @@
import { exec } from "@actions/exec";
import fs from "node:fs";
import path from "node:path";
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);
+20
View File
@@ -0,0 +1,20 @@
import { exec } from "@actions/exec";
import path from "node:path";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = "pr-release";
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}`,
]);
+42
View File
@@ -0,0 +1,42 @@
import { exec, getExecOutput } from "@actions/exec";
import path from "node:path";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
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"]);
await exec("git", [
"push",
"--force",
"--follow-tags",
"origin",
`HEAD:refs/heads/${releaseLine}`,
]);
})();
+55 -12
View File
@@ -1,11 +1,12 @@
// 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 simple PR 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 ## simple-project-pkg-a@1.1.0
@@ -15,10 +16,10 @@ Array [
### Patch Changes ### Patch Changes
- Updated dependencies [undefined] - Updated dependencies
- simple-project-pkg-b@1.1.0 - simple-project-pkg-b@1.1.0
## simple-project-pkg-b@1.1.0 ## simple-project-pkg-b@1.1.0
### Minor Changes ### Minor Changes
@@ -32,12 +33,53 @@ 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
> All release information have been omitted from this message, as the content exceeds the size limit.",
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > does not include changelog entries if full message exceeds size limit 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
> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.
## simple-project-pkg-a@1.1.0
",
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
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 # Releases
## ignored-package-pkg-b@1.1.0 ## ignored-package-pkg-b@1.1.0
@@ -53,12 +95,13 @@ Array [
] ]
`; `;
exports[`version only includes bumped packages in the PR body 1`] = ` exports[`version > only includes bumped packages in the PR body 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 ## simple-project-pkg-a@1.1.0
+5 -5
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,
+129
View File
@@ -0,0 +1,129 @@
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github";
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
import type { Octokit } from "./octokit.ts";
type GitOptions = {
cwd: 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 Git {
readonly octokit: Octokit | null;
readonly cwd: string;
constructor(args: { octokit?: Octokit; cwd: string }) {
this.octokit = args.octokit ?? null;
this.cwd = args.cwd;
}
async setupUser() {
if (this.octokit) {
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.octokit) {
return this.octokit.rest.git
.createRef({
...github.context.repo,
ref: `refs/tags/${tag}`,
sha: github.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 });
}
async prepareBranch(branch: string) {
if (this.octokit) {
// Preparing a new local branch is not necessary when using the API
return;
}
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(github.context.sha, { cwd: this.cwd });
}
async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.octokit) {
/**
* Only add files form the current working directory
*
* This will emulate the behavior of `git add .`,
* used in {@link commitAll}.
*/
const addFromDirectory = this.cwd;
return commitChangesFromRepo({
octokit: this.octokit,
...github.context.repo,
branch,
message,
base: {
commit: github.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 });
}
}
-66
View File
@@ -1,66 +0,0 @@
import { exec } from "@actions/exec";
import { execWithOutput } from "./utils";
export const setupUser = async () => {
await exec("git", [
"config",
"--global",
"user.name",
`"github-actions[bot]"`,
]);
await exec("git", [
"config",
"--global",
"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;
};
+60 -22
View File
@@ -1,8 +1,11 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import fs from "fs-extra"; import fs from "node:fs/promises";
import * as gitUtils from "./gitUtils"; import path from "node:path";
import { runPublish, runVersion } from "./run"; import { Git } from "./git.ts";
import readChangesetState from "./readChangesetState"; import { setupOctokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts";
import { runPublish, runVersion } from "./run.ts";
import { fileExists } from "./utils.ts";
const getOptionalInput = (name: string) => core.getInput(name) || undefined; const getOptionalInput = (name: string) => core.getInput(name) || undefined;
@@ -14,10 +17,27 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
return; return;
} }
console.log("setting git user"); const cwd = path.resolve(getOptionalInput("cwd") ?? "");
await gitUtils.setupUser();
console.log("setting GitHub credentials"); const octokit = setupOctokit(githubToken);
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
if (commitMode !== "git-cli" && commitMode !== "github-api") {
core.setFailed(`Invalid commit mode: ${commitMode}`);
return;
}
const git = new Git({
octokit: commitMode === "github-api" ? octokit : undefined,
cwd,
});
let setupGitUser = core.getBooleanInput("setupGitUser");
if (setupGitUser) {
core.info("setting git user");
await git.setupUser();
}
core.info("setting GitHub credentials");
await fs.writeFile( await fs.writeFile(
`${process.env.HOME}/.netrc`, `${process.env.HOME}/.netrc`,
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}` `machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
@@ -27,6 +47,9 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
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");
@@ -35,37 +58,39 @@ 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`; let userNpmrcPath = `${process.env.HOME}/.npmrc`;
if (fs.existsSync(userNpmrcPath)) { if (await fileExists(userNpmrcPath)) {
console.log("Found existing user .npmrc file"); core.info("Found existing user .npmrc file");
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8"); const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
const authLine = userNpmrcContent.split("\n").find((line) => { const authLine = userNpmrcContent.split("\n").find((line) => {
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105 // check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line); return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
}); });
if (authLine) { if (authLine) {
console.log( core.info(
"Found existing auth token for the npm registry in the user .npmrc file" "Found existing auth token for the npm registry in the user .npmrc file"
); );
} else { } else {
console.log( core.info(
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one" "Didn't find existing auth token for the npm registry in the user .npmrc file, creating one"
); );
fs.appendFileSync( await fs.appendFile(
userNpmrcPath, userNpmrcPath,
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n` `\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
); );
} }
} else { } else {
console.log("No user .npmrc file found, creating one"); core.info("No user .npmrc file found, creating one");
fs.writeFileSync( await fs.writeFile(
userNpmrcPath, userNpmrcPath,
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n` `//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
); );
@@ -73,7 +98,10 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
const result = await runPublish({ const result = await runPublish({
script: publishScript, script: publishScript,
githubToken, git,
octokit,
createGithubReleases: core.getBooleanInput("createGithubReleases"),
cwd,
}); });
if (result.published) { if (result.published) {
@@ -85,17 +113,27 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
} }
return; return;
} }
case hasChangesets: case hasChangesets && !hasNonEmptyChangesets:
await runVersion({ core.info("All changesets are empty; not creating PR");
return;
case hasChangesets: {
const octokit = setupOctokit(githubToken);
const { pullRequestNumber } = await runVersion({
script: getOptionalInput("version"), script: getOptionalInput("version"),
githubToken, git,
octokit,
prTitle: getOptionalInput("title"), prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit"), commitMessage: getOptionalInput("commit"),
hasPublishScript, hasPublishScript,
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>;
+8 -6
View File
@@ -1,4 +1,4 @@
import { PreState, NewChangeset } from "@changesets/types"; import type { 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";
@@ -11,17 +11,19 @@ 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,
}; };
} }
+160 -33
View File
@@ -1,12 +1,14 @@
import fixturez from "fixturez"; import type { Changeset } from "@changesets/types";
import * as github from "@actions/github";
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 fixturez from "fixturez";
import { runVersion } from "./run"; import fs from "node:fs/promises";
import path from "node:path";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import { runVersion } from "./run.ts";
jest.mock("@actions/github", () => ({ vi.mock("@actions/github", () => ({
context: { context: {
repo: { repo: {
owner: "changesets", owner: "changesets",
@@ -15,28 +17,28 @@ jest.mock("@actions/github", () => ({
ref: "refs/heads/some-branch", ref: "refs/heads/some-branch",
sha: "xeac7", sha: "xeac7",
}, },
getOctokit: jest.fn(), getOctokit: () => ({
rest: mockedGithubMethods,
}),
})); }));
jest.mock("./gitUtils"); vi.mock("./git.ts");
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 f = fixturez(__dirname); let f = fixturez(import.meta.dirname);
const linkNodeModules = async (cwd: string) => { const linkNodeModules = async (cwd: string) => {
await fs.symlink( await fs.symlink(
path.join(__dirname, "..", "node_modules"), path.join(import.meta.dirname, "..", "node_modules"),
path.join(cwd, "node_modules") path.join(cwd, "node_modules")
); );
}; };
@@ -45,17 +47,19 @@ const writeChangesets = (changesets: Changeset[], cwd: string) => {
}; };
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"); let cwd = f.copy("simple-project");
linkNodeModules(cwd); await linkNodeModules(cwd);
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
@@ -77,7 +81,8 @@ describe("version", () => {
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", octokit: setupOctokit("@@GITHUB_TOKEN"),
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -86,11 +91,13 @@ describe("version", () => {
it("only includes bumped packages in the PR body", async () => { it("only includes bumped packages in the PR body", async () => {
let cwd = f.copy("simple-project"); let cwd = f.copy("simple-project");
linkNodeModules(cwd); await linkNodeModules(cwd);
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
@@ -108,7 +115,8 @@ describe("version", () => {
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", octokit: setupOctokit("@@GITHUB_TOKEN"),
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -117,11 +125,13 @@ 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"); let cwd = f.copy("ignored-package");
linkNodeModules(cwd); await linkNodeModules(cwd);
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce( mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
() => ({ data: { items: [] } })
); mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets( await writeChangesets(
[ [
@@ -139,10 +149,127 @@ describe("version", () => {
); );
await runVersion({ await runVersion({
githubToken: "@@GITHUB_TOKEN", octokit: setupOctokit("@@GITHUB_TOKEN"),
git: new Git({ 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 () => {
let cwd = f.copy("simple-project");
await linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "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({
octokit: setupOctokit("@@GITHUB_TOKEN"),
git: new Git({ 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 () => {
let cwd = f.copy("simple-project");
await linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "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({
octokit: setupOctokit("@@GITHUB_TOKEN"),
git: new Git({ 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/
);
});
}); });
+235 -140
View File
@@ -1,57 +1,69 @@
import { exec } from "@actions/exec"; import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github"; import * as github from "@actions/github";
import fs from "fs-extra"; import type { PreState } from "@changesets/types";
import { getPackages, Package } from "@manypkg/get-packages"; import { type Package, getPackages } from "@manypkg/get-packages";
import path from "path"; import fs from "node:fs/promises";
import * as semver from "semver"; import { createRequire } from "node:module";
import path from "node:path";
import semverLt from "semver/functions/lt.js";
import { Git } from "./git.ts";
import type { Octokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts";
import { import {
getChangelogEntry,
execWithOutput,
getChangedPackages, getChangedPackages,
sortTheThings, getChangelogEntry,
getVersionsByDirectory, getVersionsByDirectory,
} from "./utils"; isErrorWithCode,
import * as gitUtils from "./gitUtils"; sortTheThings,
import readChangesetState from "./readChangesetState"; } from "./utils.ts";
import resolveFrom from "resolve-from";
const require = createRequire(import.meta.url);
// GitHub Issues/PRs messages have a max size limit on the
// message body payload.
// `body is too long (maximum is 65536 characters)`.
// To avoid that, we ensure to cap the message to 60k chars.
const MAX_CHARACTERS_PER_MESSAGE = 60000;
const createRelease = async ( 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("-"),
...github.context.repo,
});
}; };
type PublishOptions = { type PublishOptions = {
script: string; script: string;
githubToken: string; octokit: Octokit;
cwd?: string; createGithubReleases: boolean;
git: Git;
cwd: string;
}; };
type PublishedPackage = { name: string; version: string }; type PublishedPackage = { name: string; version: string };
@@ -67,20 +79,19 @@ type PublishResult =
export async function runPublish({ export async function runPublish({
script, script,
githubToken, git,
cwd = process.cwd(), octokit,
createGithubReleases,
cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
let octokit = github.getOctokit(githubToken);
let [publishCommand, ...publishArgs] = script.split(/\s+/); let [publishCommand, ...publishArgs] = script.split(/\s+/);
let changesetPublishOutput = await execWithOutput( let changesetPublishOutput = await getExecOutput(
publishCommand, publishCommand,
publishArgs, publishArgs,
{ cwd } { cwd }
); );
await gitUtils.pushTags();
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = []; let releasedPackages: Package[] = [];
@@ -104,14 +115,15 @@ export async function runPublish({
releasedPackages.push(pkg); releasedPackages.push(pkg);
} }
await Promise.all( if (createGithubReleases) {
releasedPackages.map((pkg) => await Promise.all(
createRelease(octokit, { releasedPackages.map(async (pkg) => {
pkg, const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
tagName: `${pkg.packageJson.name}@${pkg.packageJson.version}`, await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName });
}) })
) );
); }
} else { } else {
if (packages.length === 0) { if (packages.length === 0) {
throw new Error( throw new Error(
@@ -127,10 +139,11 @@ export async function runPublish({
if (match) { if (match) {
releasedPackages.push(pkg); releasedPackages.push(pkg);
await createRelease(octokit, { if (createGithubReleases) {
pkg, const tagName = `v${pkg.packageJson.version}`;
tagName: `v${pkg.packageJson.version}`, await git.pushTag(tagName);
}); await createRelease(octokit, { pkg, tagName });
}
break; break;
} }
} }
@@ -151,42 +164,121 @@ export async function runPublish({
const requireChangesetsCliPkgJson = (cwd: string) => { const requireChangesetsCliPkgJson = (cwd: string) => {
try { try {
return require(resolveFrom(cwd, "@changesets/cli/package.json")); return require(require.resolve("@changesets/cli/package.json", {
paths: [cwd],
}));
} catch (err) { } catch (err) {
if (err && err.code === "MODULE_NOT_FOUND") { if (isErrorWithCode(err, "MODULE_NOT_FOUND")) {
throw new Error( throw new Error(
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?` `Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`,
{ cause: err }
); );
} }
throw err; throw err;
} }
}; };
type GetMessageOptions = {
hasPublishScript: boolean;
branch: string;
changedPackagesInfo: {
highestLevel: number;
private: boolean;
content: string;
header: string;
}[];
prBodyMaxCharacters: number;
preState?: PreState;
};
export async function getVersionPrBody({
hasPublishScript,
preState,
changedPackagesInfo,
prBodyMaxCharacters,
branch,
}: 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
? `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.
`;
let messagePrestate = !!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}\`.
⚠️⚠️⚠️⚠️⚠️⚠️
`
: "";
let messageReleasesHeading = `# Releases`;
let fullMessage = [
messageHeader,
messagePrestate,
messageReleasesHeading,
...changedPackagesInfo.map((info) => `${info.header}\n\n${info.content}`),
].join("\n");
// Check that the message does not exceed the size limit.
// If not, omit the changelog entries of each package.
if (fullMessage.length > prBodyMaxCharacters) {
fullMessage = [
messageHeader,
messagePrestate,
messageReleasesHeading,
`\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");
}
// 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");
}
return fullMessage;
}
type VersionOptions = { type VersionOptions = {
script?: string; script?: string;
githubToken: string; git: Git;
octokit: Octokit;
cwd?: string; cwd?: string;
prTitle?: string; prTitle?: string;
commitMessage?: string; commitMessage?: string;
hasPublishScript?: boolean; hasPublishScript?: boolean;
prBodyMaxCharacters?: number;
branch?: string;
};
type RunVersionResult = {
pullRequestNumber: number;
}; };
export async function runVersion({ export async function runVersion({
script, script,
githubToken, git,
octokit,
cwd = process.cwd(), cwd = process.cwd(),
prTitle = "Version Packages", prTitle = "Version Packages",
commitMessage = "Version Packages", commitMessage = "Version Packages",
hasPublishScript = false, hasPublishScript = false,
}: VersionOptions) { prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
let repo = `${github.context.repo.owner}/${github.context.repo.repo}`; branch = github.context.ref.replace("refs/heads/", ""),
let branch = github.context.ref.replace("refs/heads/", ""); }: VersionOptions): Promise<RunVersionResult> {
let versionBranch = `changeset-release/${branch}`; let versionBranch = `changeset-release/${branch}`;
let octokit = github.getOctokit(githubToken);
let { preState } = await readChangesetState(cwd); let { preState } = await readChangesetState(cwd);
await gitUtils.switchToMaybeExistingBranch(versionBranch); await git.prepareBranch(versionBranch);
await gitUtils.reset(github.context.sha);
let versionsByDirectory = await getVersionsByDirectory(cwd); let versionsByDirectory = await getVersionsByDirectory(cwd);
@@ -195,99 +287,102 @@ export async function runVersion({
await exec(versionCommand, versionArgs, { cwd }); await exec(versionCommand, versionArgs, { cwd });
} else { } else {
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd); let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semver.lt(changesetsCliPkgJson.version, "2.0.0") let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0")
? "bump" ? "bump"
: "version"; : "version";
await exec("node", [resolveFrom(cwd, "@changesets/cli/bin.js"), cmd], { await exec(
cwd, "node",
}); [
require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
}),
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 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 prBodyPromise = (async () => { let entry = getChangelogEntry(changelogContents, pkg.packageJson.version);
return ( 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 ${ highestLevel: entry.highestLevel,
hasPublishScript private: !!pkg.packageJson.private,
? `the packages will be published to npm automatically` content: entry.content,
: `publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing)` header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`,
}. 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}\`.
⚠️⚠️⚠️⚠️⚠️⚠️
`
: ""
}
# Releases
` +
(
await 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:
`## ${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})` : ""}`; const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
const finalCommitMessage = `${commitMessage}${
!!preState ? ` (${preState.tag})` : ""
}`;
// project with `commit: true` setting could have already committed files /**
if (!(await gitUtils.checkIfClean())) { * Fetch any existing pull requests that are open against the branch,
const finalCommitMessage = `${commitMessage}${ * before we push any changes that may inadvertently close the existing PRs.
!!preState ? ` (${preState.tag})` : "" *
}`; * (`@changesets/ghcommit` has to reset the branch to the same commit as the base,
await gitUtils.commitAll(finalCommitMessage); * which GitHub will then react to by closing the PRs)
} */
const existingPullRequests = await octokit.rest.pulls.list({
...github.context.repo,
state: "open",
head: `${github.context.repo.owner}:${versionBranch}`,
base: branch,
});
core.info(`Existing pull requests: ${JSON.stringify(existingPullRequests.data, null, 2)}`);
await gitUtils.push(versionBranch, { force: true }); await git.pushChanges({ branch: versionBranch, message: finalCommitMessage });
let searchResult = await searchResultPromise; const changedPackagesInfo = (await changedPackagesInfoPromises)
console.log(JSON.stringify(searchResult.data, null, 2)); .filter((x) => x)
if (searchResult.data.items.length === 0) { .sort(sortTheThings);
console.log("creating pull request");
await octokit.pulls.create({ 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, ...github.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}`);
await octokit.rest.pulls.update({
pull_number: pullRequest.number,
title: finalPrTitle, title: finalPrTitle,
body: await prBodyPromise, body: prBody,
...github.context.repo, ...github.context.repo,
state: "open",
}); });
console.log("pull request found");
return {
pullRequestNumber: pullRequest.number,
};
} }
} }
+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
+22 -34
View File
@@ -1,10 +1,11 @@
import unified from "unified"; import unified from "unified";
import remarkParse from "remark-parse"; import remarkParse from "remark-parse";
import remarkStringify from "remark-stringify"; import remarkStringify from "remark-stringify";
import fs from "node:fs/promises";
import type { Root } from "mdast";
// @ts-ignore // @ts-ignore
import mdastToString from "mdast-util-to-string"; import mdastToString from "mdast-util-to-string";
import { exec } from "@actions/exec"; import { getPackages, type Package } from "@manypkg/get-packages";
import { getPackages, Package } from "@manypkg/get-packages";
export const BumpLevels = { export const BumpLevels = {
dep: 0, dep: 0,
@@ -36,11 +37,11 @@ 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 ast = unified().use(remarkParse).parse(changelog) as Root;
let highestLevel: number = BumpLevels.dep; let highestLevel: number = BumpLevels.dep;
let nodes = ast.children as Array<any>; let nodes = ast.children;
let headingStartInfo: let headingStartInfo:
| { | {
index: number; index: number;
@@ -76,10 +77,7 @@ export function getChangelogEntry(changelog: string, version: string) {
} }
} }
if (headingStartInfo) { if (headingStartInfo) {
ast.children = (ast.children as any).slice( ast.children = ast.children.slice(headingStartInfo.index + 1, endIndex);
headingStartInfo.index + 1,
endIndex
);
} }
return { return {
content: unified().use(remarkStringify).stringify(ast), content: unified().use(remarkStringify).stringify(ast),
@@ -87,32 +85,6 @@ export function getChangelogEntry(changelog: string, version: string) {
}; };
} }
export async function execWithOutput(
command: string,
args?: string[],
options?: { ignoreReturnCode?: boolean; cwd?: string }
) {
let myOutput = "";
let myError = "";
return {
code: await exec(command, args, {
listeners: {
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 }
@@ -125,3 +97,19 @@ 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
);
}
+10 -59
View File
@@ -1,63 +1,14 @@
{ {
"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'. */, "isolatedModules": true,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, "module": "node18",
// "lib": [], /* Specify library files to be included in the compilation. */ "moduleResolution": "node16",
// "allowJs": true, /* Allow javascript files to be compiled. */ "noEmit": true,
// "checkJs": true, /* Report errors in .js files. */ "resolveJsonModule": true,
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ "strict": true,
// "declaration": true, /* Generates corresponding '.d.ts' file. */ "target": "esnext",
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ "verbatimModuleSyntax": true
// "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. */
} }
} }
+1621 -8242
View File
File diff suppressed because it is too large Load Diff