Compare commits

...
22 Commits
Author SHA1 Message Date
github-actions[bot] a45c4d594a v1.9.0 2026-06-03 07:05:44 +00:00
github-actions[bot] b459b1eaa0 Version Packages (#637)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-03 07:02:05 +00:00
Mateusz Burzyński f9585d966a Update @changesets/ghcommit (#645)
* Update `@changesets/ghcommit`

* add changeset

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

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

* Update rolldown config

* Add changeset

* Update readme

* Use TLA

* Add prefix

* fix merge

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

* Fix

* fix

* fix

* Make it look nicer

* Update docs

* Rename to pr-status-comment

* Remove outputs

* Update path

* update name

* Checkout PR in a detached worktree (#626)

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

* Move comment to separate job

* Loosen event requirement

* Update

* Apply suggestions from code review

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

* Use TLA

* use using

* Remove test log

---------

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

* Format

---------

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

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

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

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

* update vite

---------

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

* Enable import sorting

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

* fix issues

* fix one thing

* add permission comments

* add job names

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

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

* add pnpm `dedupe` options

* update release-pr workflow

* update

* update snashots

* tweaks

* tweak

* tweak

* fix missing ci-setup

* tweak

* tweak deps

* update pnpm

* ok, Socket, let's rename them

* update snapshots

* rename again

* fmt

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-14 09:04:38 +00:00
Mateusz Burzyński ccba80bb5a Fix the ability to create GitHub releases in our own workflow (#614) 2026-05-07 10:05:44 +00:00
54 changed files with 3990 additions and 3490 deletions
+5 -5
View File
@@ -1,5 +1,5 @@
/.github/workflows/** @Andarist @emmatown /.github/workflows/** @Andarist @bluwy @emmatown
/action.yml @Andarist @emmatown /action.yml @Andarist @bluwy @emmatown
/scripts/bump.ts @Andarist @emmatown /scripts/bump.ts @Andarist @bluwy @emmatown
/scripts/release.ts @Andarist @emmatown /scripts/release.ts @Andarist @bluwy @emmatown
/scripts/release-pr.ts @Andarist @emmatown /scripts/release-pr.ts @Andarist @bluwy @emmatown
+14 -4
View File
@@ -1,14 +1,24 @@
name: Setup CI name: Setup CI
description: Setup CI
inputs:
skip-cache:
description: "Whether to skip the cache"
required: false
default: "false"
runs: runs:
using: composite using: composite
steps: steps:
- name: Setup Node.js - name: Set up pnpm
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0 uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with: with:
node-version-file: ".node-version" node-version-file: ".node-version"
cache: yarn package-manager-cache: ${{ inputs.skip-cache != 'true' }}
cache: ${{ inputs.skip-cache != 'true' && 'pnpm' || '' }}
- name: Install dependencies - name: Install dependencies
shell: bash shell: bash
run: yarn install --frozen-lockfile run: pnpm install --frozen-lockfile
+2
View File
@@ -9,3 +9,5 @@ updates:
directory: "/" # Location of package manifests directory: "/" # Location of package manifests
schedule: schedule:
interval: "weekly" interval: "weekly"
cooldown:
default-days: 7
+57 -9
View File
@@ -2,26 +2,54 @@ name: CI
on: on:
pull_request: pull_request:
push: # merge queue is required so all commits on target branches trigger this workflow
branches: [main] # despite lack of the push event trigger here
merge_group: merge_group:
branches: [main] branches:
- main
permissions: permissions:
contents: read contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.sha }}
cancel-in-progress: true
jobs: jobs:
lint-workflows:
name: Lint workflows
runs-on: ubuntu-latest
permissions:
actions: read # only required in private repos
security-events: write # allow writing security events
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Run zizmor
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
with:
persona: pedantic
annotations: true
advanced-security: false
test: test:
name: Test name: Test
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
- name: Test - name: Test
run: yarn test run: pnpm test
typecheck: typecheck:
name: Typecheck name: Typecheck
@@ -29,18 +57,38 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
- name: Typecheck - name: Typecheck
run: yarn typecheck run: pnpm typecheck
lint:
name: Lint
timeout-minutes: 20
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Format
run: pnpm format
ci-ok: ci-ok:
name: CI OK name: CI OK
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: always() if: always()
needs: [test, typecheck] needs: [lint-workflows, test, typecheck, lint]
steps: steps:
- name: Exit with error if some jobs are not successful - name: Exit with error if some jobs are not successful
run: exit 1 run: exit 1
if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'skipped') || contains(needs.*.result, 'cancelled')) }} if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
+31 -7
View File
@@ -5,7 +5,10 @@ on:
branches: branches:
- main - main
concurrency: ${{ github.workflow }}-${{ github.ref }} concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
queue: max
permissions: {} # each job should define its own permission explicitly permissions: {} # each job should define its own permission explicitly
@@ -13,6 +16,7 @@ jobs:
version: version:
name: Version name: Version
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment: version
timeout-minutes: 20 timeout-minutes: 20
outputs: outputs:
hasChangesets: ${{ steps.changesets.outputs.hasChangesets }} hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
@@ -21,17 +25,30 @@ jobs:
issues: write # to post issue comments (changesets/action) issues: write # to post issue comments (changesets/action)
pull-requests: write # to create pull request (changesets/action) pull-requests: write # to create pull request (changesets/action)
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build - name: Build
run: yarn build run: pnpm build
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Create or update release pull request - name: Create or update release pull request
id: changesets id: changesets
uses: ./ uses: ./
with: with:
version: yarn bump github-token: ${{ steps.app-token.outputs.token }}
version: pnpm bump
publish: publish:
name: Publish name: Publish
@@ -40,6 +57,8 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment: marketplace environment: marketplace
timeout-minutes: 20 timeout-minutes: 20
permissions:
contents: write # to create release and have it authored by github-actions (changesets/action)
steps: steps:
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1 - uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token id: app-token
@@ -47,16 +66,21 @@ jobs:
client-id: ${{ vars.APP_CLIENT_ID }} client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }} private-key: ${{ secrets.APP_PRIVATE_KEY }}
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: with:
persist-credentials: true
# we need this token to bypass the branch and tag protection rules
token: ${{ steps.app-token.outputs.token }} token: ${{ steps.app-token.outputs.token }}
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build - name: Build
run: yarn build run: pnpm build
- name: Publish to marketplace - name: Publish to marketplace
uses: ./ uses: ./
with: with:
publish: yarn release publish: pnpm release
+94 -35
View File
@@ -4,22 +4,33 @@ on:
issue_comment: issue_comment:
types: [created] types: [created]
concurrency:
group: ${{ github.workflow }}-${{ github.run_id }}
cancel-in-progress: true
permissions: {} permissions: {}
jobs: jobs:
release_check: release_check:
name: Validate release request
if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr') if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr')
timeout-minutes: 5
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: read contents: read # to inspect the pull request commit state (changesets/action)
issues: write issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: read pull-requests: read # to inspect the pull request head state (changesets/action)
steps: steps:
- id: report_in_progress - id: report_in_progress
run: | 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" in_progress_reaction_id=$(gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='eyes' --jq '.id')
echo "in_progress_reaction_id=$in_progress_reaction_id" >> "$GITHUB_OUTPUT"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- id: parse_command - id: parse_command
run: | run: |
@@ -35,7 +46,7 @@ jobs:
- id: check_authorization - id: check_authorization
run: | run: |
if [[ $AUTHOR_ASSOCIATION == 'MEMBER' || $AUTHOR_ASSOCIATION == 'OWNER' || $AUTHOR_ASSOCIATION == 'COLLABORATOR' ]] if [[ "$AUTHOR_ASSOCIATION" == 'MEMBER' || "$AUTHOR_ASSOCIATION" == 'OWNER' || "$AUTHOR_ASSOCIATION" == 'COLLABORATOR' ]]
then then
echo "User is authorized to release" echo "User is authorized to release"
else else
@@ -50,7 +61,7 @@ jobs:
requested_sha=$(echo "$REQUESTED_SHA" | tr '[:upper:]' '[:lower:]') requested_sha=$(echo "$REQUESTED_SHA" | tr '[:upper:]' '[:lower:]')
mapfile -t matches < <( mapfile -t matches < <(
gh api /repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}/commits --paginate --jq '.[].sha' | gh api "/repos/$GH_REPO/pulls/$ISSUE_NUMBER/commits" --paginate --jq '.[].sha' |
awk -v sha="$requested_sha" 'index(tolower($0), sha) == 1 { print $0 }' awk -v sha="$requested_sha" 'index(tolower($0), sha) == 1 { print $0 }'
) )
@@ -67,7 +78,7 @@ jobs:
fi fi
resolved_sha="${matches[0]}" resolved_sha="${matches[0]}"
pr_head_sha=$(gh pr view ${{ github.event.issue.number }} --json headRefOid --jq '.headRefOid') pr_head_sha=$(gh pr view "$ISSUE_NUMBER" --json headRefOid --jq '.headRefOid')
if [[ "$resolved_sha" != "$pr_head_sha" ]] if [[ "$resolved_sha" != "$pr_head_sha" ]]
then then
@@ -79,13 +90,17 @@ jobs:
echo "pr_head_sha=$pr_head_sha" >> "$GITHUB_OUTPUT" echo "pr_head_sha=$pr_head_sha" >> "$GITHUB_OUTPUT"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
REQUESTED_SHA: ${{ steps.parse_command.outputs.requested_sha }} REQUESTED_SHA: ${{ steps.parse_command.outputs.requested_sha }}
- id: get_pr_head_repository - id: get_pr_head_repository
run: | run: |
echo "head_repository=$(gh pr view ${{ github.event.issue.number }} --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')" >> "$GITHUB_OUTPUT" head_repository=$(gh pr view "$ISSUE_NUMBER" --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')
echo "head_repository=$head_repository" >> "$GITHUB_OUTPUT"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
outputs: outputs:
in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }} in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }}
@@ -95,48 +110,61 @@ jobs:
head_repository: ${{ steps.get_pr_head_repository.outputs.head_repository }} head_repository: ${{ steps.get_pr_head_repository.outputs.head_repository }}
release: release:
name: Release snapshot
if: github.repository == 'changesets/action' if: github.repository == 'changesets/action'
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: release_check needs: release_check
permissions: permissions:
contents: write contents: write # to create the release commit and publish snapshot artifacts (changesets/action)
issues: write issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write pull-requests: write # to comment on the pull request with the release result (changesets/action)
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Fetch validated commit from pull request head repository - name: Fetch validated commit from pull request head repository
run: | run: |
git remote add pr-head https://github.com/$HEAD_REPOSITORY.git git remote add pr-head "https://github.com/$HEAD_REPOSITORY.git"
git fetch --no-tags pr-head $RESOLVED_SHA git fetch --no-tags pr-head "$RESOLVED_SHA"
env: env:
HEAD_REPOSITORY: ${{ needs.release_check.outputs.head_repository }} HEAD_REPOSITORY: ${{ needs.release_check.outputs.head_repository }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }} RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Checkout validated commit - name: Checkout validated commit
run: git checkout --detach $RESOLVED_SHA run: git checkout --detach "$RESOLVED_SHA"
env: env:
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }} RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Check if Version Packages PR - name: Check if Version Packages PR
id: check_version_packages id: check_version_packages
run: | run: |
echo "version_packages=$(gh pr view ${{ github.event.issue.number }} --json headRefName --jq '.headRefName|startswith("changeset-release/")')" >> "$GITHUB_OUTPUT" version_packages=$(gh pr view "$ISSUE_NUMBER" --json headRefName --jq '.headRefName|startswith("changeset-release/")')
echo "version_packages=$version_packages" >> "$GITHUB_OUTPUT"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Reset Version Packages PR - name: Reset Version Packages PR
if: steps.check_version_packages.outputs.version_packages == 'true' if: steps.check_version_packages.outputs.version_packages == 'true'
run: git reset --hard HEAD~1 run: git reset --hard HEAD~1
- run: yarn changeset version --snapshot pr${{ github.event.issue.number }} - name: Create snapshot version
run: pnpm changeset version --snapshot "pr$ISSUE_NUMBER"
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Build - name: Build
run: yarn build run: pnpm build
- name: Setup Git user - name: Setup Git user
run: | run: |
@@ -144,40 +172,71 @@ jobs:
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Release snapshot version - name: Release snapshot version
run: yarn run release:pr run: pnpm release:pr
- run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='rocket' - name: Add success reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='rocket'
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- run: gh api -X DELETE /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions/${{ needs.release_check.outputs.in_progress_reaction_id }} - name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- run: | - name: Comment success
gh pr comment ${{ github.event.issue.number }} --body "The release for \`${{ needs.release_check.outputs.resolved_sha }}\` triggered by [this comment](${{ github.event.comment.url }}) has [succeeded](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}). Published commit: [${{ github.repository }}@$(git rev-parse HEAD)](https://github.com/${{ github.repository }}/commit/$(git rev-parse HEAD))." run: |
published_commit="$(git rev-parse HEAD)"
body="The release for \`$RESOLVED_SHA\` triggered by [this comment]($COMMENT_URL) has [succeeded]($RUN_URL). Published commit: [$GH_REPO@$published_commit](https://github.com/$GH_REPO/commit/$published_commit)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
report-failure-if-needed: report-failure-if-needed:
name: Report failure
needs: [release_check, release] needs: [release_check, release]
timeout-minutes: 2 timeout-minutes: 2
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure') if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure')
permissions: permissions:
issues: write issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write pull-requests: write # to comment on the pull request with the failure result (changesets/action)
steps: steps:
- run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='-1' - name: Add failure reaction
env: run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='-1'
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 for \`${{ needs.release_check.outputs.requested_sha }}\` triggered by [this comment](${{ github.event.comment.url }}) has [failed](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})."
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }} GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- name: Comment failure
run: |
body="The release for \`$REQUESTED_SHA\` triggered by [this comment]($COMMENT_URL) has [failed]($RUN_URL)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
REQUESTED_SHA: ${{ needs.release_check.outputs.requested_sha }}
+7
View File
@@ -0,0 +1,7 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"printWidth": 80,
"sortImports": {
"newlinesBetween": false
}
}
+1 -1
View File
@@ -1,5 +1,4 @@
{ {
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
@@ -7,6 +6,7 @@
"request": "launch", "request": "launch",
"name": "Debug Current Test File", "name": "Debug Current Test File",
"autoAttachChildProcesses": true, "autoAttachChildProcesses": true,
"skipFiles": [],
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs", "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
"args": ["run", "${relativeFile}"], "args": ["run", "${relativeFile}"],
"smartStep": true, "smartStep": true,
+2 -1
View File
@@ -1,3 +1,4 @@
{ {
"typescript.tsdk": "node_modules/typescript/lib" "js/ts.tsdk.path": "node_modules/typescript/lib",
"editor.defaultFormatter": "oxc.oxc-vscode"
} }
+18
View File
@@ -1,5 +1,23 @@
# @changesets/action # @changesets/action
## 1.9.0
### Minor Changes
- [#636](https://github.com/changesets/action/pull/636) [`b072bcc`](https://github.com/changesets/action/commit/b072bccc4c664a373c42168eed9139dce1e003b1) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-comment` sub-action to comment on PRs
- [#625](https://github.com/changesets/action/pull/625) [`8795eee`](https://github.com/changesets/action/commit/8795eee5eee884e887d352ac673a515ffe35aaa6) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-status` sub-action to generate the changeset status comment for PRs as an alternative to the [Changesets Bot](https://github.com/apps/changeset-bot).
### Patch Changes
- [#535](https://github.com/changesets/action/pull/535) [`34f64f6`](https://github.com/changesets/action/commit/34f64f6e2e1e47ddc183f174aa27c197aa47f520) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with GitHub releases not being created for successfully published packages when _some_ packages failed to be published to the registry.
- [#632](https://github.com/changesets/action/pull/632) [`1d54b9e`](https://github.com/changesets/action/commit/1d54b9e660e435237accbcae0b4581af3be641b4) Thanks [@bluwy](https://github.com/bluwy)! - Simplify internal implementation to get changelog entries for a package version
- [#629](https://github.com/changesets/action/pull/629) [`e0c90aa`](https://github.com/changesets/action/commit/e0c90aa7fbd0cc26931a679c5abe9bbc0deb0b50) Thanks [@bluwy](https://github.com/bluwy)! - Fix custom version and publish command argument parsing
- [#645](https://github.com/changesets/action/pull/645) [`f9585d9`](https://github.com/changesets/action/commit/f9585d966a9c7d2f668b97199990de6f885823cf) Thanks [@Andarist](https://github.com/Andarist)! - Improved force-push handling when using `commitMode: "github-api"` so updating an existing branch no longer temporarily resets the target branch to the base commit, avoiding cases where GitHub closes open pull requests during the update. This should remove a possibility of a GitHub state race that caused the force-pushed PRs not being reopened.
## 1.8.0 ## 1.8.0
### Minor Changes ### Minor Changes
+43 -26
View File
@@ -2,6 +2,11 @@
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you. This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details:
- [pr-status](./pr-status/README.md): Generate changeset status in PRs.
- [pr-comment](./pr-comment/README.md): Comment on PRs.
## Usage ## Usage
### Inputs ### Inputs
@@ -21,7 +26,7 @@ This action for [Changesets](https://github.com/changesets/changesets) creates a
- published - A boolean value to indicate whether a publishing has happened or not - published - A boolean value to indicate whether a publishing has happened or not
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` - publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
### Example workflow: ### Example workflow
#### Without Publishing #### Without Publishing
@@ -43,15 +48,18 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v3 uses: actions/checkout@v6
- name: Setup Node.js 20 - name: Setup pnpm
uses: actions/setup-node@v3 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 20 node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@v1
@@ -77,22 +85,25 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v3 uses: actions/checkout@v6
- name: Setup Node.js 20.x - name: Setup pnpm
uses: actions/setup-node@v3 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 20.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request or Publish to npm - name: Create Release Pull Request or Publish to npm
id: changesets id: changesets
uses: changesets/action@v1 uses: changesets/action@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: pnpm release
env: env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -104,7 +115,7 @@ jobs:
By default the GitHub Action creates a `.npmrc` file with the following content: By default the GitHub Action creates a `.npmrc` file with the following content:
``` ```txt
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN} //registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
``` ```
@@ -141,15 +152,18 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v3 uses: actions/checkout@v6
- name: Setup Node.js 20.x - name: Setup pnpm
uses: actions/setup-node@v3 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 20.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request or Publish to npm - name: Create Release Pull Request or Publish to npm
id: changesets id: changesets
@@ -158,7 +172,7 @@ jobs:
- name: Publish - name: Publish
if: steps.changesets.outputs.hasChangesets == 'false' if: steps.changesets.outputs.hasChangesets == 'false'
# You can do something when a publish should happen. # You can do something when a publish should happen.
run: yarn publish run: pnpm publish
``` ```
#### With version script #### With version script
@@ -183,21 +197,24 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v3 uses: actions/checkout@v6
- name: Setup Node.js 20.x - name: Setup pnpm
uses: actions/setup-node@v3 uses: pnpm/action-setup@v6
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 20.x node-version: 26
- name: Install Dependencies - name: Install Dependencies
run: yarn run: pnpm install --frozen-lockfile
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@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: pnpm version
``` ```
#### With Yarn 2 / Plug'n'Play #### With Yarn 2 / Plug'n'Play
@@ -208,5 +225,5 @@ If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you shoul
- uses: changesets/action@v1 - uses: changesets/action@v1
with: with:
version: yarn changeset version version: yarn changeset version
... # ...
``` ```
@@ -1,4 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json",
"ignore": ["ignored-package-pkg-a"]
}
@@ -1,8 +0,0 @@
{
"private": true,
"name": "ignored-package",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -1,7 +0,0 @@
{
"name": "ignored-package-pkg-a",
"version": "1.0.0",
"dependencies": {
"ignored-package-pkg-b": "1.0.0"
}
}
@@ -1,4 +0,0 @@
{
"name": "ignored-package-pkg-b",
"version": "1.0.0"
}
@@ -1,3 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json"
}
-8
View File
@@ -1,8 +0,0 @@
{
"private": true,
"name": "simple-project",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -1,7 +0,0 @@
{
"name": "simple-project-pkg-a",
"version": "1.0.0",
"dependencies": {
"simple-project-pkg-b": "1.0.0"
}
}
@@ -1,4 +0,0 @@
{
"name": "simple-project-pkg-b",
"version": "1.0.0"
}
+18
View File
File diff suppressed because one or more lines are too long
+150
View File
File diff suppressed because one or more lines are too long
+96
View File
File diff suppressed because one or more lines are too long
+1
View File
@@ -0,0 +1 @@
import{a as e,c as t,n,o as r,s as i,t as a}from"./github-DTObde6f.js";try{await o()}catch(e){i(e.message)}async function o(){let i=a.payload.pull_request;if(!i)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let o=e(`github-token`,{required:!0}),c=e(`body`,{required:!0}),l=e(`update-id`),u=l?s(l):null,d=u?`${u}\n\n${c}`:c,f={repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number,body:d},p=n(o),m;u&&(r(`Checking for existing comment...`),m=await p.rest.issues.listComments({repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number}).then(e=>e.data.find(e=>e.body?.includes(u))?.id)),m?(r(`Updating existing comment (id: ${m})...`),await p.rest.issues.updateComment({...f,comment_id:m}),t(`comment-id`,m)):(r(`Creating new comment...`),t(`comment-id`,(await p.rest.issues.createComment(f)).data.id)),r(`Done!`)}function s(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
+39
View File
File diff suppressed because one or more lines are too long
+36 -47
View File
@@ -1,65 +1,54 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "1.8.0", "version": "1.9.0",
"main": "dist/index.js",
"type": "module",
"license": "MIT", "license": "MIT",
"devDependencies": { "type": "module",
"@changesets/changelog-github": "^0.5.1", "main": "dist/index.js",
"@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",
"husky": "^3.0.3",
"prettier": "^2.0.5",
"rollup": "^4.40.2",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
},
"scripts": { "scripts": {
"build": "rollup -c", "build": "rolldown -c",
"test": "vitest", "test": "vitest",
"test:watch": "yarn test --watch", "test:watch": "pnpm test --watch",
"typecheck": "tsc", "typecheck": "tsc",
"format": "oxfmt --check",
"format:fix": "oxfmt",
"changeset": "changeset", "changeset": "changeset",
"bump": "node --experimental-strip-types ./scripts/bump.ts", "bump": "node --experimental-strip-types ./scripts/bump.ts",
"release": "node --experimental-strip-types ./scripts/release.ts", "release": "node --experimental-strip-types ./scripts/release.ts",
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts" "release:pr": "node --experimental-strip-types ./scripts/release-pr.ts"
}, },
"engines": {
"node": ">= 24"
},
"dependencies": { "dependencies": {
"@actions/core": "^1.11.1", "@actions/core": "^3.0.1",
"@actions/exec": "^1.1.1", "@actions/exec": "^3.0.0",
"@actions/github": "^6.0.1", "@actions/github": "^9.1.1",
"@changesets/ghcommit": "^2.0.1", "@changesets/get-release-plan": "^4.0.16",
"@changesets/ghcommit": "^2.1.1",
"@changesets/git": "^3.0.4",
"@changesets/pre": "^2.0.2", "@changesets/pre": "^2.0.2",
"@changesets/read": "^0.6.5", "@changesets/read": "^0.6.7",
"@manypkg/get-packages": "^1.1.3", "@manypkg/get-packages": "^1.1.3",
"@octokit/core": "^5.2.1", "@octokit/core": "^7.0.6",
"@octokit/plugin-throttling": "^8.0.0", "@octokit/plugin-throttling": "^11.0.3",
"@types/mdast": "^3.0.0", "human-id": "^4.1.3",
"mdast-util-to-string": "^1.0.6", "markdown-table": "^3.0.4",
"remark-parse": "^7.0.1", "semver": "^7.8.0",
"remark-stringify": "^7.0.3", "tinyexec": "^1.1.2"
"semver": "^7.5.3",
"unified": "^8.3.2"
}, },
"husky": { "devDependencies": {
"hooks": {} "@changesets/changelog-github": "^0.7.0",
"@changesets/cli": "^2.31.0",
"@changesets/types": "^6.1.0",
"@changesets/write": "^0.4.0",
"@tsconfig/node24": "^24.0.4",
"@types/node": "^24.12.4",
"@types/semver": "^7.7.1",
"fs-fixture": "^2.13.0",
"oxfmt": "^0.48.0",
"rolldown": "^1.0.1",
"typescript": "^6.0.3",
"vitest": "^4.1.6"
}, },
"prettier": {}, "engines": {
"resolutions": { "node": ">=24"
"trim": "^0.0.3",
"y18n": "^4.0.1"
}, },
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" "packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a"
} }
+2405
View File
File diff suppressed because it is too large Load Diff
+13
View File
@@ -0,0 +1,13 @@
blockExoticSubdeps: true
dedupePeers: true
dedupePeerDependents: true
minimumReleaseAge: 10080
minimumReleaseAgeExclude:
- "@changesets/ghcommit@2.1.1"
overrides:
lightningcss: "-" # we do not bundle any css
postcss: "-" # we do not bundle any css
shellEmulator: true
trustPolicy: no-downgrade
+52
View File
@@ -0,0 +1,52 @@
# @changesets/action/pr-comment
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md).
This action is intentionally simple without advanced features. Check out other actions if so, such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
See the [action metadata](action.yml) for details on the inputs and outputs.
## Example setup
```yaml
name: PR Comment
on:
pull_request:
jobs:
pr-comment:
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
```
When called repeatedly, the action will update the comment it created by default. If you use this action to create different types of comments, pass an `update-id` value to differentiate them.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: my-tag
```
If you want to always create new comments, pass an empty value to `update-id`.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: ""
```
+25
View File
@@ -0,0 +1,25 @@
name: Changesets - PR Comment
description: A simple GitHub Action to comment on PRs
runs:
using: node24
main: ../dist/pr-comment.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
body:
description: "The comment body to post on the PR."
required: true
update-id:
description: >
By default, the action will create and update a comment with this id. Pass a different id to
create and update a new comment, or pass an empty string to disable updating comments.
required: false
default: "changesets-action-pr-comment"
outputs:
comment-id:
description: "The comment id of the comment that was created or updated."
branding:
icon: message-circle
color: blue
+61
View File
@@ -0,0 +1,61 @@
# changesets/action/pr-status
This action generates the changesets status in PRs, e.g. whether it has changeset files and which packages will be released if the PR is merged.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages. It also requires the [`pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) event to be triggered in order to have permissions to comment on the PR and to work in PRs from forks.
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs:
```yaml
jobs:
pr-status:
if: github.event.pull_request.head.repo.full_name == github.repository
# ...
```
See the [action metadata](action.yml) for details on the inputs and outputs.
> [!WARNING]
> **Do not run untrusted code** when using the `pull_request_target` event. The example below only checks out code and does not run any code from the PR. Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
## Example setup
```yaml
# .github/workflows/comment-changesets-pr-status.yml
name: Comment Changesets status in PRs
on:
pull_request_target:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
pr-status:
runs-on: ubuntu-slim
permissions:
contents: read # to check out files in the repo
outputs:
comment-body: ${{ steps.pr-status.outputs.comment-body }}
steps:
- name: Check out repo
uses: actions/checkout@v6
- name: Generate status
id: pr-status
uses: changesets/action/pr-status@v1
pr-comment:
needs: pr-status
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
steps:
- name: Comment on PR
uses: changesets/action/pr-comment@v1
with:
body: ${{ needs.pr-status.outputs.comment-body }}
```
The workflow uses [`@changesets/action/pr-comment`](../pr-comment/README.md), which is a simple GitHub Action to comment on PRs.
+12
View File
@@ -0,0 +1,12 @@
name: Changesets - PR Status
description: Generate the changesets status in PRs
runs:
using: node24
main: ../dist/pr-status.js
inputs: {}
outputs:
comment-body:
description: The generated comment body to present the changesets status in PRs.
branding:
icon: package
color: blue
+17
View File
@@ -0,0 +1,17 @@
import { defineConfig } from "rolldown";
export default defineConfig({
input: {
index: "src/index.ts",
["pr-status"]: "src/pr-status/index.ts",
["pr-comment"]: "src/pr-comment/index.ts",
},
output: {
dir: "dist",
format: "esm",
cleanDir: true,
minify: true,
comments: false,
},
platform: "node",
});
-38
View File
@@ -1,38 +0,0 @@
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(),
],
});
+2 -2
View File
@@ -1,6 +1,6 @@
import { exec } from "@actions/exec";
import fs from "node:fs"; import fs from "node:fs";
import path from "node:path"; import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" }; import pkgJson from "../package.json" with { type: "json" };
process.chdir(path.join(import.meta.dirname, "..")); process.chdir(path.join(import.meta.dirname, ".."));
@@ -13,6 +13,6 @@ const readmePath = path.join(import.meta.dirname, "..", "README.md");
const content = fs.readFileSync(readmePath, "utf8"); const content = fs.readFileSync(readmePath, "utf8");
const updatedContent = content.replace( const updatedContent = content.replace(
/changesets\/action@[^\s]+/g, /changesets\/action@[^\s]+/g,
`changesets/action@${releaseLine}` `changesets/action@${releaseLine}`,
); );
fs.writeFileSync(readmePath, updatedContent); fs.writeFileSync(readmePath, updatedContent);
+1 -2
View File
@@ -1,6 +1,5 @@
import { exec } from "@actions/exec";
import path from "node:path"; import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" }; import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`; const tag = `v${pkgJson.version}`;
+3 -4
View File
@@ -1,6 +1,5 @@
import { exec, getExecOutput } from "@actions/exec";
import path from "node:path"; import path from "node:path";
import { exec, getExecOutput } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" }; import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`; const tag = `v${pkgJson.version}`;
@@ -14,11 +13,11 @@ process.chdir(path.join(import.meta.dirname, ".."));
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`], ["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
{ {
ignoreReturnCode: true, ignoreReturnCode: true,
} },
); );
if (exitCode === 0) { if (exitCode === 0) {
console.log( console.log(
`Action is not being published because version ${tag} is already published` `Action is not being published because version ${tag} is already published`,
); );
return; return;
} }
+17 -24
View File
@@ -8,12 +8,11 @@ exports[`version > creates a draft PR when prDraft is "create" 1`] = `
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"draft": true, "draft": true,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
@@ -31,23 +30,21 @@ exports[`version > creates simple PR 1`] = `
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature
### Patch Changes ### Patch Changes
- Updated dependencies - Updated dependencies
- simple-project-pkg-b@1.1.0 - changesets-dev-simple-project-pkg-b@1.1.0
## changesets-dev-simple-project-pkg-b@1.1.0
## simple-project-pkg-b@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"draft": false, "draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
@@ -87,7 +84,7 @@ exports[`version > does not include changelog entries if full message exceeds si
> The changelog information of each package has been omitted from this message, as the content exceeds the size limit. > 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 ## changesets-dev-simple-project-pkg-a@1.1.0
", ",
"draft": false, "draft": false,
@@ -107,12 +104,11 @@ exports[`version > doesn't include ignored package that got a dependency update
# Releases # Releases
## ignored-package-pkg-b@1.1.0 ## changesets-dev-ignored-package-pkg-b@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"draft": false, "draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
@@ -130,12 +126,11 @@ exports[`version > only includes bumped packages in the PR body 1`] = `
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"draft": false, "draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
@@ -183,12 +178,11 @@ exports[`version > updates an existing PR via GraphQL and converts it to draft w
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"pullRequestId": "PR_kwDOA", "pullRequestId": "PR_kwDOA",
"title": "Version Packages", "title": "Version Packages",
}, },
@@ -224,12 +218,11 @@ exports[`version > updates an existing PR via GraphQL without converting it to d
# Releases # Releases
## simple-project-pkg-a@1.1.0 ## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
- Awesome feature - Awesome feature",
",
"pullRequestId": "PR_kwDOA", "pullRequestId": "PR_kwDOA",
"title": "Version Packages", "title": "Version Packages",
}, },
+6 -8
View File
@@ -23,23 +23,21 @@ exports[`it sorts the things right 1`] = `
exports[`it works 1`] = ` exports[`it works 1`] = `
"### Major Changes "### Major Changes
- [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779): - [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779):
- Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated - Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated
### Patch Changes ### Patch Changes
- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5): - [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):
- Update dependencies - Update dependencies"
"
`; `;
exports[`it works 2`] = ` exports[`it works 2`] = `
"### Patch Changes "### Patch Changes
- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b): - [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):
Move frontmatter in docs into comments Move frontmatter in docs into comments"
"
`; `;
+3 -3
View File
@@ -14,7 +14,7 @@ const push = async (branch: string, options: GitOptions) => {
const switchToMaybeExistingBranch = async ( const switchToMaybeExistingBranch = async (
branch: string, branch: string,
options: GitOptions options: GitOptions,
) => { ) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], { let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true, ignoreReturnCode: true,
@@ -41,7 +41,7 @@ const checkIfClean = async (options: GitOptions): Promise<boolean> => {
const { stdout } = await getExecOutput( const { stdout } = await getExecOutput(
"git", "git",
["status", "--porcelain"], ["status", "--porcelain"],
options options,
); );
return !stdout.length; return !stdout.length;
}; };
@@ -71,7 +71,7 @@ export class Git {
], ],
{ {
cwd: this.cwd, cwd: this.cwd,
} },
); );
} }
+26 -13
View File
@@ -1,6 +1,6 @@
import * as core from "@actions/core";
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import path from "node:path"; import path from "node:path";
import * as core from "@actions/core";
import { Git } from "./git.ts"; import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts"; import { setupOctokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts"; import readChangesetState from "./readChangesetState.ts";
@@ -48,7 +48,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
core.info("setting GitHub credentials"); 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}`,
); );
let { changesets } = await readChangesetState(cwd); let { changesets } = await readChangesetState(cwd);
@@ -56,7 +56,7 @@ 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( const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0 (changeset) => changeset.releases.length > 0,
); );
let hasPublishScript = !!publishScript; let hasPublishScript = !!publishScript;
@@ -67,12 +67,12 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
switch (true) { switch (true) {
case !hasChangesets && !hasPublishScript: case !hasChangesets && !hasPublishScript:
core.info( core.info(
"No changesets present or were removed by merging release PR. Not publishing because no publish script found." "No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
); );
return; return;
case !hasChangesets && hasPublishScript: { case !hasChangesets && hasPublishScript: {
core.info( core.info(
"No changesets found. Attempting to publish any unpublished packages to npm" "No changesets found. Attempting to publish any unpublished packages to npm",
); );
if (process.env.NPM_TOKEN) { if (process.env.NPM_TOKEN) {
@@ -87,24 +87,24 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
}); });
if (authLine) { if (authLine) {
core.info( 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 {
core.info( 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",
); );
await fs.appendFile( 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 {
core.info( core.info(
"No user .npmrc file found, creating one with NPM_TOKEN used as auth token" "No user .npmrc file found, creating one with NPM_TOKEN used as auth token",
); );
await fs.writeFile( await fs.writeFile(
userNpmrcPath, userNpmrcPath,
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n` `//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`,
); );
} }
} else if ( } else if (
@@ -112,11 +112,11 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
process.env.ACTIONS_ID_TOKEN_REQUEST_URL process.env.ACTIONS_ID_TOKEN_REQUEST_URL
) { ) {
core.info( core.info(
"No NPM_TOKEN found, but OIDC is available - using npm trusted publishing" "No NPM_TOKEN found, but OIDC is available - using npm trusted publishing",
); );
} else { } else {
core.info( core.info(
"No NPM_TOKEN or OIDC available - assuming npm is already authenticated" "No NPM_TOKEN or OIDC available - assuming npm is already authenticated",
); );
} }
@@ -133,9 +133,22 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
core.setOutput("published", "true"); core.setOutput("published", "true");
core.setOutput( core.setOutput(
"publishedPackages", "publishedPackages",
JSON.stringify(result.publishedPackages) JSON.stringify(result.publishedPackages),
); );
} }
if (result.exitCode !== 0) {
core.error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
process.exit(result.exitCode);
}
return; return;
} }
case hasChangesets && !hasNonEmptyChangesets: case hasChangesets && !hasNonEmptyChangesets:
+4 -4
View File
@@ -9,7 +9,7 @@ export const setupOctokit = (githubToken: string) => {
throttle: { throttle: {
onRateLimit: (retryAfter, options: any, octokit, retryCount) => { onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
core.warning( core.warning(
`Request quota exhausted for request ${options.method} ${options.url}` `Request quota exhausted for request ${options.method} ${options.url}`,
); );
if (retryCount <= 2) { if (retryCount <= 2) {
@@ -21,10 +21,10 @@ export const setupOctokit = (githubToken: string) => {
retryAfter, retryAfter,
options: any, options: any,
octokit, octokit,
retryCount retryCount,
) => { ) => {
core.warning( core.warning(
`SecondaryRateLimit detected for request ${options.method} ${options.url}` `SecondaryRateLimit detected for request ${options.method} ${options.url}`,
); );
if (retryCount <= 2) { if (retryCount <= 2) {
@@ -34,7 +34,7 @@ export const setupOctokit = (githubToken: string) => {
}, },
}, },
}, },
throttling throttling,
); );
}; };
+77
View File
@@ -0,0 +1,77 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
type Octokit = ReturnType<typeof github.getOctokit>;
type CreateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
>;
type UpdateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
>;
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
const githubToken = core.getInput("github-token", { required: true });
const body = core.getInput("body", { required: true });
const updateId = core.getInput("update-id");
const commentMarker = updateId ? getCommentMarker(updateId) : null;
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
const commentParam: CreateCommentParams | UpdateCommentParams = {
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
body: commentBody,
};
const octokit = github.getOctokit(githubToken);
let existingCommentId: number | undefined;
if (commentMarker) {
core.info("Checking for existing comment...");
existingCommentId = await octokit.rest.issues
.listComments({
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
})
.then((res) => {
const comment = res.data.find((c) => c.body?.includes(commentMarker));
return comment?.id;
});
}
if (existingCommentId) {
core.info(`Updating existing comment (id: ${existingCommentId})...`);
await octokit.rest.issues.updateComment({
...commentParam,
comment_id: existingCommentId,
});
core.setOutput("comment-id", existingCommentId);
} else {
core.info("Creating new comment...");
const result = await octokit.rest.issues.createComment(commentParam);
core.setOutput("comment-id", result.data.id);
}
core.info("Done!");
}
function getCommentMarker(updateId: string) {
const prefix = "changesets-action-pr-comment";
return prefix === updateId
? `<!-- ${prefix} -->`
: `<!-- ${prefix}:${updateId} -->`;
}
+23
View File
@@ -0,0 +1,23 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
import { getCommentMessage } from "./message.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
core.info("Creating comment message...");
const commentBody = await getCommentMessage(context);
core.setOutput("comment-body", commentBody);
core.info("Done!");
}
+120
View File
@@ -0,0 +1,120 @@
import * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import type {
ComprehensiveRelease,
ReleasePlan,
VersionType,
} from "@changesets/types";
import { markdownTable } from "markdown-table";
import {
getNewChangesetTemplateContent,
getNewChangesetUrl,
} from "./template.ts";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
export async function getCommentMessage(context: PullRequestContext) {
await using worktree = await getPullRequestWorktree(context);
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
const templateContent = await getNewChangesetTemplateContent(
worktree.cwd,
worktree.baseRef,
context.title,
);
const newChangesetUrl = getNewChangesetUrl(
context.head.repo.html_url,
context.head.ref,
templateContent,
);
if (releasePlan.changesets.length > 0) {
return getApproveMessage(context.head.sha, newChangesetUrl, releasePlan);
} else {
return getAbsentMessage(context.head.sha, newChangesetUrl, releasePlan);
}
}
function getApproveMessage(
commitSha: string,
newChangesetUrl: string,
releasePlan: ReleasePlan,
) {
return `\
### 🦋 Changeset detected
Latest commit: ${commitSha}
**The changes in this PR will be included in the next version bump.**
${getReleasePlanMessage(releasePlan)}
Not sure what this means? [Click here to learn what changesets are](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`;
}
function getAbsentMessage(
commitSha: string,
newChangesetUrl: string,
releasePlan: ReleasePlan,
) {
return `\
### ⚠️ No Changeset found
Latest commit: ${commitSha}
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
${getReleasePlanMessage(releasePlan)}
[Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
[Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
}
function getReleasePlanMessage(releasePlan: ReleasePlan) {
const publishableReleases = releasePlan.releases.filter(
(r) => r.type !== "none",
) as (ComprehensiveRelease & { type: Exclude<VersionType, "none"> })[];
const table = markdownTable([
["Name", "Type"],
...publishableReleases.map((release) => {
return [
release.name,
{
major: "Major",
minor: "Minor",
patch: "Patch",
}[release.type],
];
}),
]);
let summary = "This PR includes ";
if (releasePlan.changesets.length === 0) {
summary += "no changesets";
} else {
summary += `changesets to release ${publishableReleases.length} package`;
if (publishableReleases.length !== 1) {
summary += "s";
}
}
return `\
<details>
<summary>${summary}</summary>
${
publishableReleases.length > 0
? table
: "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
}
</details>`;
}
+30
View File
@@ -0,0 +1,30 @@
import { getChangedPackagesSinceRef } from "@changesets/git";
import { humanId } from "human-id";
export function getNewChangesetUrl(
headRepoUrl: string,
headRef: string,
templateContent: string,
) {
const fileName = humanId({ separator: "-", capitalize: false });
return `${headRepoUrl}/new/${headRef}?filename=.changeset/${fileName}.md&value=${encodeURIComponent(templateContent)}`;
}
export async function getNewChangesetTemplateContent(
cwd: string,
baseRef: string,
prTitle: string,
) {
const changedPackages = await getChangedPackagesSinceRef({
cwd,
ref: baseRef,
});
return `\
---
${changedPackages.map((p) => `"${p.packageJson.name}": patch`).join("\n")}
---
${prTitle}
`;
}
+148
View File
@@ -0,0 +1,148 @@
import { pathToFileURL } from "node:url";
import type * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import { createFixture } from "fs-fixture";
import { exec } from "tinyexec";
import { describe, expect, it } from "vitest";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
async function git(cwd: string, args: string[]) {
const output = await exec("git", args, {
nodeOptions: { cwd },
throwOnError: true,
});
return output.stdout.trim();
}
describe("getPullRequestWorktree", () => {
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
// Local source repo
await using sourceRepoFixture = await createFixture({
".changeset/config.json": JSON.stringify({}),
"package.json": JSON.stringify({
name: "repo",
private: true,
workspaces: ["packages/*"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
});
const sourceRepo = sourceRepoFixture.path;
await git(sourceRepo, ["init", "-b", "main"]);
await git(sourceRepo, ["config", "user.name", "Test User"]);
await git(sourceRepo, ["config", "user.email", "test@example.com"]);
await git(sourceRepo, ["add", "."]);
await git(sourceRepo, ["commit", "-m", "base"]);
// Simulate remote bare git server
await using originBareFixture = await createFixture();
const originBare = originBareFixture.path;
await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
// Simulate checkout PR in github action
await using checkoutRepoFixture = await createFixture();
const checkoutRepo = checkoutRepoFixture.path;
await git(checkoutRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(originBare).toString(),
checkoutRepo,
]);
// Simulate remote fork bare git server
await using forkBareFixture = await createFixture();
const forkBare = forkBareFixture.path;
await git(forkBare, ["clone", "--bare", originBare, forkBare]);
await using forkRepoFixture = await createFixture();
const forkRepo = forkRepoFixture.path;
await git(forkRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(forkBare).toString(),
forkRepo,
]);
await git(forkRepo, ["config", "user.name", "Test User"]);
await git(forkRepo, ["config", "user.email", "test@example.com"]);
await git(forkRepo, ["checkout", "-b", "feature"]);
await forkRepoFixture.mkdir("packages/pkg-a/src");
await forkRepoFixture.writeFile(
"packages/pkg-a/src/index.ts",
"export const value = 1;\n",
);
await forkRepoFixture.writeFile(
".changeset/add-pkg-a.md",
`\
---
"pkg-a": patch
---
Add pkg-a
`,
);
await git(forkRepo, ["add", "."]);
await git(forkRepo, ["commit", "-m", "feature"]);
await git(forkRepo, ["push", "origin", "feature"]);
// Run tests
const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
const context = {
number: 123,
base: {
ref: "main",
repo: {
clone_url: pathToFileURL(originBare).toString(),
},
},
head: {
ref: "feature",
repo: {
clone_url: pathToFileURL(forkBare).toString(),
},
},
};
await using worktree = await getPullRequestWorktree(
context satisfies PullRequestContext as PullRequestContext,
checkoutRepo,
);
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
expect(currentHead).not.toBe(originalHead);
const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
expect(currentBranch).toBe("");
const releases = releasePlan.releases.map((release) => ({
name: release.name,
type: release.type,
newVersion: release.newVersion,
}));
expect(releases).toEqual([
{
name: "pkg-a",
type: "patch",
newVersion: "1.0.1",
},
]);
expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
});
});
+165
View File
@@ -0,0 +1,165 @@
import { randomUUID } from "node:crypto";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import type * as github from "@actions/github";
import { isRepoShallow } from "@changesets/git";
import { exec } from "tinyexec";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
type WorktreeInfo = {
baseRef: string;
cwd: string;
};
type TinyexecOptions = Parameters<typeof exec>[2];
function git(cwd: string, args: string[], opts: TinyexecOptions = {}) {
return exec("git", args, {
nodeOptions: { cwd, ...opts.nodeOptions },
throwOnError: true,
...opts,
});
}
interface Ref {
fetchSource: string;
local: string;
remote: string;
}
function getRefs(context: PullRequestContext): Record<"base" | "head", Ref> {
const suffix = `${context.number}-${randomUUID()}`;
return {
base: {
fetchSource: "origin",
local: `refs/changesets-action-pr-status/base/${suffix}`,
remote: `refs/heads/${context.base.ref}`,
},
head: {
fetchSource: context.head.repo.clone_url,
local: `refs/changesets-action-pr-status/head/${suffix}`,
remote: `refs/heads/${context.head.ref}`,
},
};
}
async function deepenRef(cwd: string, ref: Ref, deepenBy: number) {
await git(cwd, [
"fetch",
"--no-tags",
`--deepen=${deepenBy}`,
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
}
async function ensureMergeBase(args: {
cwd: string;
refs: ReturnType<typeof getRefs>;
deepenBy?: number;
}) {
const { cwd, refs, deepenBy = 50 } = args;
while (true) {
const mergeBase = await git(cwd, ["merge-base", refs.base.local, "HEAD"], {
throwOnError: false,
});
if (mergeBase.exitCode === 0) {
return mergeBase.stdout.trim();
}
if (!(await isRepoShallow({ cwd }))) {
throw new Error(
`Failed to find merge base between "${refs.base.local}" and HEAD, and the repository is no longer shallow.`,
);
}
await deepenRef(cwd, refs.base, deepenBy);
await deepenRef(cwd, refs.head, deepenBy);
}
}
async function mkdtemp(prefix: string) {
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
return {
dir,
async [Symbol.asyncDispose]() {
await fs.rm(dir, { recursive: true, force: true });
},
};
}
async function tempRef(cwd: string, ref: Ref) {
await git(cwd, [
"fetch",
"--no-tags",
"--depth=1",
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["update-ref", "-d", ref.local], { throwOnError: false });
},
};
}
async function tempWorktree(cwd: string, dir: string, ref: Ref) {
await git(cwd, ["worktree", "add", "--detach", dir, ref.local]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["worktree", "remove", "--force", dir], {
throwOnError: false,
});
},
};
}
type WithAsyncDispose<T> = T & {
[Symbol.asyncDispose](): Promise<void>;
};
function moveDisposable<T extends object>(
stack: AsyncDisposableStack,
value: T,
): WithAsyncDispose<T> {
const moved = stack.move();
return Object.assign(value, {
async [Symbol.asyncDispose]() {
await moved.disposeAsync();
},
});
}
export async function getPullRequestWorktree(
context: PullRequestContext,
cwd: string = process.cwd(),
): Promise<WithAsyncDispose<WorktreeInfo>> {
await using stack = new AsyncDisposableStack();
const worktreeDir = stack.use(
await mkdtemp("changesets-action-pr-status-"),
).dir;
const refs = getRefs(context);
stack.use(await tempRef(cwd, refs.base));
stack.use(await tempRef(cwd, refs.head));
stack.use(await tempWorktree(cwd, worktreeDir, refs.head));
await ensureMergeBase({
cwd: worktreeDir,
refs,
});
return moveDisposable(stack, {
baseRef: refs.base.local,
cwd: worktreeDir,
});
}
+2 -2
View File
@@ -1,6 +1,6 @@
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";
import type { PreState, NewChangeset } from "@changesets/types";
export type ChangesetState = { export type ChangesetState = {
preState: PreState | undefined; preState: PreState | undefined;
@@ -8,7 +8,7 @@ export type ChangesetState = {
}; };
export default async function readChangesetState( export default async function readChangesetState(
cwd: string = process.cwd() cwd: string = process.cwd(),
): Promise<ChangesetState> { ): Promise<ChangesetState> {
let preState = await readPreState(cwd); let preState = await readPreState(cwd);
let changesets = await readChangesets(cwd); let changesets = await readChangesets(cwd);
+88 -45
View File
@@ -1,8 +1,7 @@
import path from "node:path";
import type { Changeset } from "@changesets/types"; import type { Changeset } from "@changesets/types";
import writeChangeset from "@changesets/write"; import writeChangeset from "@changesets/write";
import fixturez from "fixturez"; import { createFixture } from "fs-fixture";
import fs from "node:fs/promises";
import path from "node:path";
import { beforeEach, describe, expect, it, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
import { Git } from "./git.ts"; import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts"; import { setupOctokit } from "./octokit.ts";
@@ -36,14 +35,58 @@ let mockedGithubMethods = {
}; };
let mockedGraphql = vi.fn(); let mockedGraphql = vi.fn();
let f = fixturez(import.meta.dirname); const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules");
function createSimpleProjectFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-simple-project-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
function createIgnoredPackageFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({
ignore: ["changesets-dev-ignored-package-pkg-a"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-ignored-package-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "ignored-package",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
const linkNodeModules = async (cwd: string) => {
await fs.symlink(
path.join(import.meta.dirname, "..", "node_modules"),
path.join(cwd, "node_modules")
);
};
const writeChangesets = (changesets: Changeset[], cwd: string) => { const writeChangesets = (changesets: Changeset[], cwd: string) => {
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd))); return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
}; };
@@ -54,8 +97,8 @@ beforeEach(() => {
describe("version", () => { describe("version", () => {
it("creates simple PR", async () => { it("creates simple PR", async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -68,18 +111,18 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
{ {
name: "simple-project-pkg-b", name: "changesets-dev-simple-project-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -93,8 +136,8 @@ describe("version", () => {
}); });
it('creates a draft PR when prDraft is "create"', async () => { it('creates a draft PR when prDraft is "create"', async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -107,14 +150,14 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -129,8 +172,8 @@ 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"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -143,14 +186,14 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -164,8 +207,8 @@ describe("version", () => {
}); });
it("doesn't include ignored package that got a dependency update in the PR body", async () => { it("doesn't include ignored package that got a dependency update in the PR body", async () => {
let cwd = f.copy("ignored-package"); await using fixture = await createIgnoredPackageFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -178,14 +221,14 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "ignored-package-pkg-b", name: "changesets-dev-ignored-package-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -199,8 +242,8 @@ describe("version", () => {
}); });
it("does not include changelog entries if full message exceeds size limit", async () => { it("does not include changelog entries if full message exceeds size limit", async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -213,7 +256,7 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
@@ -240,7 +283,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -253,13 +296,13 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch( expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
/The changelog information of each package has been omitted from this message/ /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 () => { 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 using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -272,7 +315,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
@@ -299,7 +342,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -312,13 +355,13 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch( 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/ /All release information have been omitted from this message, as the content exceeds the size limit/,
); );
}); });
it('updates an existing PR via GraphQL without converting it to draft when prDraft is "create"', async () => { it('updates an existing PR via GraphQL without converting it to draft when prDraft is "create"', async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
@@ -329,14 +372,14 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
@@ -351,8 +394,8 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
}); });
it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => { it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
let cwd = f.copy("simple-project"); await using fixture = await createSimpleProjectFixture();
await linkNodeModules(cwd); const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
@@ -363,14 +406,14 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "simple-project-pkg-a", name: "changesets-dev-simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd cwd,
); );
await runVersion({ await runVersion({
+29 -27
View File
@@ -1,11 +1,11 @@
import fs from "node:fs/promises";
import { createRequire } from "node:module";
import path from "node:path";
import * as core from "@actions/core"; import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec"; import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github"; import * as github from "@actions/github";
import type { PreState } from "@changesets/types"; import type { PreState } from "@changesets/types";
import { type Package, getPackages } from "@manypkg/get-packages"; import { type Package, getPackages } from "@manypkg/get-packages";
import fs from "node:fs/promises";
import { createRequire } from "node:module";
import path from "node:path";
import semverLt from "semver/functions/lt.js"; import semverLt from "semver/functions/lt.js";
import { Git } from "./git.ts"; import { Git } from "./git.ts";
import type { Octokit } from "./octokit.ts"; import type { Octokit } from "./octokit.ts";
@@ -28,7 +28,7 @@ const MAX_CHARACTERS_PER_MESSAGE = 60000;
const createRelease = async ( const createRelease = async (
octokit: Octokit, octokit: Octokit,
{ pkg, tagName }: { pkg: Package; tagName: string } { pkg, tagName }: { pkg: Package; tagName: string },
) => { ) => {
let changelog; let changelog;
try { try {
@@ -45,7 +45,7 @@ const createRelease = async (
// we can find a changelog but not the entry for this version // we can find a changelog but not the entry for this version
// if this is true, something has probably gone wrong // if this is true, something has probably gone wrong
throw new Error( throw new Error(
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}` `Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`,
); );
} }
@@ -73,9 +73,11 @@ type PublishResult =
| { | {
published: true; published: true;
publishedPackages: PublishedPackage[]; publishedPackages: PublishedPackage[];
exitCode: number;
} }
| { | {
published: false; published: false;
exitCode: number;
}; };
export async function runPublish({ export async function runPublish({
@@ -86,13 +88,11 @@ export async function runPublish({
createGithubReleases, createGithubReleases,
cwd, cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
let [publishCommand, ...publishArgs] = script.split(/\s+/); let changesetPublishOutput = await getExecOutput(script, undefined, {
cwd,
let changesetPublishOutput = await getExecOutput( ignoreReturnCode: true,
publishCommand, env: { ...process.env, GITHUB_TOKEN: githubToken },
publishArgs, });
{ cwd, env: { ...process.env, GITHUB_TOKEN: githubToken } }
);
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = []; let releasedPackages: Package[] = [];
@@ -111,7 +111,7 @@ export async function runPublish({
if (pkg === undefined) { if (pkg === undefined) {
throw new Error( throw new Error(
`Package "${pkgName}" not found.` + `Package "${pkgName}" not found.` +
"This is probably a bug in the action, please open an issue" "This is probably a bug in the action, please open an issue",
); );
} }
releasedPackages.push(pkg); releasedPackages.push(pkg);
@@ -123,14 +123,14 @@ export async function runPublish({
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`; const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
await git.pushTag(tagName); await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName }); await createRelease(octokit, { pkg, tagName });
}) }),
); );
} }
} else { } else {
if (packages.length === 0) { if (packages.length === 0) {
throw new Error( throw new Error(
`No package found.` + `No package found.` +
"This is probably a bug in the action, please open an issue" "This is probably a bug in the action, please open an issue",
); );
} }
let pkg = packages[0]; let pkg = packages[0];
@@ -158,22 +158,25 @@ export async function runPublish({
name: pkg.packageJson.name, name: pkg.packageJson.name,
version: pkg.packageJson.version, version: pkg.packageJson.version,
})), })),
exitCode: changesetPublishOutput.exitCode,
}; };
} }
return { published: false }; return { published: false, exitCode: changesetPublishOutput.exitCode };
} }
const requireChangesetsCliPkgJson = (cwd: string) => { const requireChangesetsCliPkgJson = (cwd: string) => {
try { try {
return require(require.resolve("@changesets/cli/package.json", { return require(
paths: [cwd], require.resolve("@changesets/cli/package.json", {
})); paths: [cwd],
}),
);
} catch (err) { } catch (err) {
if (isErrorWithCode(err, "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 } { cause: err },
); );
} }
throw err; throw err;
@@ -291,8 +294,7 @@ export async function runVersion({
const env = { ...process.env, GITHUB_TOKEN: githubToken }; const env = { ...process.env, GITHUB_TOKEN: githubToken };
if (script) { if (script) {
let [versionCommand, ...versionArgs] = script.split(/\s+/); await exec(script, undefined, { cwd, env });
await exec(versionCommand, versionArgs, { cwd, env });
} else { } else {
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd); let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0") let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0")
@@ -309,7 +311,7 @@ export async function runVersion({
{ {
cwd, cwd,
env, env,
} },
); );
} }
@@ -318,7 +320,7 @@ export async function runVersion({
changedPackages.map(async (pkg) => { changedPackages.map(async (pkg) => {
let changelogContents = await fs.readFile( let changelogContents = await fs.readFile(
path.join(pkg.dir, "CHANGELOG.md"), path.join(pkg.dir, "CHANGELOG.md"),
"utf8" "utf8",
); );
let entry = getChangelogEntry(changelogContents, pkg.packageJson.version); let entry = getChangelogEntry(changelogContents, pkg.packageJson.version);
@@ -328,7 +330,7 @@ export async function runVersion({
content: entry.content, content: entry.content,
header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`, header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`,
}; };
}) }),
); );
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`; const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
@@ -353,8 +355,8 @@ export async function runVersion({
`Existing pull requests: ${JSON.stringify( `Existing pull requests: ${JSON.stringify(
existingPullRequests.data, existingPullRequests.data,
null, null,
2 2,
)}` )}`,
); );
await git.pushChanges({ branch: versionBranch, message: finalCommitMessage }); await git.pushChanges({ branch: versionBranch, message: finalCommitMessage });
+43 -45
View File
@@ -1,10 +1,4 @@
import unified from "unified";
import remarkParse from "remark-parse";
import remarkStringify from "remark-stringify";
import fs from "node:fs/promises"; import fs from "node:fs/promises";
import type { Root } from "mdast";
// @ts-ignore
import mdastToString from "mdast-util-to-string";
import { getPackages, type Package } from "@manypkg/get-packages"; import { getPackages, type Package } from "@manypkg/get-packages";
export const BumpLevels = { export const BumpLevels = {
@@ -21,7 +15,7 @@ export async function getVersionsByDirectory(cwd: string) {
export async function getChangedPackages( export async function getChangedPackages(
cwd: string, cwd: string,
previousVersions: Map<string, string> previousVersions: Map<string, string>,
) { ) {
let { packages } = await getPackages(cwd); let { packages } = await getPackages(cwd);
let changedPackages = new Set<Package>(); let changedPackages = new Set<Package>();
@@ -37,57 +31,61 @@ export async function getChangedPackages(
} }
export function getChangelogEntry(changelog: string, version: string) { export function getChangelogEntry(changelog: string, version: string) {
let ast = unified().use(remarkParse).parse(changelog) as Root;
let highestLevel: number = BumpLevels.dep; let highestLevel: number = BumpLevels.dep;
let headingStartInfo: { index: number; depth: number } | undefined;
let nodes = ast.children;
let headingStartInfo:
| {
index: number;
depth: number;
}
| undefined;
let endIndex: number | undefined; let endIndex: number | undefined;
for (let i = 0; i < nodes.length; i++) { // Iterate through each headings and code blocks (for skipping its contents)
let node = nodes[i]; const regex = /^(#{1,6})\s(.*)$|^(`{3,})/gm;
if (node.type === "heading") { let match: RegExpExecArray | null;
let stringified: string = mdastToString(node); while ((match = regex.exec(changelog)) != null) {
let match = stringified.toLowerCase().match(/(major|minor|patch)/); // Skip over code blocks so we don't match any headings inside of them
if (match !== null) { if (match[3]) {
let level = BumpLevels[match[0] as "major" | "minor" | "patch"]; const endOfCodeBlockRegex = new RegExp(`^${match[3]}`, "gm");
highestLevel = Math.max(level, highestLevel); endOfCodeBlockRegex.lastIndex = regex.lastIndex;
} const endMatch = endOfCodeBlockRegex.exec(changelog);
if (headingStartInfo === undefined && stringified === version) { if (endMatch) {
headingStartInfo = { // Start next search for headings after the end of the code block
index: i, regex.lastIndex = endOfCodeBlockRegex.lastIndex;
depth: node.depth,
};
continue; continue;
} } else {
if ( // Can't find end of code block, probably malformed
endIndex === undefined &&
headingStartInfo !== undefined &&
headingStartInfo.depth === node.depth
) {
endIndex = i;
break; break;
} }
} }
const headingDepth = match[1].length;
const headingText = match[2].trim();
// Search for the highest bump level in the entire changelog
const levelMatch = /(major|minor|patch)/.exec(headingText.toLowerCase());
if (levelMatch != null) {
const level = BumpLevels[levelMatch[0] as "major" | "minor" | "patch"];
highestLevel = Math.max(level, highestLevel);
}
// Search for heading of the entry
if (headingText === version) {
headingStartInfo = { index: regex.lastIndex, depth: headingDepth };
continue;
}
// If we've found the entry heading, search for the closing heading with the same depth
if (headingStartInfo && headingDepth === headingStartInfo.depth) {
endIndex = match.index;
break;
}
} }
if (headingStartInfo) {
ast.children = ast.children.slice(headingStartInfo.index + 1, endIndex);
}
return { return {
content: unified().use(remarkStringify).stringify(ast), content: changelog.slice(headingStartInfo?.index, endIndex).trim(),
highestLevel: highestLevel, highestLevel,
}; };
} }
export function sortTheThings( export function sortTheThings(
a: { private: boolean; highestLevel: number }, a: { private: boolean; highestLevel: number },
b: { private: boolean; highestLevel: number } b: { private: boolean; highestLevel: number },
) { ) {
if (a.private === b.private) { if (a.private === b.private) {
return b.highestLevel - a.highestLevel; return b.highestLevel - a.highestLevel;
@@ -110,6 +108,6 @@ export function isErrorWithCode(err: unknown, code: string) {
export function fileExists(filePath: string) { export function fileExists(filePath: string) {
return fs.access(filePath, fs.constants.F_OK).then( return fs.access(filePath, fs.constants.F_OK).then(
() => true, () => true,
() => false () => false,
); );
} }
+4 -7
View File
@@ -1,14 +1,11 @@
{ {
"extends": "@tsconfig/node24/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"allowImportingTsExtensions": true, "allowImportingTsExtensions": true,
"erasableSyntaxOnly": true, "erasableSyntaxOnly": true,
"isolatedModules": true, "verbatimModuleSyntax": true,
"module": "node18",
"moduleResolution": "node16",
"noEmit": true,
"resolveJsonModule": true,
"strict": true, "strict": true,
"target": "esnext", "noEmit": true,
"verbatimModuleSyntax": true "types": ["node"]
} }
} }
-17
View File
@@ -1,17 +0,0 @@
type Opts = {
glob?: string | Array<string>;
root?: string;
cleanup?: boolean;
};
declare module "fixturez" {
export default function (
cwd: string,
opts?: Opts
): {
find: (a: string) => string;
temp: () => string;
copy: (a: string) => string;
cleanup: () => any;
};
}
-3069
View File
File diff suppressed because it is too large Load Diff