Compare commits

..
Author SHA1 Message Date
github-actions[bot] 63a615b9cd v1.8.0 2026-05-07 09:48:08 +00:00
73 changed files with 4215 additions and 6527 deletions
+6 -7
View File
@@ -1,14 +1,13 @@
{ {
"$schema": "https://unpkg.com/@changesets/config@4.0.0-next.6/schema.json", "$schema": "https://unpkg.com/@changesets/config@1.6.2/schema.json",
"changelog": "@changesets/changelog-github", "changelog": [
"@changesets/changelog-github",
{ "repo": "changesets/action" }
],
"commit": false, "commit": false,
"linked": [], "linked": [],
"access": "restricted", "access": "restricted",
"baseBranch": "main", "baseBranch": "main",
"updateInternalDependencies": "patch", "updateInternalDependencies": "patch",
"ignore": [], "ignore": []
"privatePackages": {
"version": true,
"tag": true
}
} }
+5 -5
View File
@@ -1,5 +1,5 @@
/.github/** @Andarist @bluwy @emmatown /.github/workflows/** @Andarist @emmatown
/action.yml @Andarist @bluwy @emmatown /action.yml @Andarist @emmatown
/scripts/bump.ts @Andarist @bluwy @emmatown /scripts/bump.ts @Andarist @emmatown
/scripts/release.ts @Andarist @bluwy @emmatown /scripts/release.ts @Andarist @emmatown
/scripts/release-pr.ts @Andarist @bluwy @emmatown /scripts/release-pr.ts @Andarist @emmatown
+4 -19
View File
@@ -1,29 +1,14 @@
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: Check out repo - name: Setup Node.js
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
with:
persist-credentials: false
- name: Set up pnpm
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"
package-manager-cache: ${{ inputs.skip-cache != 'true' }} cache: yarn
cache: ${{ inputs.skip-cache != 'true' && 'pnpm' || '' }}
- name: Install dependencies - name: Install dependencies
shell: bash shell: bash
run: pnpm install --frozen-lockfile run: yarn install --frozen-lockfile
-44
View File
@@ -1,44 +0,0 @@
name: Setup bot auth
description: Create a GitHub App token and configure matching git identity
inputs:
client-id:
description: GitHub App client ID
required: true
private-key:
description: GitHub App private key
required: true
permission-contents:
description: Contents permission for the GitHub App token
required: false
default: write
permission-pull-requests:
description: Pull requests permission for the GitHub App token
required: false
outputs:
token:
description: GitHub App installation access token
value: ${{ steps.app-token.outputs.token }}
runs:
using: composite
steps:
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
id: app-token
with:
client-id: ${{ inputs.client-id }}
private-key: ${{ inputs.private-key }}
permission-contents: ${{ inputs.permission-contents }}
permission-pull-requests: ${{ inputs.permission-pull-requests }}
- name: Setup Git user
shell: bash
run: |
app_user="$APP_SLUG[bot]"
app_id="$(gh api "/users/$app_user" --jq .id)"
git config user.name "$app_user"
git config user.email "$app_id+$app_user@users.noreply.github.com"
env:
APP_SLUG: ${{ steps.app-token.outputs.app-slug }}
GH_TOKEN: ${{ steps.app-token.outputs.token }}
+8 -29
View File
@@ -1,32 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2 version: 2
updates: updates:
- package-ecosystem: "npm" - package-ecosystem: "npm" # See documentation for possible values
directory: "/" directory: "/" # Location of package manifests
schedule: schedule:
interval: "monthly" interval: "weekly"
cooldown:
default-days: 7
open-pull-requests-limit: 10
versioning-strategy: increase
groups:
production-dependencies:
dependency-type: "production"
update-types:
- minor
- patch
development-dependencies:
dependency-type: "development"
update-types:
- minor
- patch
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
cooldown:
default-days: 7
open-pull-requests-limit: 5
groups:
github-actions:
patterns:
- "*"
+15 -48
View File
@@ -2,78 +2,45 @@ name: CI
on: on:
pull_request: pull_request:
# merge queue is required so all commits on target branches trigger this workflow push:
# despite lack of the push event trigger here branches: [main]
merge_group: merge_group:
branches: branches: [main]
- main
- next
# merge group rulesets don't allow wildcards so in settings each maintenance branch needs to be added separately
- "maintenance/v*" # branch rulesets don't support v[0-9]+
permissions: 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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Run zizmor
uses: zizmorcore/zizmor-action@cc914d7f3750a2d13d75c7f184a1060aa0e9d482 # v0.6.4
with:
persona: pedantic
annotations: true
advanced-security: false
test: test:
name: Test name: Test
runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest
steps: steps:
- uses: $/.github/actions/ci-setup - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./.github/actions/ci-setup
- name: Test - name: Test
run: pnpm test run: yarn test
typecheck: typecheck:
name: Typecheck name: Typecheck
runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest
steps: steps:
- uses: $/.github/actions/ci-setup - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./.github/actions/ci-setup
- name: Typecheck - name: Typecheck
run: pnpm typecheck run: yarn typecheck
lint:
name: Lint
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- 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: [lint-workflows, test, typecheck, lint] needs: [test, typecheck]
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, 'cancelled')) }} if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'skipped') || contains(needs.*.result, 'cancelled')) }}
+27 -63
View File
@@ -4,95 +4,59 @@ on:
push: push:
branches: branches:
- main - main
- next
- "maintenance/v*" # branch rulesets don't support v[0-9]+
concurrency: concurrency: ${{ github.workflow }}-${{ github.ref }}
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
jobs: jobs:
select-mode: version:
name: Select mode name: Version
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20
outputs: outputs:
mode: ${{ steps.select-mode.outputs.mode }} hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
permissions: permissions:
contents: read # to check out repo (actions/checkout) contents: write # to create release (changesets/action)
issues: write # to post issue comments (changesets/action)
pull-requests: write # to create pull request (changesets/action)
steps: steps:
- uses: $/.github/actions/ci-setup - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: - uses: ./.github/actions/ci-setup
skip-cache: true # avoid cache poisoning attacks
- name: Build - name: Build
run: pnpm build run: yarn build
- name: Select mode
id: select-mode
uses: $/select-mode
version:
name: Version
if: needs.select-mode.outputs.mode == 'version'
needs: select-mode
runs-on: ubuntu-latest
environment: version
timeout-minutes: 20
permissions:
contents: read # to check out repo (actions/checkout)
steps:
- uses: $/.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- uses: $/.github/actions/setup-bot-auth
id: bot-auth
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to create version commits (changesets/action)
permission-pull-requests: write # to create pull request (changesets/action)
- name: Create or update release pull request - name: Create or update release pull request
id: changesets id: changesets
uses: $/version uses: ./
with: with:
github-token: ${{ steps.bot-auth.outputs.token }} version: yarn bump
script: pnpm bump
publish: publish:
name: Publish name: Publish
if: needs.select-mode.outputs.mode == 'publish' if: needs.version.outputs.hasChangesets == 'false'
needs: select-mode needs: version
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: $/.github/actions/ci-setup - uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
with: id: app-token
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- uses: $/.github/actions/setup-bot-auth
id: bot-auth
with: with:
client-id: ${{ vars.APP_CLIENT_ID }} client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }} private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to bypass branch and tag protection rules (release.ts)
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
token: ${{ steps.app-token.outputs.token }}
- uses: ./.github/actions/ci-setup
- name: Build
run: yarn build
- name: Publish to marketplace - name: Publish to marketplace
uses: $/publish uses: ./
with: with:
github-token: ${{ steps.bot-auth.outputs.token }} publish: yarn release
script: pnpm release
+34 -92
View File
@@ -4,33 +4,22 @@ 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 # to inspect the pull request commit state (changesets/action) contents: read
issues: write # to add and remove reactions on the triggering comment (changesets/action) issues: write
pull-requests: read # to inspect the pull request head state (changesets/action) pull-requests: read
steps: steps:
- id: report_in_progress - id: report_in_progress
run: | run: |
in_progress_reaction_id=$(gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='eyes' --jq '.id') echo "in_progress_reaction_id=$(gh api /repos/${{github.repository}}/issues/comments/${{github.event.comment.id}}/reactions -f content='eyes' --jq '.id')" >> "$GITHUB_OUTPUT"
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: |
@@ -46,7 +35,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
@@ -61,7 +50,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/$GH_REPO/pulls/$ISSUE_NUMBER/commits" --paginate --jq '.[].sha' | gh api /repos/${{ github.repository }}/pulls/${{ github.event.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 }'
) )
@@ -78,7 +67,7 @@ jobs:
fi fi
resolved_sha="${matches[0]}" resolved_sha="${matches[0]}"
pr_head_sha=$(gh pr view "$ISSUE_NUMBER" --json headRefOid --jq '.headRefOid') pr_head_sha=$(gh pr view ${{ github.event.issue.number }} --json headRefOid --jq '.headRefOid')
if [[ "$resolved_sha" != "$pr_head_sha" ]] if [[ "$resolved_sha" != "$pr_head_sha" ]]
then then
@@ -90,17 +79,13 @@ 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: |
head_repository=$(gh pr view "$ISSUE_NUMBER" --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name') echo "head_repository=$(gh pr view ${{ github.event.issue.number }} --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')" >> "$GITHUB_OUTPUT"
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 }}
@@ -110,132 +95,89 @@ 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 # to create the release commit and publish snapshot artifacts (changesets/action) contents: write
issues: write # to add and remove reactions on the triggering comment (changesets/action) issues: write
pull-requests: write # to comment on the pull request with the release result (changesets/action) pull-requests: write
steps: steps:
- uses: $/.github/actions/ci-setup - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: - uses: ./.github/actions/ci-setup
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: |
version_packages=$(gh pr view "$ISSUE_NUMBER" --json headRefName --jq '.headRefName|startswith("changeset-release/")') echo "version_packages=$(gh pr view ${{ github.event.issue.number }} --json headRefName --jq '.headRefName|startswith("changeset-release/")')" >> "$GITHUB_OUTPUT"
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
- name: Create snapshot version - run: yarn changeset version --snapshot pr${{ github.event.issue.number }}
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: pnpm build run: yarn build
- uses: $/.github/actions/setup-bot-auth - name: Setup Git user
id: bot-auth run: |
with: git config --global user.name "github-actions[bot]"
client-id: ${{ vars.APP_CLIENT_ID }} git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
private-key: ${{ secrets.APP_PRIVATE_KEY }}
permission-contents: write # to push the release snapshot branch (release-pr.ts)
- name: Release snapshot version - name: Release snapshot version
run: pnpm release:pr run: yarn run release:pr
env:
GITHUB_TOKEN: ${{ steps.bot-auth.outputs.token }}
- name: Add success reaction - run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='rocket'
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 }}
- name: Remove in-progress reaction - run: gh api -X DELETE /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions/${{ needs.release_check.outputs.in_progress_reaction_id }}
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 }}
- name: Comment success - run: |
run: | 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))."
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 # to add and remove reactions on the triggering comment (changesets/action) issues: write
pull-requests: write # to comment on the pull request with the failure result (changesets/action) pull-requests: write
steps: steps:
- name: Add failure reaction - run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='-1'
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='-1'
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction - run: gh api -X DELETE /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions/${{ needs.release_check.outputs.in_progress_reaction_id }}
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 }}
- name: Comment failure - run: |
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 }})."
body="The release for \`$REQUESTED_SHA\` triggered by [this comment]($COMMENT_URL) has [failed]($RUN_URL)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }} 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 }}
-1
View File
@@ -2,6 +2,5 @@ node_modules
.parcel-cache .parcel-cache
.cache .cache
*.log *.log
.env
dist/ dist/
+1 -1
View File
@@ -1 +1 @@
24.22.1 v24.11.0
-7
View File
@@ -1,7 +0,0 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"printWidth": 80,
"sortImports": {
"newlinesBetween": false
}
}
+1 -1
View File
@@ -1,4 +1,5 @@
{ {
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
@@ -6,7 +7,6 @@
"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,
+1 -2
View File
@@ -1,4 +1,3 @@
{ {
"js/ts.tsdk.path": "node_modules/typescript/lib", "typescript.tsdk": "node_modules/typescript/lib"
"editor.defaultFormatter": "oxc.oxc-vscode"
} }
-196
View File
@@ -1,201 +1,5 @@
# @changesets/action # @changesets/action
## 2.1.2
### Patch Changes
- [#735](https://github.com/changesets/action/pull/735) [`8833883`](https://github.com/changesets/action/commit/88338839e35c3e0fa61f3c9c3f27e7572cd5f2cf) Thanks [@bluwy](https://github.com/bluwy)! - Handle error when pushing git tags with the git CLI
- [#724](https://github.com/changesets/action/pull/724) [`36f529f`](https://github.com/changesets/action/commit/36f529f13ab58bbcf6331035cb950385586e8a89) Thanks [@bluwy](https://github.com/bluwy)! - Improve log messages
- [#724](https://github.com/changesets/action/pull/724) [`36f529f`](https://github.com/changesets/action/commit/36f529f13ab58bbcf6331035cb950385586e8a89) Thanks [@bluwy](https://github.com/bluwy)! - Fix root action double error logs
- [#729](https://github.com/changesets/action/pull/729) [`ca85897`](https://github.com/changesets/action/commit/ca8589735af2ff6977a0f6474537d550040530d8) Thanks [@bluwy](https://github.com/bluwy)! - Always switch and reset branch when generating version commits, similar to if `push-with-git-cli` is enabled
## 2.1.1
### Patch Changes
- [#721](https://github.com/changesets/action/pull/721) [`da1ea29`](https://github.com/changesets/action/commit/da1ea291ef93203a08fad360eac36f4858dd0514) Thanks [@KEBABSELLER6](https://github.com/KEBABSELLER6)! - Fixed typo in renamed inputs from v1 to v2
## 2.1.0
### Minor Changes
- [#718](https://github.com/changesets/action/pull/718) [`3b7c71c`](https://github.com/changesets/action/commit/3b7c71c440e75fca5d335f779290425fc1117fe8) Thanks [@bluwy](https://github.com/bluwy)! - Add a `cwd` input to the root action, `/select-mode`, `/version`, `/pack`, and `/publish` sub-actions to set the current working directory to execute Changesets in. This input existed in v1 but was incorrectly removed.
### Patch Changes
- [#716](https://github.com/changesets/action/pull/716) [`6f58ba3`](https://github.com/changesets/action/commit/6f58ba35801ec075a1c87569277591f8ef1a3029) Thanks [@bluwy](https://github.com/bluwy)! - Update `pr-status` message to link to the new faq page
## 2.0.0
### Major Changes
- [#692](https://github.com/changesets/action/pull/692) [`cb3f011`](https://github.com/changesets/action/commit/cb3f0110d7423cd340b1c5d63584c0ea6ee63959) Thanks [@Andarist](https://github.com/Andarist)! - Release commits and tags are now pushed using the GitHub API by default.
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
- [#680](https://github.com/changesets/action/pull/680) [`ca57073`](https://github.com/changesets/action/commit/ca57073900dc678254406a052a03c0c8824e319d) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
- [#657](https://github.com/changesets/action/pull/657) [`4f718b5`](https://github.com/changesets/action/commit/4f718b5921490b1efeb015a81abb6a4633892851) Thanks [@Andarist](https://github.com/Andarist)! - Removed compatibility support for old Changesets v1.
- [#681](https://github.com/changesets/action/pull/681) [`7359107`](https://github.com/changesets/action/commit/73591071e61c7f61cf322dd7a6341dc29a8e1d4e) Thanks [@bluwy](https://github.com/bluwy)! - Rename the root action inputs and outputs to better match the sub-actions' conventions.
Inputs:
- `version` -> `version-script`
- `publish` -> `publish-script`
- `commit` -> `commit-message`
- `title` -> `pr-title`
- `branch` -> `pr-base-branch`
Outputs:
- `pull-request-number` -> `pr-number`
- [#674](https://github.com/changesets/action/pull/674) [`164652b`](https://github.com/changesets/action/commit/164652bdd60525670d95291addb8c6f92833ac60) Thanks [@bluwy](https://github.com/bluwy)! - Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
- [#659](https://github.com/changesets/action/pull/659) [`5649ff4`](https://github.com/changesets/action/commit/5649ff41b8eb1b7a281011e45df781c6d4628fd0) Thanks [@bluwy](https://github.com/bluwy)! - Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
- [#673](https://github.com/changesets/action/pull/673) [`823cf74`](https://github.com/changesets/action/commit/823cf741ca57c5e22652123d3a847dfafcd77ca0) Thanks [@bluwy](https://github.com/bluwy)! - Update to Changesets v3 packages
- [#695](https://github.com/changesets/action/pull/695) [`469993c`](https://github.com/changesets/action/commit/469993ce5783c6a38e72541d4ba0d25588702b9a) Thanks [@bluwy](https://github.com/bluwy)! - Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
- [#668](https://github.com/changesets/action/pull/668) [`0eae789`](https://github.com/changesets/action/commit/0eae789230defbc4ad287e9b476aba7e842e34e0) Thanks [@bluwy](https://github.com/bluwy)! - Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
### Minor Changes
- [#656](https://github.com/changesets/action/pull/656) [`a12d90d`](https://github.com/changesets/action/commit/a12d90de8394e63c952622b2fd3f98c8729c48b0) Thanks [@bluwy](https://github.com/bluwy)! - Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
- [#678](https://github.com/changesets/action/pull/678) [`f71ae04`](https://github.com/changesets/action/commit/f71ae043ed5deb17952900091e009a60edef9507) Thanks [@Andarist](https://github.com/Andarist)! - Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
### Patch Changes
- [#699](https://github.com/changesets/action/pull/699) [`5b307d3`](https://github.com/changesets/action/commit/5b307d3df25daf51c41dff70d2f66df1579ae9fa) Thanks [@Andarist](https://github.com/Andarist)! - Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
- [#697](https://github.com/changesets/action/pull/697) [`84d78c6`](https://github.com/changesets/action/commit/84d78c68f98f20e24dfff22b22193e7b4f326ad9) Thanks [@Andarist](https://github.com/Andarist)! - Allow custom publish scripts to complete without a Changesets output file, warning that GitHub releases and git tags cannot be created when that file is missing.
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
- [#688](https://github.com/changesets/action/pull/688) [`219ea82`](https://github.com/changesets/action/commit/219ea82e52caaff2a10a5e34d3455093cf958238) Thanks [@Andarist](https://github.com/Andarist)! - Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
## 2.0.0-next.5
### Patch Changes
- [#711](https://github.com/changesets/action/pull/711) [`5fa6767`](https://github.com/changesets/action/commit/5fa67671df41b7a8a9d8123e8e446b1a8ad423db) Thanks [@Andarist](https://github.com/Andarist)! - Fix support for prerelease exits using the new `.changeset/pre` layout.
## 2.0.0-next.4
### Major Changes
- [#692](https://github.com/changesets/action/pull/692) [`cb3f011`](https://github.com/changesets/action/commit/cb3f0110d7423cd340b1c5d63584c0ea6ee63959) Thanks [@Andarist](https://github.com/Andarist)! - Release commits and tags are now pushed using the GitHub API by default.
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
- [#695](https://github.com/changesets/action/pull/695) [`469993c`](https://github.com/changesets/action/commit/469993ce5783c6a38e72541d4ba0d25588702b9a) Thanks [@bluwy](https://github.com/bluwy)! - Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
### Patch Changes
- [#699](https://github.com/changesets/action/pull/699) [`5b307d3`](https://github.com/changesets/action/commit/5b307d3df25daf51c41dff70d2f66df1579ae9fa) Thanks [@Andarist](https://github.com/Andarist)! - Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
- [#697](https://github.com/changesets/action/pull/697) [`84d78c6`](https://github.com/changesets/action/commit/84d78c68f98f20e24dfff22b22193e7b4f326ad9) Thanks [@Andarist](https://github.com/Andarist)! - Allow custom publish scripts to complete without a Changesets output file, warning that GitHub releases and git tags cannot be created when that file is missing.
- [#705](https://github.com/changesets/action/pull/705) [`77be81b`](https://github.com/changesets/action/commit/77be81bcb9d2d1007c53c4f98bffe51da428d6a5) Thanks [@Andarist](https://github.com/Andarist)! - Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates when using GitHub API pushes.
- [#688](https://github.com/changesets/action/pull/688) [`219ea82`](https://github.com/changesets/action/commit/219ea82e52caaff2a10a5e34d3455093cf958238) Thanks [@Andarist](https://github.com/Andarist)! - Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
## 2.0.0-next.3
### Major Changes
- [#680](https://github.com/changesets/action/pull/680) [`ca57073`](https://github.com/changesets/action/commit/ca57073900dc678254406a052a03c0c8824e319d) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
- [#681](https://github.com/changesets/action/pull/681) [`7359107`](https://github.com/changesets/action/commit/73591071e61c7f61cf322dd7a6341dc29a8e1d4e) Thanks [@bluwy](https://github.com/bluwy)! - Rename the root action inputs and outputs to better match the sub-actions' conventions.
Inputs:
- `version` -> `version-script`
- `publish` -> `publish-script`
- `commit` -> `commit-message`
- `title` -> `pr-title`
- `branch` -> `pr-base-branch`
Outputs:
- `pull-request-number` -> `pr-number`
- [#674](https://github.com/changesets/action/pull/674) [`164652b`](https://github.com/changesets/action/commit/164652bdd60525670d95291addb8c6f92833ac60) Thanks [@bluwy](https://github.com/bluwy)! - Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
- [#673](https://github.com/changesets/action/pull/673) [`823cf74`](https://github.com/changesets/action/commit/823cf741ca57c5e22652123d3a847dfafcd77ca0) Thanks [@bluwy](https://github.com/bluwy)! - Update to Changesets v3 packages
- [#668](https://github.com/changesets/action/pull/668) [`0eae789`](https://github.com/changesets/action/commit/0eae789230defbc4ad287e9b476aba7e842e34e0) Thanks [@bluwy](https://github.com/bluwy)! - Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
### Minor Changes
- [#678](https://github.com/changesets/action/pull/678) [`f71ae04`](https://github.com/changesets/action/commit/f71ae043ed5deb17952900091e009a60edef9507) Thanks [@Andarist](https://github.com/Andarist)! - Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
## 2.0.0-next.2
### Patch Changes
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
## 2.0.0-next.1
### Patch Changes
- [#663](https://github.com/changesets/action/pull/663) [`ccb3811`](https://github.com/changesets/action/commit/ccb38113eaaa4a13eb6aabe09520e49cc8519b84) Thanks [@Andarist](https://github.com/Andarist)! - Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
- [#662](https://github.com/changesets/action/pull/662) [`5c88881`](https://github.com/changesets/action/commit/5c88881fff1f0d8b055d4a2d3a74a8ce843db6f3) Thanks [@Andarist](https://github.com/Andarist)! - Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
- [#666](https://github.com/changesets/action/pull/666) [`dc29b73`](https://github.com/changesets/action/commit/dc29b738b532d9e95f46b9bf493e2e3fdf48a7ed) Thanks [@Andarist](https://github.com/Andarist)! - Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
## 2.0.0-next.0
### Major Changes
- [#657](https://github.com/changesets/action/pull/657) [`4f718b5`](https://github.com/changesets/action/commit/4f718b5921490b1efeb015a81abb6a4633892851) Thanks [@Andarist](https://github.com/Andarist)! - Removed compatibility support for old Changesets v1.
- [#659](https://github.com/changesets/action/pull/659) [`5649ff4`](https://github.com/changesets/action/commit/5649ff41b8eb1b7a281011e45df781c6d4628fd0) Thanks [@bluwy](https://github.com/bluwy)! - Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
### Minor Changes
- [#656](https://github.com/changesets/action/pull/656) [`a12d90d`](https://github.com/changesets/action/commit/a12d90de8394e63c952622b2fd3f98c8729c48b0) Thanks [@bluwy](https://github.com/bluwy)! - Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
## 1.9.0
### Minor Changes
- [#636](https://github.com/changesets/action/pull/636) [`b072bcc`](https://github.com/changesets/action/commit/b072bccc4c664a373c42168eed9139dce1e003b1) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-comment` sub-action to comment on PRs
- [#625](https://github.com/changesets/action/pull/625) [`8795eee`](https://github.com/changesets/action/commit/8795eee5eee884e887d352ac673a515ffe35aaa6) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-status` sub-action to generate the changeset status comment for PRs as an alternative to the [Changesets Bot](https://github.com/apps/changeset-bot).
### Patch Changes
- [#535](https://github.com/changesets/action/pull/535) [`34f64f6`](https://github.com/changesets/action/commit/34f64f6e2e1e47ddc183f174aa27c197aa47f520) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with GitHub releases not being created for successfully published packages when _some_ packages failed to be published to the registry.
- [#632](https://github.com/changesets/action/pull/632) [`1d54b9e`](https://github.com/changesets/action/commit/1d54b9e660e435237accbcae0b4581af3be641b4) Thanks [@bluwy](https://github.com/bluwy)! - Simplify internal implementation to get changelog entries for a package version
- [#629](https://github.com/changesets/action/pull/629) [`e0c90aa`](https://github.com/changesets/action/commit/e0c90aa7fbd0cc26931a679c5abe9bbc0deb0b50) Thanks [@bluwy](https://github.com/bluwy)! - Fix custom version and publish command argument parsing
- [#645](https://github.com/changesets/action/pull/645) [`f9585d9`](https://github.com/changesets/action/commit/f9585d966a9c7d2f668b97199990de6f885823cf) Thanks [@Andarist](https://github.com/Andarist)! - Improved force-push handling when using `commitMode: "github-api"` so updating an existing branch no longer temporarily resets the target branch to the base commit, avoiding cases where GitHub closes open pull requests during the update. This should remove a possibility of a GitHub state race that caused the force-pushed PRs not being reopened.
## 1.8.0 ## 1.8.0
### Minor Changes ### Minor Changes
+194 -59
View File
@@ -1,77 +1,212 @@
# Changesets GitHub Action # Changesets Release Action
> [!IMPORTANT] 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 is the development branch for `changesets/action` v2 compatible with Changesets v3. For the v1 code compatible with Changesets v2, check out the [`maintenance/v1`](https://github.com/changesets/action/tree/maintenance/v1) branch.
This repo contains a collection of GitHub Actions for [Changesets](https://changesets.dev). Check out the [Automating Changesets](https://changesets.dev/guide/automating) guide to learn how to use these actions to automate your workflow. ## Usage
- [changesets/action](./README.md): (This README. See below for details.) ### Inputs
- [changesets/action/select-mode](./select-mode/README.md): Select the mode to run a Changesets workflow.
- [changesets/action/version](./version/README.md): Version packages and create or update a pull request with the changes.
- [changesets/action/pack](./pack/README.md): Pack publishable packages into tarballs.
- [changesets/action/publish](./publish/README.md): Publish packages to npm.
- [changesets/action/pr-status](./pr-status/README.md): Generate changeset status in PRs.
- [changesets/action/pr-comment](./pr-comment/README.md): Create or update comments on PRs.
## changesets/action - publish - The command to use to build and publish packages
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- commit - The commit message to use. Default to `Version Packages`
- title - The pull request title. Default to `Version Packages`
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
This action handles versioning and publishing of packages. It's the equivalent of setting up the `changesets/action/select-mode`, `changesets/action/version`, and `changesets/action/publish` actions in a workflow, but with the required permissions combined. ### Outputs
If using [trusted publishing](https://docs.npmjs.com/trusted-publishers), it's recommended to set up the individual sub-actions instead to tighten publish permissions. - 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"}]`
### Requirements ### Example workflow:
- Needs repo checked out and `@changesets/cli` installed #### Without Publishing
- [Job permissions][job-permissions]:
- `contents: write`: to commit version changes
- `pull-requests: write`: to create pull request
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
- [Workflow triggers][workflow-triggers]: _any_
> [!NOTE] Create a file at `.github/workflows/release.yml` with the following content.
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
### Usage ```yml
name: Release
> [!TIP] on:
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow. push:
branches:
- main
> [!IMPORTANT] concurrency: ${{ github.workflow }}-${{ github.ref }}
> To use a custom GitHub token, pass it explicitly through the `github-token` input:
>
> ```yaml
> with:
> github-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
> ```
>
> Setting the `GITHUB_TOKEN` environment variable does not configure the action. This applies whether release changes are pushed using the GitHub API or the Git CLI.
### API jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
<!-- api-start --> - name: Setup Node.js 20
uses: actions/setup-node@v3
with:
node-version: 20
| Inputs | Description | - name: Install Dependencies
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | run: yarn
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
| `publish-script` | The command to use to build and publish packages |
| `version-script` | The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided |
| `commit-message` | The commit message. Default to `Version Packages` |
| `pr-title` | The pull request title. Default to `Version Packages` |
| `pr-draft` | Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them. |
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
| `create-github-releases` | Whether to create Github releases after publish |
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits and tags. Defaults to `false`. When using the GitHub API, commits and tags are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
| Outputs | Description | - name: Create Release Pull Request
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | uses: changesets/action@v1
| `published` | A "true" or "false" string value to indicate whether a publishing is happened or not | ```
| `published-packages` | A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` |
| `has-changesets` | A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality. |
| `pr-number` | The pull request number that was created or updated |
<!-- api-end --> #### With Publishing
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions Before you can setup this action with publishing, you'll need to have an [npm token](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) that can publish the packages in the repo you're setting up the action for and doesn't have 2FA on publish enabled ([2FA on auth can be enabled](https://docs.npmjs.com/about-two-factor-authentication)). You'll also need to [add it as a secret on your GitHub repo](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) with the name `NPM_TOKEN`. Once you've done that, you can create a file at `.github/workflows/release.yml` with the following content.
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
```yml
name: Release
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Setup Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x
- name: Install Dependencies
run: yarn
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
# This expects you to have a script called release which does a build for your packages and calls changeset publish
publish: yarn release
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Send a Slack notification if a publish happens
if: steps.changesets.outputs.published == 'true'
# You can do something when a publish happens.
run: my-slack-bot send-notification --message "A new version of ${GITHUB_REPOSITORY} was published!"
```
By default the GitHub Action creates a `.npmrc` file with the following content:
```
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
```
However, if a `.npmrc` file is found, the GitHub Action does not recreate the file. This is useful if you need to configure the `.npmrc` file on your own.
For example, you can add a step before running the Changesets GitHub Action:
```yml
- name: Creating .npmrc
run: |
cat << EOF > "$HOME/.npmrc"
//registry.npmjs.org/:_authToken=$NPM_TOKEN
EOF
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
#### Custom Publishing
If you want to hook into when publishing should occur but have your own publishing functionality, you can utilize the `hasChangesets` output.
Note that you might need to account for things already being published in your script because a commit without any new changesets can always land on your base branch after a successful publish. In such a case you need to figure out on your own how to skip over the actual publishing logic or handle errors gracefully as most package registries won't allow you to publish over already published version.
```yml
name: Release
on:
push:
branches:
- main
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Setup Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x
- name: Install Dependencies
run: yarn
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
- name: Publish
if: steps.changesets.outputs.hasChangesets == 'false'
# You can do something when a publish should happen.
run: yarn publish
```
#### With version script
If you need to add additional logic to the version command, you can do so by using a version script.
If the version script is present, this action will run that script instead of `changeset version`, so please make sure that your script calls `changeset version` at some point. All the changes made by the script will be included in the PR.
```yml
name: Release
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Setup Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x
- name: Install Dependencies
run: yarn
- name: Create Release Pull Request
uses: changesets/action@v1
with:
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
version: yarn version
```
#### With Yarn 2 / Plug'n'Play
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI:
```yaml
- uses: changesets/action@v1
with:
version: yarn changeset version
...
```
@@ -0,0 +1,4 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json",
"ignore": ["ignored-package-pkg-a"]
}
@@ -0,0 +1,8 @@
{
"private": true,
"name": "ignored-package",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -0,0 +1,7 @@
{
"name": "ignored-package-pkg-a",
"version": "1.0.0",
"dependencies": {
"ignored-package-pkg-b": "1.0.0"
}
}
@@ -0,0 +1,4 @@
{
"name": "ignored-package-pkg-b",
"version": "1.0.0"
}
@@ -0,0 +1,3 @@
{
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json"
}
+8
View File
@@ -0,0 +1,8 @@
{
"private": true,
"name": "simple-project",
"version": "1.0.0",
"workspaces": [
"packages/*"
]
}
@@ -0,0 +1,7 @@
{
"name": "simple-project-pkg-a",
"version": "1.0.0",
"dependencies": {
"simple-project-pkg-b": "1.0.0"
}
}
@@ -0,0 +1,4 @@
{
"name": "simple-project-pkg-b",
"version": "1.0.0"
}
+38 -42
View File
@@ -5,60 +5,56 @@ runs:
main: "dist/index.js" main: "dist/index.js"
inputs: inputs:
github-token: github-token:
description: > description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
To use a custom token, pass it explicitly to this input.
required: false required: false
default: ${{ github.token }} default: ${{ github.token }}
publish-script: publish:
description: "The command to use to build and publish packages" description: "The command to use to build and publish packages"
required: false required: false
version-script: version:
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided" description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
required: false required: false
commit-message:
description: "The commit message. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-title:
description: "The pull request title. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-draft:
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
required: false
pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false
create-github-releases:
description: "Whether to create Github releases after publish"
required: false
default: true
push-git-tags:
description: >
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
this option will also always be `true`.
required: false
default: true
push-with-git-cli:
description: >
Whether to use the Git CLI instead of the GitHub API to push release commits and tags.
Defaults to `false`. When using the GitHub API, commits and tags are signed using
GitHub's GPG key and attributed to the user or app that owns the `github-token`.
required: false
default: false
cwd: cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository." description: Sets the cwd for the node process. Default to `process.cwd()`
required: false
commit:
description: |
The commit message. Default to `Version Packages`
required: false
title:
description: The pull request title. Default to `Version Packages`
required: false
setupGitUser:
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
required: false
default: true
createGithubReleases:
description: "A boolean value to indicate whether to create Github releases after `publish` or not"
required: false
default: true
commitMode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
all commits and tags are signed using GitHub's GPG key and attributed to the user
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
branch:
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
required: false
prDraft:
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
required: false required: false
outputs: outputs:
published: published:
description: A "true" or "false" string value to indicate whether a publishing is happened or not description: A boolean value to indicate whether a publishing is happened or not
published-packages: publishedPackages:
description: > description: >
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
has-changesets: hasChangesets:
description: A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality. description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
pr-number: pullRequestNumber:
description: The pull request number that was created or updated description: The pull request number that was created or updated
branding: branding:
icon: "package" icon: "package"
+61
View File
File diff suppressed because one or more lines are too long
-32
View File
@@ -1,32 +0,0 @@
# changesets/action/pack
This action packs publishable packages into tarballs, complements [changesets/action/publish](../publish/README.md) to publish them in a later step.
## Requirements
- Needs repo checked out and `@changesets/cli` installed
- [Job permissions][job-permissions]: _none_
- [Workflow triggers][workflow-triggers]: _any_
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
## API
<!-- api-start -->
| Inputs | Description |
| -------------------------- | --------------------------------------------------------------------------------------- |
| `publish-plan-artifact-id` | Artifact id for a publish plan generated by the select-mode subaction |
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
| Outputs | Description |
| ---------------------- | ------------------------------------------- |
| `pack-dir-artifact-id` | Artifact id for the packed output directory |
<!-- api-end -->
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
-18
View File
@@ -1,18 +0,0 @@
name: Changesets - Pack
description: Pack publishable packages into tarballs
runs:
using: node24
main: ../dist/pack.js
inputs:
publish-plan-artifact-id:
description: "Artifact id for a publish plan generated by the select-mode subaction"
required: false
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs:
pack-dir-artifact-id:
description: "Artifact id for the packed output directory"
branding:
icon: package
color: blue
+56 -49
View File
@@ -1,58 +1,65 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "2.1.2", "version": "1.8.0",
"private": true,
"license": "MIT",
"type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "type": "module",
"build": "rolldown -c", "license": "MIT",
"test": "vitest",
"test:watch": "pnpm test --watch",
"typecheck": "tsc",
"format": "oxfmt --check",
"format:fix": "oxfmt",
"changeset": "changeset",
"bump": "node ./scripts/bump.ts",
"update-readme": "node ./scripts/update-readme.ts",
"release": "node ./scripts/release.ts",
"release:pr": "node ./scripts/release-pr.ts"
},
"dependencies": {
"@actions/artifact": "^6.2.1",
"@actions/core": "^3.0.1",
"@actions/exec": "^3.0.0",
"@actions/github": "^9.1.1",
"@changesets/get-release-plan": "^5.0.2",
"@changesets/ghcommit": "^3.0.0",
"@changesets/git": "^4.0.1",
"@changesets/pre": "^3.0.0",
"@changesets/read": "^1.0.1",
"@manypkg/get-packages": "^3.1.0",
"@octokit/core": "^7.0.8",
"@octokit/plugin-throttling": "^11.0.5",
"human-id": "^4.2.1",
"markdown-table": "^3.0.4",
"semver": "^7.8.5",
"tinyexec": "^1.3.1"
},
"devDependencies": { "devDependencies": {
"@changesets/changelog-github": "^1.0.1", "@changesets/changelog-github": "^0.5.1",
"@changesets/cli": "^3.0.3", "@changesets/cli": "^2.29.3",
"@changesets/types": "^7.0.0", "@changesets/write": "^0.4.0",
"@changesets/write": "^1.0.1", "@rollup/plugin-commonjs": "^28.0.3",
"@tsconfig/node24": "^24.0.5", "@rollup/plugin-json": "^6.1.0",
"@types/node": "^26.6.2", "@rollup/plugin-node-resolve": "^16.0.1",
"@types/semver": "^7.8.0", "@rollup/plugin-terser": "^0.4.4",
"fs-fixture": "^2.16.0", "@types/node": "^22.15.17",
"oxfmt": "^0.70.0", "@types/semver": "^7.5.0",
"rolldown": "^1.2.10", "builtin-modules": "^5.0.0",
"typescript": "^7.0.2", "esbuild": "^0.25.4",
"vitest": "^5.0.1", "fixturez": "^1.1.0",
"yaml": "^2.9.1" "husky": "^3.0.3",
"prettier": "^2.0.5",
"rollup": "^4.40.2",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
},
"scripts": {
"build": "rollup -c",
"test": "vitest",
"test:watch": "yarn test --watch",
"typecheck": "tsc",
"changeset": "changeset",
"bump": "node --experimental-strip-types ./scripts/bump.ts",
"release": "node --experimental-strip-types ./scripts/release.ts",
"release:pr": "node --experimental-strip-types ./scripts/release-pr.ts"
}, },
"engines": { "engines": {
"node": ">= 24" "node": ">= 24"
}, },
"packageManager": "pnpm@11.20.0+sha512.9a6f330a95b66446ea088faf1521405a8a01f07fde7124cc9958dfed52d4bb436737e65b08f85f37b46fcba375092558ac51262b816844b22f63406ed166bfee" "dependencies": {
"@actions/core": "^1.11.1",
"@actions/exec": "^1.1.1",
"@actions/github": "^6.0.1",
"@changesets/ghcommit": "^2.0.1",
"@changesets/pre": "^2.0.2",
"@changesets/read": "^0.6.5",
"@manypkg/get-packages": "^1.1.3",
"@octokit/core": "^5.2.1",
"@octokit/plugin-throttling": "^8.0.0",
"@types/mdast": "^3.0.0",
"mdast-util-to-string": "^1.0.6",
"remark-parse": "^7.0.1",
"remark-stringify": "^7.0.3",
"semver": "^7.5.3",
"unified": "^8.3.2"
},
"husky": {
"hooks": {}
},
"prettier": {},
"resolutions": {
"trim": "^0.0.3",
"y18n": "^4.0.1"
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
} }
-2758
View File
File diff suppressed because it is too large Load Diff
-30
View File
@@ -1,30 +0,0 @@
blockExoticSubdeps: true
dedupePeers: true
dedupePeerDependents: true
minimumReleaseAge: 10080
minimumReleaseAgeExclude:
- "@changesets/apply-release-plan@8.0.0"
- "@changesets/assemble-release-plan@7.0.0"
- "@changesets/changelog-git@1.0.0"
- "@changesets/changelog-github@1.0.0"
- "@changesets/cli@3.0.0"
- "@changesets/config@4.0.0"
- "@changesets/errors@1.0.0"
- "@changesets/get-dependents-graph@3.0.0"
- "@changesets/get-github-info@1.0.0"
- "@changesets/get-release-plan@5.0.0"
- "@changesets/git@4.0.0"
- "@changesets/parse@1.0.0"
- "@changesets/pre@3.0.0"
- "@changesets/read@1.0.0"
- "@changesets/should-skip-package@1.0.0"
- "@changesets/types@7.0.0"
- "@changesets/write@1.0.0"
- "vite@8.2.0"
overrides:
lightningcss: "-" # we do not bundle any css
postcss: "-" # we do not bundle any css
shellEmulator: true
trustPolicy: no-downgrade
-89
View File
@@ -1,89 +0,0 @@
# changesets/action/pr-comment
This action creates or updates comments on PRs, aimed to complement [changesets/action/pr-status](../pr-status/README.md).
Its features are kept intentionally simple. For advanced usecases, check out other actions such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
## Requirements
- [Job permissions][job-permissions]:
- `pull-requests: write`: to create and update comments on PRs
- [Workflow triggers][workflow-triggers]:
- [`pull_request`][trigger-pull-request]
- [`pull_request_target`][trigger-pull-request-target]
> [!CAUTION]
> **Do not run untrusted code** when using the `pull_request_target` event.
>
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
```yaml
on:
pull_request:
jobs:
pr-comment:
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs (changesets/action/pr-comment)
steps:
- name: Comment on PR
uses: changesets/action/pr-comment@v2
with:
body: Hello world!
```
If the action is called again for the same PR, for example, if called in another workflow run, it will update the comment it created by default.
If you use the action to create different types of comments, pass an `update-id` value to differentiate them.
```yaml
jobs:
pr-comment:
# ...
steps:
- name: Comment on PR
uses: changesets/action/pr-comment@v2
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@v2
with:
body: Hello world!
update-id: ""
```
## API
<!-- api-start -->
| Inputs | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
| `body` | **Required.** The comment body to post on the PR. |
| `update-id` | By default, the action will create and update a comment with this id. Pass a different id to create and update a new comment, or pass an empty string to disable updating comments. |
| Outputs | Description |
| ------------ | ---------------------------------------------------------- |
| `comment-id` | The comment id of the comment that was created or updated. |
<!-- api-end -->
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
[trigger-pull-request-target]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
-27
View File
@@ -1,27 +0,0 @@
name: Changesets - PR Comment
description: Create or update comments on PRs
runs:
using: node24
main: ../dist/pr-comment.js
inputs:
github-token:
description: >
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
To use a custom token, pass it explicitly to this input.
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
-40
View File
@@ -1,40 +0,0 @@
# changesets/action/pr-status
This action generates the changesets status in PRs, for example, whether it has changeset files and which packages will be released if the PR is merged.
It requires the repo to be checked out, and will automatically fetch the PR head ref into a temporary detached worktree in order to infer the changed files and packages.
## Requirements
- Needs repo checked out
- [Job permissions][job-permissions]: _none_
- [Workflow triggers][workflow-triggers]:
- [`pull_request`][trigger-pull-request]
- [`pull_request_target`][trigger-pull-request-target]
> [!CAUTION]
> **Do not run untrusted code** when using the `pull_request_target` event.
>
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
[trigger-pull-request-target]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
## API
<!-- api-start -->
Inputs: _none_
| Outputs | Description |
| -------------- | ------------------------------------------------------------------- |
| `comment-body` | The generated comment body to present the changesets status in PRs. |
<!-- api-end -->
-12
View File
@@ -1,12 +0,0 @@
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
-38
View File
@@ -1,38 +0,0 @@
# changesets/action/publish
This action publishes packages to npm.
## Requirements
- Needs repo checked out and `@changesets/cli` installed
- [Job permissions][job-permissions]:
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
- [Workflow triggers][workflow-triggers]: _any_
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
## API
<!-- api-start -->
| Inputs | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
| `script` | The command to use to publish packages |
| `pack-dir-artifact-id` | Artifact id for packed publish output generated by the pack subaction |
| `create-github-releases` | Whether to create Github releases after publish |
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
| Outputs | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `published` | A "true" or "false" string value to indicate whether a publishing has happened or not |
| `published-packages` | A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` |
<!-- api-end -->
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
-40
View File
@@ -1,40 +0,0 @@
name: Changesets - Publish
description: Publish packages to npm
runs:
using: node24
main: ../dist/publish.js
inputs:
github-token:
description: >
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
To use a custom token, pass it explicitly to this input.
required: false
default: ${{ github.token }}
script:
description: "The command to use to publish packages"
required: false
pack-dir-artifact-id:
description: "Artifact id for packed publish output generated by the pack subaction"
required: false
create-github-releases:
description: "Whether to create Github releases after publish"
required: false
default: true
push-git-tags:
description: >
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
this option will also always be `true`.
required: false
default: true
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs:
published:
description: A "true" or "false" string value to indicate whether a publishing has happened or not
published-packages:
description: >
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
branding:
icon: package
color: blue
-21
View File
@@ -1,21 +0,0 @@
import { defineConfig } from "rolldown";
export default defineConfig({
input: {
index: "src/index.ts",
pack: "src/pack/index.ts",
"pr-status": "src/pr-status/index.ts",
"pr-comment": "src/pr-comment/index.ts",
"select-mode": "src/select-mode/index.ts",
version: "src/version/index.ts",
publish: "src/publish/index.ts",
},
output: {
dir: "dist",
format: "esm",
cleanDir: true,
minify: true,
comments: false,
},
platform: "node",
});
+38
View File
@@ -0,0 +1,38 @@
import { defineConfig } from "rollup";
import commonjs from "@rollup/plugin-commonjs";
import nodeResolve from "@rollup/plugin-node-resolve";
import terser from "@rollup/plugin-terser";
import json from "@rollup/plugin-json";
import { transform } from "esbuild";
import builtinModulesList from "builtin-modules";
const builtinModules = new Set(builtinModulesList);
export default defineConfig({
input: "src/index.ts",
output: {
dir: "dist",
format: "esm",
},
external: (id) => builtinModules.has(id),
plugins: [
nodeResolve({
preferBuiltins: false,
}),
json(),
commonjs(),
{
name: "esbuild",
async transform(code, id) {
if (!/\.(mts|cts|ts|tsx)$/.test(id)) {
return null;
}
const result = await transform(code, {
loader: "ts",
});
return result.code;
},
},
terser(),
],
});
+3 -5
View File
@@ -1,20 +1,18 @@
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" };
process.chdir(path.join(import.meta.dirname, "..")); process.chdir(path.join(import.meta.dirname, ".."));
await exec("changeset", ["version"]); await exec("changeset", ["version"]);
// read after versioning to get the new version
const pkgJson = (await import("../package.json", { with: { type: "json" } }))
.default;
const releaseLine = `v${pkgJson.version.split(".")[0]}`; const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const readmePath = path.join(import.meta.dirname, "..", "README.md"); 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);
+8 -20
View File
@@ -1,21 +1,10 @@
import { Buffer } from "node:buffer";
import path from "node:path";
import { exec } from "@actions/exec"; import { exec } from "@actions/exec";
import path from "node:path";
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}`;
const releaseLine = "pr-release"; const releaseLine = "pr-release";
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, "..")); process.chdir(path.join(import.meta.dirname, ".."));
@@ -23,10 +12,9 @@ await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]); await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]); await exec("git", ["commit", "-m", tag]);
await exec( await exec("git", [
"git", "push",
["push", "--force", "origin", `HEAD:refs/heads/${releaseLine}`], "--force",
{ "origin",
env: gitEnv, `HEAD:refs/heads/${releaseLine}`,
}, ]);
);
+24 -29
View File
@@ -1,47 +1,42 @@
import { Buffer } from "node:buffer"; import { exec, getExecOutput } 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}`;
const releaseLine = `v${pkgJson.version.split(".")[0]}`; const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const isPrerelease = pkgJson.version.includes("-");
const githubToken = process.env.GITHUB_TOKEN;
if (!githubToken) {
throw new Error("GITHUB_TOKEN is required");
}
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
const gitEnv = {
...process.env,
GIT_CONFIG_COUNT: "1",
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
};
process.chdir(path.join(import.meta.dirname, "..")); process.chdir(path.join(import.meta.dirname, ".."));
(async () => {
const { exitCode, stderr } = await getExecOutput(
`git`,
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
{
ignoreReturnCode: true,
}
);
if (exitCode === 0) {
console.log(
`Action is not being published because version ${tag} is already published`
);
return;
}
if (exitCode !== 2) {
throw new Error(`git ls-remote exited with ${exitCode}:\n${stderr}`);
}
await exec("git", ["checkout", "--detach"]); await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]); await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]); await exec("git", ["commit", "-m", tag]);
await exec("changeset", ["git-tag"]); await exec("changeset", ["tag"]);
if (isPrerelease) { await exec("git", [
await exec("git", ["push", "origin", `refs/tags/${tag}`], {
env: gitEnv,
});
} else {
await exec(
"git",
[
"push", "push",
"--force", "--force",
"--follow-tags", "--follow-tags",
"origin", "origin",
`HEAD:refs/heads/${releaseLine}`, `HEAD:refs/heads/${releaseLine}`,
], ]);
{ })();
env: gitEnv,
},
);
}
-46
View File
@@ -1,46 +0,0 @@
import * as fs from "node:fs/promises";
import path from "node:path";
import { markdownTable } from "markdown-table";
import * as yaml from "yaml";
await main();
async function main() {
for await (const readmePath of fs.glob("**/README.md", {
exclude: ["**/node_modules/**"],
})) {
const actionPath = path.join(path.dirname(readmePath), "action.yml");
const actionExists = await fs.stat(actionPath).catch(() => null);
if (!actionExists) continue;
const action = yaml.parse(await fs.readFile(actionPath, "utf8"));
const inputs = action.inputs ?? {};
const outputs = action.outputs ?? {};
const content = [
renderSection("Inputs", inputs),
renderSection("Outputs", outputs),
].join("\n\n");
const readme = await fs.readFile(readmePath, "utf8");
const updated = readme.replace(
/<!-- api-start -->[\s\S]*?<!-- api-end -->/,
`<!-- api-start -->\n\n${content}\n\n<!-- api-end -->`,
);
await fs.writeFile(readmePath, updated);
}
}
function renderSection(title: string, entries: Record<string, any>) {
const rows: string[][] = [];
for (const [name, entry] of Object.entries(entries)) {
let description = (entry.description ?? "").trim().replace(/\|/g, "\\|");
if (entry.required) description = `**Required.** ${description}`;
rows.push([`\`${name}\``, description]);
}
if (rows.length === 0) {
return `${title}: _none_`;
}
rows.unshift([title, "Description"]);
return markdownTable(rows);
}
-35
View File
@@ -1,35 +0,0 @@
# changesets/action/select-mode
This action selects the mode to run a Changesets workflow:
- `"version"`: Changesets are found. The workflow should version packages and create a pull request with the changes.
- `"publish"`: No changesets are found and they are publishable packages. The workflow should publish them.
- `"none"`: No changesets are found and there are no publishable packages. The workflow should do nothing.
## Requirements
- [Job permissions][job-permissions]: _none_
- [Workflow triggers][workflow-triggers]: _any_
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
## API
<!-- api-start -->
| Inputs | Description |
| ------ | --------------------------------------------------------------------------------------- |
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
| Outputs | Description |
| -------------------------- | ---------------------------------------------------------------------------- |
| `mode` | The mode to use for the current repo state: 'version', 'publish', or 'none'. |
| `publish-plan-artifact-id` | Artifact id for the generated publish plan when mode is `publish` |
<!-- api-end -->
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
-17
View File
@@ -1,17 +0,0 @@
name: Changesets - Select Mode
description: Whether to version or publish in the current repo state
runs:
using: node24
main: ../dist/select-mode.js
inputs:
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs:
mode:
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
publish-plan-artifact-id:
description: "Artifact id for the generated publish plan when mode is `publish`"
branding:
icon: package
color: blue
+22 -15
View File
@@ -8,11 +8,12 @@ exports[`version > creates a draft PR when prDraft is "create" 1`] = `
# Releases # Releases
## changesets-dev-simple-project-pkg-a@1.1.0 ## 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",
@@ -30,7 +31,7 @@ exports[`version > creates simple PR 1`] = `
# Releases # Releases
## changesets-dev-simple-project-pkg-a@1.1.0 ## simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
@@ -39,12 +40,14 @@ exports[`version > creates simple PR 1`] = `
### Patch Changes ### Patch Changes
- Updated dependencies - Updated dependencies
- changesets-dev-simple-project-pkg-b@1.1.0 - 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",
@@ -84,7 +87,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.
## changesets-dev-simple-project-pkg-a@1.1.0 ## simple-project-pkg-a@1.1.0
", ",
"draft": false, "draft": false,
@@ -104,11 +107,12 @@ exports[`version > doesn't include ignored package that got a dependency update
# Releases # Releases
## changesets-dev-ignored-package-pkg-b@1.1.0 ## 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",
@@ -126,11 +130,12 @@ exports[`version > only includes bumped packages in the PR body 1`] = `
# Releases # Releases
## changesets-dev-simple-project-pkg-a@1.1.0 ## 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",
@@ -178,11 +183,12 @@ exports[`version > updates an existing PR via GraphQL and converts it to draft w
# Releases # Releases
## changesets-dev-simple-project-pkg-a@1.1.0 ## 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",
}, },
@@ -218,11 +224,12 @@ exports[`version > updates an existing PR via GraphQL without converting it to d
# Releases # Releases
## changesets-dev-simple-project-pkg-a@1.1.0 ## 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",
}, },
+4 -2
View File
@@ -31,7 +31,8 @@ exports[`it works 1`] = `
- [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`] = `
@@ -39,5 +40,6 @@ exports[`it works 2`] = `
- [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
"
`; `;
+129
View File
@@ -0,0 +1,129 @@
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import * as github from "@actions/github";
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
import type { Octokit } from "./octokit.ts";
type GitOptions = {
cwd: string;
};
const push = async (branch: string, options: GitOptions) => {
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
};
const switchToMaybeExistingBranch = async (
branch: string,
options: GitOptions
) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true,
...options,
});
let isCreatingBranch = !stderr
.toString()
.includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch], options);
}
};
const reset = async (pathSpec: string, options: GitOptions) => {
await exec("git", ["reset", `--hard`, pathSpec], options);
};
const commitAll = async (message: string, options: GitOptions) => {
await exec("git", ["add", "."], options);
await exec("git", ["commit", "-m", message], options);
};
const checkIfClean = async (options: GitOptions): Promise<boolean> => {
const { stdout } = await getExecOutput(
"git",
["status", "--porcelain"],
options
);
return !stdout.length;
};
export class Git {
readonly octokit: Octokit | null;
readonly cwd: string;
constructor(args: { octokit?: Octokit; cwd: string }) {
this.octokit = args.octokit ?? null;
this.cwd = args.cwd;
}
async setupUser() {
if (this.octokit) {
return;
}
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
cwd: this.cwd,
});
await exec(
"git",
[
"config",
"user.email",
`"41898282+github-actions[bot]@users.noreply.github.com"`,
],
{
cwd: this.cwd,
}
);
}
async pushTag(tag: string) {
if (this.octokit) {
return this.octokit.rest.git
.createRef({
...github.context.repo,
ref: `refs/tags/${tag}`,
sha: github.context.sha,
})
.catch((err) => {
// Assuming tag was manually pushed in custom publish script
core.warning(`Failed to create tag ${tag}: ${err.message}`);
});
}
await exec("git", ["push", "origin", tag], { cwd: this.cwd });
}
async prepareBranch(branch: string) {
if (this.octokit) {
// Preparing a new local branch is not necessary when using the API
return;
}
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(github.context.sha, { cwd: this.cwd });
}
async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.octokit) {
/**
* Only add files form the current working directory
*
* This will emulate the behavior of `git add .`,
* used in {@link commitAll}.
*/
const addFromDirectory = this.cwd;
return commitChangesFromRepo({
octokit: this.octokit,
...github.context.repo,
branch,
message,
base: {
commit: github.context.sha,
},
cwd: this.cwd,
force: true,
});
}
if (!(await checkIfClean({ cwd: this.cwd }))) {
await commitAll(message, { cwd: this.cwd });
}
await push(branch, { cwd: this.cwd });
}
}
-227
View File
@@ -1,227 +0,0 @@
import { Buffer } from "node:buffer";
import fs from "node:fs/promises";
import path from "node:path";
import { exec } from "tinyexec";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { GitHub } from "./github.ts";
import { createGitHttpRemote, shallowClone, testdir } from "./test-utils.ts";
const githubContext = vi.hoisted(() => ({
repo: {
owner: "changesets",
repo: "action",
},
sha: "base-sha",
}));
vi.mock("@actions/github", () => ({
context: githubContext,
getOctokit: () => ({}),
}));
async function git(cwd: string, args: string[]) {
const result = await exec("git", args, {
nodeOptions: { cwd },
throwOnError: true,
});
return result.stdout.trim();
}
function getAuthorization(token: string) {
return `basic ${Buffer.from(`x-access-token:${token}`).toString("base64")}`;
}
function createRemote() {
return createGitHttpRemote({ "file.txt": "initial\n" });
}
async function isolateGitConfig() {
const fixture = await testdir({ "global.gitconfig": "" });
vi.stubEnv("GIT_CONFIG_GLOBAL", path.join(fixture.path, "global.gitconfig"));
return fixture;
}
type GitHttpRemote = Awaited<ReturnType<typeof createGitHttpRemote>>;
async function pushChangedFile(
repository: string,
serverUrl: string,
token: string,
) {
await fs.writeFile(path.join(repository, "file.txt"), "changed\n");
const github = new GitHub({
cwd: repository,
githubToken: token,
pushWithGitCli: true,
serverUrl,
});
await github.pushChanges({
branch: "changeset-release/main",
message: "Version Packages",
});
return github;
}
async function expectReleaseBranch(remote: GitHttpRemote, repository: string) {
expect(
await git(remote.path, ["rev-parse", "refs/heads/changeset-release/main"]),
).toBe(await git(repository, ["rev-parse", "HEAD"]));
}
function expectRequestsToUseToken(remote: GitHttpRemote, token: string) {
expect(remote.requests.length).toBeGreaterThan(0);
for (const request of remote.requests) {
expect(request.headers.authorization).toEqual([getAuthorization(token)]);
}
}
beforeEach(() => {
vi.stubEnv("GIT_AUTHOR_DATE", "2000-01-01T00:00:00Z");
vi.stubEnv("GIT_COMMITTER_DATE", "2000-01-01T00:00:00Z");
vi.stubEnv("GIT_CONFIG_COUNT", "0");
vi.stubEnv("GIT_CONFIG_NOSYSTEM", "1");
vi.stubEnv("GIT_TERMINAL_PROMPT", "0");
});
afterEach(() => {
vi.unstubAllEnvs();
});
describe("GitHub", () => {
it("defaults to GitHub API mode", () => {
const github = new GitHub({
cwd: "/repo",
githubToken: "token",
});
expect(github.pushWithGitCli).toBe(false);
});
it("uses github-token instead of checkout's persisted header for branch and tag pushes", async () => {
await using _gitConfig = await isolateGitConfig();
const actionToken = "action-token";
const checkoutToken = "checkout-token";
await using remote = await createRemote();
await using repositoryFixture = await shallowClone(remote.path);
const repository = repositoryFixture.path;
const serverUrl = new URL(remote.url).origin;
await git(repository, ["remote", "set-url", "origin", remote.url]);
await git(repository, [
"config",
`http.${serverUrl}/.extraheader`,
`AUTHORIZATION: ${getAuthorization(checkoutToken)}`,
]);
const github = await pushChangedFile(repository, serverUrl, actionToken);
await git(repository, ["tag", "v1.0.0"]);
await github.pushTag("v1.0.0");
await expectReleaseBranch(remote, repository);
expect(await git(remote.path, ["rev-parse", "refs/tags/v1.0.0"])).toBe(
await git(repository, ["rev-parse", "v1.0.0"]),
);
expectRequestsToUseToken(remote, actionToken);
}, 15_000);
it("uses github-token instead of credentials embedded in the push URL", async () => {
await using _gitConfig = await isolateGitConfig();
const actionToken = "action-token";
await using remote = await createRemote();
await using repositoryFixture = await shallowClone(remote.path);
const repository = repositoryFixture.path;
const remoteUrl = new URL(remote.url);
remoteUrl.username = "x-access-token";
remoteUrl.password = "checkout-token";
await git(repository, ["remote", "set-url", "origin", remoteUrl.href]);
const persistedCredentialUrl = new URL(remoteUrl);
persistedCredentialUrl.password = "";
await git(repository, [
"config",
`http.${persistedCredentialUrl.href}.extraheader`,
`AUTHORIZATION: ${getAuthorization("checkout-token")}`,
]);
await pushChangedFile(repository, remoteUrl.origin, actionToken);
await expectReleaseBranch(remote, repository);
expectRequestsToUseToken(remote, actionToken);
}, 15_000);
it("uses the push URL when it differs from the fetch URL", async () => {
await using _gitConfig = await isolateGitConfig();
const actionToken = "action-token";
await using fetchRemote = await createRemote();
await using pushRemote = await createRemote();
await using repositoryFixture = await shallowClone(fetchRemote.path);
const repository = repositoryFixture.path;
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
await git(repository, ["config", "remote.origin.pushurl", pushRemote.url]);
await pushChangedFile(
repository,
new URL(fetchRemote.url).origin,
actionToken,
);
expect(fetchRemote.requests).toEqual([]);
await expectReleaseBranch(pushRemote, repository);
expectRequestsToUseToken(pushRemote, actionToken);
}, 15_000);
it("uses github-token for every push URL", async () => {
await using _gitConfig = await isolateGitConfig();
const actionToken = "action-token";
await using firstRemote = await createRemote();
await using secondRemote = await createRemote();
await using repositoryFixture = await shallowClone(firstRemote.path);
const repository = repositoryFixture.path;
for (const remote of [firstRemote, secondRemote]) {
await git(repository, [
"config",
"--add",
"remote.origin.pushurl",
remote.url,
]);
}
await pushChangedFile(
repository,
new URL(firstRemote.url).origin,
actionToken,
);
for (const remote of [firstRemote, secondRemote]) {
await expectReleaseBranch(remote, repository);
expectRequestsToUseToken(remote, actionToken);
}
}, 15_000);
it("preserves existing command-scoped Git config entries", async () => {
await using _gitConfig = await isolateGitConfig();
const actionToken = "action-token";
await using fetchRemote = await createRemote();
await using pushRemote = await createRemote();
await using repositoryFixture = await shallowClone(fetchRemote.path);
const repository = repositoryFixture.path;
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
vi.stubEnv("GIT_CONFIG_COUNT", "1");
vi.stubEnv("GIT_CONFIG_KEY_0", "remote.origin.pushurl");
vi.stubEnv("GIT_CONFIG_VALUE_0", pushRemote.url);
await pushChangedFile(
repository,
new URL(fetchRemote.url).origin,
actionToken,
);
expect(fetchRemote.requests).toEqual([]);
await expectReleaseBranch(pushRemote, repository);
expectRequestsToUseToken(pushRemote, actionToken);
}, 15_000);
});
-271
View File
@@ -1,271 +0,0 @@
import { Buffer } from "node:buffer";
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec";
import { context } from "@actions/github";
import { commitChangesSinceBase } from "@changesets/ghcommit";
import { setupOctokit, type Octokit } from "./octokit.ts";
type GitOptions = {
cwd: string;
env?: Record<string, string>;
};
const push = async (branch: string, options: GitOptions) => {
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
};
const switchToMaybeExistingBranch = async (
branch: string,
options: GitOptions,
) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true,
...options,
});
let isCreatingBranch = !stderr
.toString()
.includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch], options);
}
};
const reset = async (pathSpec: string, options: GitOptions) => {
await exec("git", ["reset", `--hard`, pathSpec], options);
};
const commitAll = async (message: string, options: GitOptions) => {
await exec("git", ["add", "."], options);
await exec("git", ["commit", "-m", message], options);
};
const checkIfClean = async (options: GitOptions): Promise<boolean> => {
const { stdout } = await getExecOutput(
"git",
["status", "--porcelain"],
options,
);
return !stdout.length;
};
function getHttpUrl(remoteUrl: string): string | undefined {
try {
const url = new URL(remoteUrl);
if (url.protocol !== "http:" && url.protocol !== "https:") {
return;
}
// Git includes the username when deciding which URL-specific config is
// most specific, so retain it. Password, query, and fragment do not
// participate in matching; strip them before copying the URL into the env.
url.password = "";
url.search = "";
url.hash = "";
return url.href;
} catch {
return;
}
}
export class GitHub {
readonly #githubToken: string;
readonly octokit: Octokit;
readonly cwd: string;
readonly pushWithGitCli: boolean;
readonly serverUrl: string;
constructor(options: {
githubToken: string;
cwd: string;
pushWithGitCli?: boolean;
serverUrl?: string;
}) {
this.#githubToken = options.githubToken;
this.cwd = options.cwd;
this.pushWithGitCli = options.pushWithGitCli ?? false;
this.serverUrl = (
options.serverUrl ??
context.serverUrl ??
process.env.GITHUB_SERVER_URL ??
"https://github.com"
).replace(/\/+$/, "");
this.octokit = setupOctokit(options.githubToken);
}
getToken() {
return this.#githubToken;
}
async #getCliAuthEnv(): Promise<Record<string, string>> {
// Make `github-token` authoritative for CLI pushes without changing the
// repository config. Git may otherwise use checkout's persisted header or
// credentials embedded in a remote URL, so we need to install command-scoped
// `http.extraHeader` overrides for every push destination.
//
// Historical context: v1 put `github-token` in ~/.netrc, where checkout's
// extraheader took precedence. This setup with reset + authHeader
// deliberately makes `github-token` win for pushes.
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
"base64",
);
// The environment may already contain command-scoped Git config. Append
// our KEY_n/VALUE_n entries so those existing settings stay active.
const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0);
if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) {
throw new Error(
`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`,
);
}
// `git push origin` prefers remote.origin.pushurl over the fetch URL and
// supports more than one push URL, so inspect every effective destination.
const { stdout } = await getExecOutput(
"git",
["remote", "get-url", "--push", "--all", "origin"],
{
cwd: this.cwd,
ignoreReturnCode: true,
// A user-configured remote can contain credentials.
silent: true,
},
);
// Git reads `http.extraHeader` from the most specific matching URL section.
// The host key replaces checkout's usual persisted header; an exact key for
// each destination outranks path- or username-specific inherited config.
// Git selects only one URL section, so these keys do not duplicate headers.
const extraHeaderKeys = new Set([`http.${this.serverUrl}/.extraheader`]);
for (const remoteUrl of stdout.split(/\r?\n/)) {
const httpUrl = getHttpUrl(remoteUrl);
if (httpUrl !== undefined) {
extraHeaderKeys.add(`http.${httpUrl}.extraheader`);
}
}
const authHeader = `AUTHORIZATION: basic ${basic}`;
// Each URL key needs two new command-scoped config entries: one to reset
// the inherited header list and one to install our Authorization header.
const env: Record<string, string> = {
GIT_CONFIG_COUNT: String(gitConfigCount + extraHeaderKeys.size * 2),
};
// `http.extraHeader` is multi-valued, so merely appending our header could
// make Git send both tokens. An empty value resets inherited values; the
// following value adds only ours.
let index = 0;
for (const extraHeaderKey of extraHeaderKeys) {
const resetIndex = gitConfigCount + index * 2;
const authIndex = resetIndex + 1;
env[`GIT_CONFIG_KEY_${resetIndex}`] = extraHeaderKey;
env[`GIT_CONFIG_VALUE_${resetIndex}`] = "";
env[`GIT_CONFIG_KEY_${authIndex}`] = extraHeaderKey;
env[`GIT_CONFIG_VALUE_${authIndex}`] = authHeader;
index++;
}
return env;
}
async ensureGitUser() {
// Check the exact identities that Git would use for commits without
// allowing Git to fall back to auto-detected values like user@hostname.
// This covers explicit GIT_AUTHOR_* / GIT_COMMITTER_* env vars, local
// config, and global config. A partial identity, with only a name or only
// an email, does not pass this check. If either identity is missing,
// configure our default bot user as a fallback.
const authorIdentity = await getExecOutput(
"git",
["-c", "user.useConfigOnly=true", "var", "GIT_AUTHOR_IDENT"],
{
cwd: this.cwd,
ignoreReturnCode: true,
silent: true,
},
);
const committerIdentity = await getExecOutput(
"git",
["-c", "user.useConfigOnly=true", "var", "GIT_COMMITTER_IDENT"],
{
cwd: this.cwd,
ignoreReturnCode: true,
silent: true,
},
);
if (authorIdentity.exitCode === 0 && committerIdentity.exitCode === 0) {
return;
}
core.info("Setting git user to github-actions[bot]");
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
cwd: this.cwd,
});
await exec(
"git",
[
"config",
"user.email",
`"41898282+github-actions[bot]@users.noreply.github.com"`,
],
{
cwd: this.cwd,
},
);
}
async pushTag(tag: string) {
try {
if (!this.pushWithGitCli) {
await this.octokit.rest.git.createRef({
...context.repo,
ref: `refs/tags/${tag}`,
sha: context.sha,
});
} else {
await exec("git", ["push", "origin", tag], {
cwd: this.cwd,
env: {
...process.env,
...(await this.#getCliAuthEnv()),
} as Record<string, string>,
});
}
} catch (err) {
core.warning(
`Failed to create git tag "${tag}". Assuming it was manually pushed by the publish script: ${(err as Error).message}`,
);
}
}
async prepareBranch(branch: string) {
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(context.sha, { cwd: this.cwd });
}
async pushChanges({ branch, message }: { branch: string; message: string }) {
if (!this.pushWithGitCli) {
await commitChangesSinceBase({
octokit: this.octokit,
...context.repo,
branch,
message,
base: {
commit: context.sha,
},
force: true,
cwd: this.cwd,
});
return;
}
if (!(await checkIfClean({ cwd: this.cwd }))) {
await this.ensureGitUser();
await commitAll(message, { cwd: this.cwd });
}
await push(branch, {
cwd: this.cwd,
env: {
...process.env,
...(await this.#getCliAuthEnv()),
} as Record<string, string>,
});
}
}
+110 -82
View File
@@ -1,139 +1,167 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { GitHub } from "./github.ts"; import fs from "node:fs/promises";
import path from "node:path";
import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts"; import readChangesetState from "./readChangesetState.ts";
import { runPublish, runVersion } from "./run.ts"; import { runPublish, runVersion } from "./run.ts";
import { import { fileExists } from "./utils.ts";
getOptionalInput,
getRequiredInput,
throwOnRemovedCommitModeInput,
throwOnRenamedInputs,
validateChangesetsCliVersion,
} from "./utils.ts";
try { const getOptionalInput = (name: string) => core.getInput(name) || undefined;
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() { (async () => {
const cwd = getOptionalInput("cwd") || process.cwd(); // to maintain compatibility with workflows created before github-token input was introduced
await validateChangesetsCliVersion(cwd); // it's important to prefer the explicitly set GITHUB_TOKEN over the default token coming from github.token
let githubToken = process.env.GITHUB_TOKEN || core.getInput("github-token");
throwOnRenamedInputs({ if (!githubToken) {
publish: "publish-script", core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
version: "version-script",
commit: "commit-message",
title: "pr-title",
branch: "pr-base-branch",
prDraft: "pr-draft",
createGithubReleases: "create-github-releases",
});
throwOnRemovedCommitModeInput();
const githubToken = getRequiredInput("github-token");
if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) {
throw new Error(
'The GITHUB_TOKEN environment variable is set and does not match the "github-token" input. ' +
'Please pass the custom GitHub token to the "github-token" input and ' +
"remove the GITHUB_TOKEN environment variable to avoid conflicts.",
);
}
const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
const prDraft = getOptionalInput("pr-draft");
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid pr-draft: ${prDraft}`);
return; return;
} }
const github = new GitHub({
const cwd = path.resolve(getOptionalInput("cwd") ?? "");
core.info(`using resolved cwd: ${cwd}`);
const octokit = setupOctokit(githubToken);
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
const prDraft = getOptionalInput("prDraft");
if (commitMode !== "git-cli" && commitMode !== "github-api") {
core.setFailed(`Invalid commit mode: ${commitMode}`);
return;
}
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid prDraft: ${prDraft}`);
return;
}
const git = new Git({
octokit: commitMode === "github-api" ? octokit : undefined,
cwd, cwd,
githubToken,
pushWithGitCli,
}); });
let setupGitUser = core.getBooleanInput("setupGitUser");
if (setupGitUser) {
core.info("setting git user");
await git.setupUser();
}
core.info("setting GitHub credentials");
await fs.writeFile(
`${process.env.HOME}/.netrc`,
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
);
let { changesets } = await readChangesetState(cwd); let { changesets } = await readChangesetState(cwd);
let publishScript = core.getInput("publish-script"); 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;
core.setOutput("published", "false"); core.setOutput("published", "false");
core.setOutput("published-packages", "[]"); core.setOutput("publishedPackages", "[]");
core.setOutput("has-changesets", String(hasChangesets)); core.setOutput("hasChangesets", String(hasChangesets));
switch (true) { switch (true) {
case !hasChangesets && !hasPublishScript: case !hasChangesets && !hasPublishScript:
core.info( core.info(
"No changesets present or were removed by merging version PR. Not publishing because publish-script is not set.", "No changesets present or were removed by merging release PR. Not publishing because no publish script found."
); );
return; 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"
); );
const createGithubReleases = core.getBooleanInput( if (process.env.NPM_TOKEN) {
"create-github-releases", const userNpmrcPath = `${process.env.HOME}/.npmrc`;
if (await fileExists(userNpmrcPath)) {
core.info("Found existing user .npmrc file");
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
const authLine = userNpmrcContent.split("\n").find((line) => {
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
});
if (authLine) {
core.info(
"Found existing auth token for the npm registry in the user .npmrc file"
); );
const pushGitTags = core.getBooleanInput("push-git-tags"); } else {
if (createGithubReleases && !pushGitTags) { core.info(
throw new Error( "Didn't find existing auth token for the npm registry in the user .npmrc file, creating one"
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " + );
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " + await fs.appendFile(
"or set 'create-github-releases' to false.", userNpmrcPath,
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
); );
} }
} else {
core.info(
"No user .npmrc file found, creating one with NPM_TOKEN used as auth token"
);
await fs.writeFile(
userNpmrcPath,
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
);
}
} else if (
process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN &&
process.env.ACTIONS_ID_TOKEN_REQUEST_URL
) {
core.info(
"No NPM_TOKEN found, but OIDC is available - using npm trusted publishing"
);
} else {
core.info(
"No NPM_TOKEN or OIDC available - assuming npm is already authenticated"
);
}
const result = await runPublish({ const result = await runPublish({
script: publishScript, script: publishScript,
github, githubToken,
createGithubReleases, git,
pushGitTags, octokit,
createGithubReleases: core.getBooleanInput("createGithubReleases"),
cwd, cwd,
}); });
if (result.published) { if (result.published) {
core.setOutput("published", "true"); core.setOutput("published", "true");
core.setOutput( core.setOutput(
"published-packages", "publishedPackages",
JSON.stringify(result.publishedPackages), JSON.stringify(result.publishedPackages)
);
}
if (result.exitCode !== 0) {
throw new Error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
); );
} }
return; return;
} }
case hasChangesets && !hasNonEmptyChangesets: case hasChangesets && !hasNonEmptyChangesets:
core.info("All changesets are empty. Not creating PR"); core.info("All changesets are empty; not creating PR");
return; return;
case hasChangesets: { case hasChangesets: {
const octokit = setupOctokit(githubToken);
const { pullRequestNumber } = await runVersion({ const { pullRequestNumber } = await runVersion({
script: getOptionalInput("version-script"), script: getOptionalInput("version"),
github, githubToken,
git,
octokit,
cwd, cwd,
prTitle: getOptionalInput("pr-title"), prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit-message"), commitMessage: getOptionalInput("commit"),
hasPublishScript, hasPublishScript,
prDraft, prDraft,
branch: getOptionalInput("pr-base-branch"), branch: getOptionalInput("branch"),
}); });
core.setOutput("pr-number", String(pullRequestNumber)); core.setOutput("pullRequestNumber", String(pullRequestNumber));
return; return;
} }
} }
} })().catch((err) => {
core.error(err);
core.setFailed(err.message);
});
+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
); );
}; };
-88
View File
@@ -1,88 +0,0 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import {
downloadArtifact,
execChangesetsCli,
getOptionalInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const publishPlanArtifactId = getOptionalInput("publish-plan-artifact-id");
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
const outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`);
await pack(cwd, {
outDir,
publishPlanPath: publishPlanArtifactId
? await downloadPublishPlanArtifact(tmpDir, Number(publishPlanArtifactId))
: undefined,
});
const packDirArtifact = await artifact.uploadArtifact(
`changeset-pack-${Date.now()}`,
await getFiles(outDir),
outDir,
{
retentionDays: 30,
},
);
if (packDirArtifact.id === undefined) {
throw new Error("Packed artifact upload did not return an artifact id");
}
core.setOutput("pack-dir-artifact-id", String(packDirArtifact.id));
}
async function pack(
cwd: string,
args: {
outDir: string;
publishPlanPath?: string;
},
) {
const cliArgs = ["pack", "--out-dir", args.outDir];
if (args.publishPlanPath) {
cliArgs.push("--from-publish-plan", args.publishPlanPath);
}
await execChangesetsCli(cliArgs, {
cwd,
env: process.env,
});
}
async function downloadPublishPlanArtifact(tmpDir: string, artifactId: number) {
const downloadPath = await downloadArtifact(
tmpDir,
artifactId,
"changeset-publish-plan",
);
return path.join(downloadPath, "publish-plan.json");
}
async function getFiles(dir: string): Promise<string[]> {
const entries = await fs.readdir(dir, { withFileTypes: true });
const files = await Promise.all(
entries.map(async (entry) => {
const entryPath = path.join(dir, entry.name);
if (entry.isDirectory()) {
return getFiles(entryPath);
}
return [entryPath];
}),
);
return files.flat();
}
-78
View File
@@ -1,78 +0,0 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
import { getOptionalInput, getRequiredInput } from "../utils.ts";
type Octokit = ReturnType<typeof github.getOctokit>;
type CreateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
>;
type UpdateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
>;
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
const githubToken = getRequiredInput("github-token");
const body = getRequiredInput("body");
const updateId = getOptionalInput("update-id");
const commentMarker = updateId ? getCommentMarker(updateId) : null;
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
const commentParam: CreateCommentParams | UpdateCommentParams = {
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
body: commentBody,
};
const octokit = github.getOctokit(githubToken);
let existingCommentId: number | undefined;
if (commentMarker) {
core.info("Checking for existing comment...");
existingCommentId = await octokit.rest.issues
.listComments({
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
})
.then((res) => {
const comment = res.data.find((c) => c.body?.includes(commentMarker));
return comment?.id;
});
}
if (existingCommentId) {
core.info(`Updating existing comment (id: ${existingCommentId})...`);
await octokit.rest.issues.updateComment({
...commentParam,
comment_id: existingCommentId,
});
core.setOutput("comment-id", existingCommentId);
} else {
core.info("Creating new comment...");
const result = await octokit.rest.issues.createComment(commentParam);
core.setOutput("comment-id", result.data.id);
}
core.info("Done!");
}
function getCommentMarker(updateId: string) {
const prefix = "changesets-action-pr-comment";
return prefix === updateId
? `<!-- ${prefix} -->`
: `<!-- ${prefix}:${updateId} -->`;
}
-23
View File
@@ -1,23 +0,0 @@
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
@@ -1,120 +0,0 @@
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://changesets.dev/faq).
[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://changesets.dev/faq).
[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
@@ -1,30 +0,0 @@
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}
`;
}
-136
View File
@@ -1,136 +0,0 @@
import { pathToFileURL } from "node:url";
import type * as github from "@actions/github";
import { getReleasePlan } from "@changesets/get-release-plan";
import { exec } from "tinyexec";
import { describe, expect, it } from "vitest";
import { gitdir, shallowClone, testdir } from "../test-utils.ts";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
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 gitdir({
".changeset/config.json": JSON.stringify({}),
"package.json": JSON.stringify({
name: "repo",
private: true,
workspaces: ["packages/*"],
}),
"package-lock.json": "",
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
});
const sourceRepo = sourceRepoFixture.path;
// Simulate remote bare git server
await using originBareFixture = await testdir();
const originBare = originBareFixture.path;
await git(originBare, [
"clone",
"--bare",
pathToFileURL(sourceRepo).toString(),
".",
]);
// Simulate checkout PR in github action
await using checkoutRepoFixture = await shallowClone(originBare);
const checkoutRepo = checkoutRepoFixture.path;
// Simulate remote fork bare git server
await using forkBareFixture = await testdir();
const forkBare = forkBareFixture.path;
await git(forkBare, [
"clone",
"--bare",
pathToFileURL(originBare).toString(),
".",
]);
await using forkRepoFixture = await shallowClone(forkBare);
const forkRepo = forkRepoFixture.path;
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");
});
});
-150
View File
@@ -1,150 +0,0 @@
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";
import { moveDisposable, type WithAsyncDispose } from "../utils.ts";
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,
});
},
};
}
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,
});
}
-78
View File
@@ -1,78 +0,0 @@
import fs from "node:fs/promises";
import os from "node:os";
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runPublish } from "../run.ts";
import {
downloadArtifact,
getOptionalInput,
getRequiredInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const packDirArtifactId = getOptionalInput("pack-dir-artifact-id");
const createGithubReleases = core.getBooleanInput("create-github-releases");
const pushGitTags = core.getBooleanInput("push-git-tags");
if (createGithubReleases && !pushGitTags) {
throw new Error(
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " +
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " +
"or set 'create-github-releases' to false.",
);
}
// The publish sub-action always uses the GitHub API for tag pushes.
const github = new GitHub({ cwd, githubToken });
const fromPackDir = packDirArtifactId
? await downloadArtifact(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
Number(packDirArtifactId),
"changeset-pack",
)
: undefined;
const result = await runPublish({
script,
github,
createGithubReleases,
pushGitTags,
cwd,
fromPackDir,
});
if (result.published) {
core.setOutput("published", "true");
core.setOutput(
"published-packages",
JSON.stringify(result.publishedPackages),
);
} else {
core.setOutput("published", "false");
}
if (result.exitCode !== 0) {
throw new Error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
}
}
-40
View File
@@ -1,40 +0,0 @@
import { createFixture } from "fs-fixture";
import { describe, expect, it } from "vitest";
import readChangesetState from "./readChangesetState.ts";
const changeset = `---
"pkg-a": patch
---
Fix a bug.
`;
describe("readChangesetState", () => {
it("filters versioned changesets in prerelease mode", async () => {
await using fixture = await createFixture({
".changeset/pre.json": JSON.stringify({ mode: "pre", tag: "next" }),
".changeset/pre/versioned.md": changeset,
".changeset/pending.md": changeset,
});
const state = await readChangesetState(fixture.path);
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
"pending",
]);
});
it("includes versioned changesets when exiting prerelease mode", async () => {
await using fixture = await createFixture({
".changeset/pre.json": JSON.stringify({ mode: "exit", tag: "next" }),
".changeset/pre/versioned.md": changeset,
});
const state = await readChangesetState(fixture.path);
expect(state.preState).toBeUndefined();
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
"pre/versioned",
]);
});
});
+6 -6
View File
@@ -1,6 +1,6 @@
import { readPreState } from "@changesets/pre";
import { readChangesets } from "@changesets/read";
import type { PreState, NewChangeset } from "@changesets/types"; import type { PreState, NewChangeset } from "@changesets/types";
import { readPreState } from "@changesets/pre";
import readChangesets from "@changesets/read";
export type ChangesetState = { export type ChangesetState = {
preState: PreState | undefined; preState: PreState | undefined;
@@ -8,17 +8,17 @@ 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);
if (preState !== undefined && preState.mode === "pre") { if (preState !== undefined && preState.mode === "pre") {
let changesetsToFilter = new Set(preState.changesets);
return { return {
preState, preState,
changesets: changesets.filter( changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)),
(changeset) => !changeset.id.startsWith("pre/"),
),
}; };
} }
+76 -194
View File
@@ -1,13 +1,12 @@
import path from "node:path";
import * as core from "@actions/core";
import * as github from "@actions/github";
import type { Changeset } from "@changesets/types"; import type { Changeset } from "@changesets/types";
import { writeChangeset } from "@changesets/write"; import writeChangeset from "@changesets/write";
import { exec } from "tinyexec"; import fixturez from "fixturez";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import fs from "node:fs/promises";
import { GitHub } from "./github.ts"; import path from "node:path";
import { runPublish, runVersion } from "./run.ts"; import { beforeEach, describe, expect, it, vi } from "vitest";
import { gitdir } from "./test-utils.ts"; import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import { runVersion } from "./run.ts";
vi.mock("@actions/github", () => ({ vi.mock("@actions/github", () => ({
context: { context: {
@@ -23,13 +22,8 @@ vi.mock("@actions/github", () => ({
graphql: mockedGraphql, graphql: mockedGraphql,
}), }),
})); }));
vi.mock("@actions/core", async (importOriginal) => ({ vi.mock("./git.ts");
...(await importOriginal<typeof import("@actions/core")>()), vi.mock("@changesets/ghcommit/git");
error: vi.fn(),
notice: vi.fn(),
warning: vi.fn(),
}));
vi.mock("@changesets/ghcommit");
let mockedGithubMethods = { let mockedGithubMethods = {
pulls: { pulls: {
@@ -42,147 +36,26 @@ let mockedGithubMethods = {
}; };
let mockedGraphql = vi.fn(); let mockedGraphql = vi.fn();
const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules"); let f = fixturez(import.meta.dirname);
function createSimpleProjectFixture() {
return gitdir({
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/*"],
}),
"package-lock.json": "",
});
}
function createIgnoredPackageFixture() {
return gitdir({
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/*"],
}),
"package-lock.json": "",
});
}
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)));
}; };
const createGithub = (cwd: string) =>
new GitHub({
cwd,
githubToken: "@@GITHUB_TOKEN",
pushWithGitCli: false,
});
async function updateGithubContext(cwd: string) {
const head = await exec("git", ["rev-parse", "HEAD"], {
nodeOptions: { cwd },
});
github.context.sha = head.stdout.trim();
}
function resetGithubContext() {
github.context.sha = "xeac7";
}
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
resetGithubContext();
});
afterEach(() => {
vi.unstubAllEnvs();
});
describe("publish", () => {
it("warns when a custom publish script does not create the output file", async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
await updateGithubContext(cwd);
vi.stubEnv("RUNNER_TEMP", cwd);
const result = await runPublish({
script: 'node -e "void 0"',
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
});
expect(result).toEqual({ published: false, exitCode: 0 });
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining(
"GitHub releases and git tags cannot be created without this output",
),
);
});
it("throws when the built-in publish command does not create the output file", async () => {
await using fixture = await gitdir({
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
type: "module",
}),
"node_modules/@changesets/cli/bin.js": "",
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
}),
"package-lock.json": "",
});
const cwd = fixture.path;
await updateGithubContext(cwd);
vi.stubEnv("RUNNER_TEMP", cwd);
await expect(
runPublish({
github: createGithub(cwd),
createGithubReleases: true,
pushGitTags: true,
cwd,
}),
).rejects.toThrow("Failed to read changesets output at");
});
}); });
describe("version", () => { describe("version", () => {
it("creates simple PR", async () => { it("creates simple PR", async () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -195,22 +68,24 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
{ {
name: "changesets-dev-simple-project-pkg-b", name: "simple-project-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -218,9 +93,8 @@ describe("version", () => {
}); });
it('creates a draft PR when prDraft is "create"', async () => { it('creates a draft PR when prDraft is "create"', async () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -233,18 +107,20 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
prDraft: "create", prDraft: "create",
}); });
@@ -253,9 +129,8 @@ describe("version", () => {
}); });
it("only includes bumped packages in the PR body", async () => { it("only includes bumped packages in the PR body", async () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -268,18 +143,20 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -287,9 +164,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 () => {
await using fixture = await createIgnoredPackageFixture(); let cwd = f.copy("ignored-package");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -302,18 +178,20 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-ignored-package-pkg-b", name: "ignored-package-pkg-b",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -321,9 +199,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 () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -336,7 +213,7 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
@@ -363,25 +240,26 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
prBodyMaxCharacters: 1000, prBodyMaxCharacters: 1000,
}); });
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 () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
@@ -394,7 +272,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
@@ -421,25 +299,26 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
prBodyMaxCharacters: 500, prBodyMaxCharacters: 500,
}); });
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 () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
@@ -450,18 +329,20 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
prDraft: "create", prDraft: "create",
}); });
@@ -470,9 +351,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 () => {
await using fixture = await createSimpleProjectFixture(); let cwd = f.copy("simple-project");
const cwd = fixture.path; await linkNodeModules(cwd);
await updateGithubContext(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }], data: [{ number: 123, node_id: "PR_kwDOA" }],
@@ -483,18 +363,20 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
summary: "Awesome feature", summary: "Awesome feature",
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
github: createGithub(cwd), octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
prDraft: "always", prDraft: "always",
}); });
+129 -184
View File
@@ -1,30 +1,25 @@
import { randomUUID } from "node:crypto";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import * as core from "@actions/core"; import * as core from "@actions/core";
import { import { exec, getExecOutput } from "@actions/exec";
exec, import * as github from "@actions/github";
getExecOutput,
type ExecOptions,
type ExecOutput,
} from "@actions/exec";
import { context } 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 type { GitHub } from "./github.ts"; import fs from "node:fs/promises";
import { createRequire } from "node:module";
import path from "node:path";
import semverLt from "semver/functions/lt.js";
import { Git } from "./git.ts";
import type { Octokit } from "./octokit.ts"; import type { Octokit } from "./octokit.ts";
import readChangesetState from "./readChangesetState.ts"; import readChangesetState from "./readChangesetState.ts";
import { import {
execChangesetsCli,
getChangedPackages, getChangedPackages,
getChangelogEntry, getChangelogEntry,
getExecOutputChangesetsCli,
getVersionsByDirectory, getVersionsByDirectory,
isErrorWithCode, isErrorWithCode,
sortTheThings, sortTheThings,
} from "./utils.ts"; } from "./utils.ts";
const require = createRequire(import.meta.url);
// GitHub Issues/PRs messages have a max size limit on the // GitHub Issues/PRs messages have a max size limit on the
// message body payload. // message body payload.
// `body is too long (maximum is 65536 characters)`. // `body is too long (maximum is 65536 characters)`.
@@ -33,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 {
@@ -50,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}`
); );
} }
@@ -59,206 +54,132 @@ const createRelease = async (
tag_name: tagName, tag_name: tagName,
body: changelogEntry.content, body: changelogEntry.content,
prerelease: pkg.packageJson.version.includes("-"), prerelease: pkg.packageJson.version.includes("-"),
...context.repo, ...github.context.repo,
}); });
}; };
type PublishOptions = { type PublishOptions = {
script?: string; script: string;
fromPackDir?: string; githubToken: string;
octokit: Octokit;
createGithubReleases: boolean; createGithubReleases: boolean;
pushGitTags: boolean; git: Git;
github: GitHub;
cwd: string; cwd: string;
}; };
type PublishedPackage = { name: string; version: string }; type PublishedPackage = { name: string; version: string };
type ChangesetsOutputEvent = {
type: "git-tag";
tag: string;
packageName: string;
};
class ChangesetsOutputReadError extends Error {}
type PublishResult = type PublishResult =
| { | {
published: true; published: true;
publishedPackages: PublishedPackage[]; publishedPackages: PublishedPackage[];
exitCode: number;
} }
| { | {
published: false; published: false;
exitCode: number;
}; };
function isObject(value: unknown) {
return typeof value === "object" && value !== null;
}
function isChangesetsOutputEvent(
value: unknown,
): value is ChangesetsOutputEvent {
return (
isObject(value) &&
"type" in value &&
value.type === "git-tag" &&
"tag" in value &&
typeof value.tag === "string" &&
"packageName" in value &&
typeof value.packageName === "string"
);
}
async function readChangesetsOutput(outputPath: string) {
let rawOutput: string;
try {
rawOutput = await fs.readFile(outputPath, "utf8");
} catch (err) {
throw new ChangesetsOutputReadError(
`Failed to read changesets output at ${outputPath}`,
{ cause: err },
);
}
const events: ChangesetsOutputEvent[] = [];
let lineStart = 0;
while (lineStart <= rawOutput.length) {
let lineEnd = rawOutput.indexOf("\n", lineStart);
if (lineEnd === -1) {
lineEnd = rawOutput.length;
}
const line = rawOutput.slice(lineStart, lineEnd);
lineStart = lineEnd + 1;
if (/^\s*$/.test(line)) {
continue;
}
let event: unknown;
try {
event = JSON.parse(line);
} catch (err) {
throw new Error(`Failed to parse changesets output event: ${line}`, {
cause: err,
});
}
if (!isChangesetsOutputEvent(event)) {
continue;
}
events.push(event);
}
return events;
}
export async function runPublish({ export async function runPublish({
script, script,
fromPackDir, githubToken,
github, git,
octokit,
createGithubReleases, createGithubReleases,
pushGitTags,
cwd, cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
const { octokit } = github; let [publishCommand, ...publishArgs] = script.split(/\s+/);
// Changesets creates annotated tags locally, including when the action pushes those tags through the GitHub API.
// It might also be important for custom publish scripts to have a valid git user configured.
await github.ensureGitUser();
let changesetPublishOutput: ExecOutput; let changesetPublishOutput = await getExecOutput(
const outputFile = path.join( publishCommand,
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())), publishArgs,
`changesets-output-${randomUUID()}.ndjson`, { cwd, env: { ...process.env, GITHUB_TOKEN: githubToken } }
); );
const execOptions: ExecOptions = {
cwd,
ignoreReturnCode: true,
env: {
...process.env,
GITHUB_TOKEN: github.getToken(),
CHANGESETS_OUTPUT: outputFile,
},
};
if (script) {
changesetPublishOutput = await getExecOutput(
script,
undefined,
execOptions,
);
} else {
const args = ["publish"];
if (fromPackDir) {
args.push("--from-pack-dir", fromPackDir);
}
changesetPublishOutput = await getExecOutputChangesetsCli(
args,
execOptions,
);
}
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = [];
if (tool !== "root") {
let newTagRegex = /New tag:\s+(@[^/]+\/[^@]+|[^/]+)@([^\s]+)/;
let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x])); let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x]));
let output: ChangesetsOutputEvent[];
try { for (let line of changesetPublishOutput.stdout.split("\n")) {
output = await readChangesetsOutput(outputFile); let match = line.match(newTagRegex);
} catch (err) { if (match === null) {
if (!script || !(err instanceof ChangesetsOutputReadError)) { continue;
throw err;
} }
core.warning( let pkgName = match[1];
`${err.message}. GitHub releases and git tags cannot be created without this output. Ensure the custom publish script passes CHANGESETS_OUTPUT to the Changesets CLI.`, let pkg = packagesByName.get(pkgName);
);
output = [];
}
let releases = output.map((event) => {
let pkg = packagesByName.get(event.packageName);
if (pkg === undefined) { if (pkg === undefined) {
throw new Error( throw new Error(
`Package "${event.packageName}" 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"
); );
} }
return { pkg, tag: event.tag }; releasedPackages.push(pkg);
}); }
if (tool.type === "root" && packages.length === 0) { if (createGithubReleases) {
await Promise.all(
releasedPackages.map(async (pkg) => {
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName });
})
);
}
} else {
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 newTagRegex = /New tag:/;
if (createGithubReleases || pushGitTags) { for (let line of changesetPublishOutput.stdout.split("\n")) {
await Promise.all( let match = line.match(newTagRegex);
releases.map(async ({ pkg, tag }) => {
if (pushGitTags) { if (match) {
await github.pushTag(tag); releasedPackages.push(pkg);
}
if (createGithubReleases) { if (createGithubReleases) {
await createRelease(octokit, { pkg, tagName: tag }); const tagName = `v${pkg.packageJson.version}`;
await git.pushTag(tagName);
await createRelease(octokit, { pkg, tagName });
}
break;
}
} }
}),
);
} }
if (releases.length) { if (releasedPackages.length) {
return { return {
published: true, published: true,
publishedPackages: releases.map(({ pkg }) => ({ publishedPackages: releasedPackages.map((pkg) => ({
name: pkg.packageJson.name, name: pkg.packageJson.name,
version: pkg.packageJson.version, version: pkg.packageJson.version,
})), })),
exitCode: changesetPublishOutput.exitCode,
}; };
} }
return { published: false, exitCode: changesetPublishOutput.exitCode }; return { published: false };
} }
const requireChangesetsCliPkgJson = (cwd: string) => {
try {
return require(require.resolve("@changesets/cli/package.json", {
paths: [cwd],
}));
} catch (err) {
if (isErrorWithCode(err, "MODULE_NOT_FOUND")) {
throw new Error(
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`,
{ cause: err }
);
}
throw err;
}
};
type GetMessageOptions = { type GetMessageOptions = {
hasPublishScript: boolean; hasPublishScript: boolean;
branch: string; branch: string;
@@ -330,7 +251,9 @@ export async function getVersionPrBody({
type VersionOptions = { type VersionOptions = {
script?: string; script?: string;
github: GitHub; githubToken: string;
git: Git;
octokit: Octokit;
cwd?: string; cwd?: string;
prTitle?: string; prTitle?: string;
commitMessage?: string; commitMessage?: string;
@@ -346,30 +269,48 @@ type RunVersionResult = {
export async function runVersion({ export async function runVersion({
script, script,
github, githubToken,
git,
octokit,
cwd = process.cwd(), cwd = process.cwd(),
prTitle = "Version Packages", prTitle = "Version Packages",
commitMessage = "Version Packages", commitMessage = "Version Packages",
hasPublishScript = false, hasPublishScript = false,
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE, prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
branch = context.ref.replace("refs/heads/", ""), branch = github.context.ref.replace("refs/heads/", ""),
prDraft, prDraft,
}: VersionOptions): Promise<RunVersionResult> { }: VersionOptions): Promise<RunVersionResult> {
const { octokit } = github;
let versionBranch = `changeset-release/${branch}`; let versionBranch = `changeset-release/${branch}`;
let { preState } = await readChangesetState(cwd); let { preState } = await readChangesetState(cwd);
await github.prepareBranch(versionBranch); await git.prepareBranch(versionBranch);
let versionsByDirectory = await getVersionsByDirectory(cwd); let versionsByDirectory = await getVersionsByDirectory(cwd);
const env = { ...process.env, GITHUB_TOKEN: github.getToken() }; const env = { ...process.env, GITHUB_TOKEN: githubToken };
if (script) { if (script) {
await exec(script, undefined, { cwd, env }); let [versionCommand, ...versionArgs] = script.split(/\s+/);
await exec(versionCommand, versionArgs, { cwd, env });
} else { } else {
await execChangesetsCli(["version"], { cwd, env }); let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0")
? "bump"
: "version";
await exec(
"node",
[
require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
}),
cmd,
],
{
cwd,
env,
}
);
} }
let changedPackages = await getChangedPackages(cwd, versionsByDirectory); let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
@@ -377,7 +318,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);
@@ -387,7 +328,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})` : ""}`;
@@ -395,24 +336,28 @@ export async function runVersion({
!!preState ? ` (${preState.tag})` : "" !!preState ? ` (${preState.tag})` : ""
}`; }`;
/**
* Fetch any existing pull requests that are open against the branch,
* before we push any changes that may inadvertently close the existing PRs.
*
* (`@changesets/ghcommit` has to reset the branch to the same commit as the base,
* which GitHub will then react to by closing the PRs)
*/
const existingPullRequests = await octokit.rest.pulls.list({ const existingPullRequests = await octokit.rest.pulls.list({
...context.repo, ...github.context.repo,
state: "open", state: "open",
head: `${context.repo.owner}:${versionBranch}`, head: `${github.context.repo.owner}:${versionBranch}`,
base: branch, base: branch,
}); });
core.debug( core.info(
`Existing pull requests: ${JSON.stringify( `Existing pull requests: ${JSON.stringify(
existingPullRequests.data, existingPullRequests.data,
null, null,
2, 2
)}`, )}`
); );
await github.pushChanges({ await git.pushChanges({ branch: versionBranch, message: finalCommitMessage });
branch: versionBranch,
message: finalCommitMessage,
});
const changedPackagesInfo = (await changedPackagesInfoPromises) const changedPackagesInfo = (await changedPackagesInfoPromises)
.filter((x) => x) .filter((x) => x)
@@ -427,14 +372,14 @@ export async function runVersion({
}); });
if (existingPullRequests.data.length === 0) { if (existingPullRequests.data.length === 0) {
core.info("Creating pull request"); core.info("creating pull request");
const { data: newPullRequest } = await octokit.rest.pulls.create({ const { data: newPullRequest } = await octokit.rest.pulls.create({
base: branch, base: branch,
head: versionBranch, head: versionBranch,
title: finalPrTitle, title: finalPrTitle,
body: prBody, body: prBody,
draft: prDraft !== undefined, draft: prDraft !== undefined,
...context.repo, ...github.context.repo,
}); });
return { return {
@@ -443,7 +388,7 @@ export async function runVersion({
} else { } else {
const [pullRequest] = existingPullRequests.data; const [pullRequest] = existingPullRequests.data;
core.info(`Updating found pull request #${pullRequest.number}`); core.info(`updating found pull request #${pullRequest.number}`);
const convertPullRequestToDraftMutation = const convertPullRequestToDraftMutation =
prDraft === "always" prDraft === "always"
? ` ? `
-125
View File
@@ -1,125 +0,0 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import artifact from "@actions/artifact";
import * as core from "@actions/core";
import readChangesetState from "../readChangesetState.ts";
import {
execChangesetsCli,
getOptionalInput,
validateChangesetsCliVersion,
} from "../utils.ts";
type ModeResult =
| {
mode: "none";
}
| {
mode: "version";
}
| {
mode: "publish";
publishPlanPath: string;
};
type PublishPlan = unknown[];
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
const result = await getMode(cwd);
core.setOutput("mode", result.mode);
if (result.mode === "publish") {
const publishPlanArtifact = await artifact.uploadArtifact(
path.basename(result.publishPlanPath, ".json"),
[result.publishPlanPath],
path.dirname(result.publishPlanPath),
{
skipArchive: true,
retentionDays: 30,
},
);
if (publishPlanArtifact.id === undefined) {
throw new Error(
"Publish plan artifact upload did not return an artifact id",
);
}
core.setOutput("publish-plan-artifact-id", String(publishPlanArtifact.id));
}
}
async function getMode(cwd: string): Promise<ModeResult> {
const { changesets } = await readChangesetState(cwd);
if (changesets.length > 0) {
const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0,
);
if (hasNonEmptyChangesets) {
return { mode: "version" };
}
return { mode: "none" };
}
const publishPlanPath = path.join(
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
`changeset-publish-plan-${Date.now()}`,
// we need a stable filename here (in a unique dirname) so the artifact download can find this cleanly
"publish-plan.json",
);
await execChangesetsCli(["publish-plan", "--output", publishPlanPath], {
cwd,
env: process.env,
});
const publishPlan = await readPublishPlan(publishPlanPath);
if (publishPlan.length === 0) {
return { mode: "none" };
}
return {
mode: "publish",
publishPlanPath,
};
}
async function readPublishPlan(publishPlanPath: string): Promise<PublishPlan> {
let rawPlan: string;
try {
rawPlan = await fs.readFile(publishPlanPath, "utf8");
} catch (err) {
throw new Error(`Failed to read publish plan at ${publishPlanPath}`, {
cause: err,
});
}
let plan: unknown;
try {
plan = JSON.parse(rawPlan);
} catch (err) {
throw new Error(`Failed to parse publish plan at ${publishPlanPath}`, {
cause: err,
});
}
if (
typeof plan !== "object" ||
plan === null ||
!("version" in plan) ||
typeof plan.version !== "number" ||
!("plan" in plan) ||
!Array.isArray(plan.plan)
) {
throw new Error(
`Invalid publish plan at ${publishPlanPath}: expected { version: number; plan: unknown[] }`,
);
}
return plan.plan;
}
-293
View File
@@ -1,293 +0,0 @@
import assert from "node:assert/strict";
import { spawn } from "node:child_process";
import fsp from "node:fs/promises";
import http, { type IncomingMessage, type ServerResponse } from "node:http";
import path from "node:path";
import { pathToFileURL } from "node:url";
import { createFixture, type FileTree } from "fs-fixture";
import { exec } from "tinyexec";
import { moveDisposable } from "./utils.ts";
export type Fixture = FileTree;
export async function testdir(dir?: Fixture) {
return createFixture(dir, {
fs: {
...fsp,
rm: (filePath, options) =>
fsp.rm(filePath, {
maxRetries: 3,
retryDelay: 100,
...options,
}),
},
});
}
// Git maintenance can race with fixture cleanup by touching pack files.
export async function disableGitBackgroundMaintenance(cwd: string) {
await exec("git", ["config", "gc.auto", "0"], {
nodeOptions: { cwd },
throwOnError: true,
});
await exec("git", ["config", "maintenance.auto", "false"], {
nodeOptions: { cwd },
throwOnError: true,
});
}
export async function gitdir(dir: Fixture) {
await using stack = new AsyncDisposableStack();
const fixture = stack.use(
await testdir({
".gitattributes": "* text=auto eol=lf\n",
...dir,
}),
);
const cwd = fixture.path;
await exec("git", ["init"], {
nodeOptions: { cwd },
throwOnError: true,
});
await disableGitBackgroundMaintenance(cwd);
const { stdout } = await exec("git", ["rev-parse", "--abbrev-ref", "HEAD"], {
nodeOptions: { cwd },
});
if (stdout.trim() !== "main") {
await exec("git", ["checkout", "-b", "main"], {
nodeOptions: { cwd },
throwOnError: true,
});
}
const gitConfig = `
[user]
email = x@y.z
name = xyz
[commit]
gpgSign = false
[tag]
gpgSign = false
forceSignAnnotated = false
`.trim();
await fsp.appendFile(path.join(cwd, ".git/config"), gitConfig, "utf8");
await exec("git", ["add", "."], {
nodeOptions: { cwd },
throwOnError: true,
});
await exec("git", ["commit", "-m", "initial commit", "--allow-empty"], {
nodeOptions: { cwd },
throwOnError: true,
});
return moveDisposable(stack, fixture);
}
export async function shallowClone(cwd: string, depth = 1) {
await using stack = new AsyncDisposableStack();
const fixture = stack.use(await testdir());
await exec(
"git",
["clone", "--depth", depth.toString(), pathToFileURL(cwd).toString(), "."],
{
nodeOptions: { cwd: fixture.path },
throwOnError: true,
},
);
await disableGitBackgroundMaintenance(fixture.path);
return moveDisposable(stack, fixture);
}
async function runGitHttpBackend(
cwd: string,
request: IncomingMessage,
response: ServerResponse,
) {
// `git http-backend` speaks CGI: request metadata goes through environment
// variables, the request body through stdin, and the response through stdout.
const requestUrl = new URL(
request.url ?? "/",
`http://${request.headers.host ?? "localhost"}`,
);
const env: NodeJS.ProcessEnv = {
...process.env,
CONTENT_LENGTH: request.headers["content-length"] ?? "0",
GATEWAY_INTERFACE: "CGI/1.1",
GIT_HTTP_EXPORT_ALL: "1",
GIT_PROJECT_ROOT: cwd,
PATH_INFO: decodeURIComponent(requestUrl.pathname),
QUERY_STRING: requestUrl.search.slice(1),
REMOTE_ADDR: request.socket.remoteAddress ?? "",
REQUEST_METHOD: request.method ?? "GET",
SERVER_PROTOCOL: `HTTP/${request.httpVersion}`,
};
if (request.headers["content-type"] !== undefined) {
env.CONTENT_TYPE = request.headers["content-type"];
}
const backend = spawn("git", ["http-backend"], {
env,
stdio: ["pipe", "pipe", "pipe"],
});
request.pipe(backend.stdin);
// Buffer stdout so the CGI headers can be separated from the response body.
// Keep stderr only to explain a backend failure.
const stdout: Buffer[] = [];
const stderr: Buffer[] = [];
backend.stdout.on("data", (chunk: Buffer) => stdout.push(chunk));
backend.stderr.on("data", (chunk: Buffer) => stderr.push(chunk));
const exitCode = await new Promise<number | null>((resolve, reject) => {
backend.on("error", reject);
backend.on("close", resolve);
});
if (exitCode !== 0) {
throw new Error(
`git http-backend exited with ${exitCode}: ${Buffer.concat(stderr).toString("utf8")}`,
);
}
const output = Buffer.concat(stdout);
// CGI ends its response headers with a blank line; accept CRLF and LF output.
let separator = Buffer.from("\r\n\r\n");
let headerEnd = output.indexOf(separator);
if (headerEnd === -1) {
separator = Buffer.from("\n\n");
headerEnd = output.indexOf(separator);
}
if (headerEnd === -1) {
throw new Error("git http-backend returned an invalid CGI response");
}
// Translate CGI status and headers, then forward the remaining bytes as body.
let status = 200;
const headers = output.subarray(0, headerEnd).toString("utf8").split(/\r?\n/);
for (const header of headers) {
const separatorIndex = header.indexOf(":");
if (separatorIndex === -1) continue;
const name = header.slice(0, separatorIndex);
const value = header.slice(separatorIndex + 1).trim();
if (name.toLowerCase() === "status") {
status = Number.parseInt(value, 10);
} else {
response.setHeader(name, value);
}
}
response.writeHead(status);
response.end(output.subarray(headerEnd + separator.length));
}
async function listen(server: http.Server) {
const waiter = Promise.withResolvers();
server.on("listening", waiter.resolve);
server.on("error", waiter.reject);
server.listen(0);
try {
await waiter.promise;
return server;
} finally {
server.off("listening", waiter.resolve);
server.off("error", waiter.reject);
}
}
type RecordedRequest = {
method: string;
url: string;
headers: NodeJS.Dict<string[]>;
};
function recordRequest(request: IncomingMessage): RecordedRequest {
return {
method: request.method ?? "GET",
url: request.url ?? "/",
headers: request.headersDistinct,
};
}
async function createGitHttpServer(cwd: string) {
const requests: RecordedRequest[] = [];
const server = http.createServer((request, response) => {
const recordedRequest = recordRequest(request);
requests.push(recordedRequest);
void runGitHttpBackend(cwd, request, response).catch((error: unknown) => {
response.destroy(
Error.isError(error)
? error
: new Error("Server error", { cause: error }),
);
});
});
await listen(server);
const address = server.address();
assert(
!!address && typeof address !== "string",
"Failed to get server address",
);
return {
origin: `http://127.0.0.1:${address.port}`,
requests,
async [Symbol.asyncDispose]() {
await new Promise<void>((resolve, reject) => {
server.close((error) => {
if (error) {
reject(error);
return;
}
resolve();
});
});
},
};
}
async function createLocalRemote(dir: Fixture) {
await using stack = new AsyncDisposableStack();
const fixture = stack.use(await testdir());
const remote = fixture.path;
{
// Use a working repository to create the bare remote's initial history.
// Once cloned, the remote owns that history and the source can be disposed.
await using sourceFixture = await gitdir(dir);
await exec(
"git",
["clone", "--bare", pathToFileURL(sourceFixture.path).toString(), "."],
{
nodeOptions: { cwd: remote },
throwOnError: true,
},
);
}
await disableGitBackgroundMaintenance(remote);
await exec("git", ["config", "http.receivepack", "true"], {
nodeOptions: { cwd: remote },
throwOnError: true,
});
return moveDisposable(stack, fixture);
}
export async function createGitHttpRemote(files: Fixture) {
await using stack = new AsyncDisposableStack();
const fixture = stack.use(await createLocalRemote(files));
const server = stack.use(
await createGitHttpServer(path.dirname(fixture.path)),
);
return moveDisposable(stack, {
path: fixture.path,
url: `${server.origin}/${path.basename(fixture.path)}`,
requests: server.requests,
});
}
+2 -72
View File
@@ -1,12 +1,5 @@
import { createFixture } from "fs-fixture"; import { expect, test } from "vitest";
import { afterEach, expect, test, vi } from "vitest"; import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts";
import {
BumpLevels,
getChangelogEntry,
sortTheThings,
throwOnRemovedCommitModeInput,
validateChangesetsCliVersion,
} from "./utils.ts";
let changelog = `# @keystone-alpha/email let changelog = `# @keystone-alpha/email
@@ -75,10 +68,6 @@ let changelog = `# @keystone-alpha/email
- Update mjml-dependency - Update mjml-dependency
`; `;
afterEach(() => {
vi.unstubAllEnvs();
});
test("it works", () => { test("it works", () => {
let entry = getChangelogEntry(changelog, "3.0.0"); let entry = getChangelogEntry(changelog, "3.0.0");
expect(entry.content).toMatchSnapshot(); expect(entry.content).toMatchSnapshot();
@@ -111,62 +100,3 @@ test("it sorts the things right", () => {
]; ];
expect(things.sort(sortTheThings)).toMatchSnapshot(); expect(things.sort(sortTheThings)).toMatchSnapshot();
}); });
test.each([
["commit-mode", "git-cli", "push-with-git-cli: true"],
["commit-mode", "github-api", "push-with-git-cli: false"],
["commitMode", "git-cli", "push-with-git-cli: true"],
["commitMode", "github-api", "push-with-git-cli: false"],
])(
"explains how to migrate the removed %s input from %s",
(inputName, value, replacement) => {
vi.stubEnv(`INPUT_${inputName.toUpperCase()}`, value);
expect(() => throwOnRemovedCommitModeInput()).toThrow(replacement);
},
);
test("throws when the project declares Changesets CLI v2", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^2.29.7" },
}),
"package-lock.json": "",
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
test("accepts a Changesets CLI v3 contract without an installed CLI", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
});
await expect(
validateChangesetsCliVersion(fixture.path),
).resolves.toBeUndefined();
});
test("throws when the project has Changesets CLI v2 installed", async () => {
await using fixture = await createFixture({
"package.json": JSON.stringify({
name: "project",
devDependencies: { "@changesets/cli": "^3.0.0" },
}),
"package-lock.json": "",
"node_modules/@changesets/cli/package.json": JSON.stringify({
name: "@changesets/cli",
version: "2.29.7",
}),
});
await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
"This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
);
});
+46 -217
View File
@@ -1,19 +1,11 @@
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 { createRequire } from "node:module"; import type { Root } from "mdast";
import path from "node:path"; // @ts-ignore
import artifact from "@actions/artifact"; import mdastToString from "mdast-util-to-string";
import * as core from "@actions/core";
import {
exec,
getExecOutput,
type ExecOptions as ActionsExecOptions,
type ExecOutput,
} from "@actions/exec";
import { getPackages, type Package } from "@manypkg/get-packages"; import { getPackages, type Package } from "@manypkg/get-packages";
import major from "semver/functions/major.js";
import subset from "semver/ranges/subset.js";
const require = createRequire(import.meta.url);
export const BumpLevels = { export const BumpLevels = {
dep: 0, dep: 0,
@@ -29,7 +21,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>();
@@ -45,61 +37,57 @@ 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;
// Iterate through each headings and code blocks (for skipping its contents) for (let i = 0; i < nodes.length; i++) {
const regex = /^(#{1,6})\s(.*)$|^(`{3,})/gm; let node = nodes[i];
let match: RegExpExecArray | null; if (node.type === "heading") {
while ((match = regex.exec(changelog)) != null) { let stringified: string = mdastToString(node);
// Skip over code blocks so we don't match any headings inside of them let match = stringified.toLowerCase().match(/(major|minor|patch)/);
if (match[3]) { if (match !== null) {
const endOfCodeBlockRegex = new RegExp(`^${match[3]}`, "gm"); let level = BumpLevels[match[0] as "major" | "minor" | "patch"];
endOfCodeBlockRegex.lastIndex = regex.lastIndex;
const endMatch = endOfCodeBlockRegex.exec(changelog);
if (endMatch) {
// Start next search for headings after the end of the code block
regex.lastIndex = endOfCodeBlockRegex.lastIndex;
continue;
} else {
// Can't find end of code block, probably malformed
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); highestLevel = Math.max(level, highestLevel);
} }
if (headingStartInfo === undefined && stringified === version) {
// Search for heading of the entry headingStartInfo = {
if (headingText === version) { index: i,
headingStartInfo = { index: regex.lastIndex, depth: headingDepth }; depth: node.depth,
};
continue; continue;
} }
if (
// If we've found the entry heading, search for the closing heading with the same depth endIndex === undefined &&
if (headingStartInfo && headingDepth === headingStartInfo.depth) { headingStartInfo !== undefined &&
endIndex = match.index; headingStartInfo.depth === node.depth
) {
endIndex = i;
break; break;
} }
} }
}
if (headingStartInfo) {
ast.children = ast.children.slice(headingStartInfo.index + 1, endIndex);
}
return { return {
content: changelog.slice(headingStartInfo?.index, endIndex).trim(), content: unified().use(remarkStringify).stringify(ast),
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;
@@ -119,168 +107,9 @@ export function isErrorWithCode(err: unknown, code: string) {
); );
} }
export type WithAsyncDispose<T> = T & { export function fileExists(filePath: string) {
[Symbol.asyncDispose](): Promise<void>; return fs.access(filePath, fs.constants.F_OK).then(
}; () => true,
() => false
export function moveDisposable<T extends object>(
stack: AsyncDisposableStack,
value: T,
): WithAsyncDispose<T> {
const moved = stack.move();
return Object.assign(value, {
async [Symbol.asyncDispose]() {
await moved.disposeAsync();
},
});
}
export function getOptionalInput(name: string) {
// normalize empty string default return value of `core.getInput` to undefined
return core.getInput(name) || undefined;
}
export function getRequiredInput(name: string) {
// it's just a small utility wrapper, mainly introduced for usage parity with our custom `getOptionalInput`
// note: `core.getBooleanInput` gets used directly as it already normalizes the return value nicely
return core.getInput(name, { required: true });
}
export function throwOnRemovedCommitModeInput() {
for (const inputName of ["commit-mode", "commitMode"]) {
const value = getOptionalInput(inputName);
if (value === undefined) continue;
const migration =
value === "git-cli"
? 'Replace it with "push-with-git-cli: true".'
: value === "github-api"
? 'Remove it or replace it with "push-with-git-cli: false"; GitHub API pushes are now the default.'
: 'Set "push-with-git-cli" to true for Git CLI pushes or false for GitHub API pushes.';
throw new Error(
`The "${inputName}" input has been replaced by the boolean "push-with-git-cli" input. ${migration}`,
); );
} }
}
export function throwOnRenamedInputs(renames: Record<string, string>) {
const references: Record<string, string> = {};
for (const [oldInput, newInput] of Object.entries(renames)) {
if (core.getInput(oldInput)) {
references[oldInput] = newInput;
}
}
if (Object.keys(references).length > 0) {
const list = Object.entries(references)
.map(([oldInput, newInput]) => `- "${oldInput}" -> "${newInput}"`)
.join("\n");
throw new Error(
`The following inputs have been renamed:\n${list}\nPlease update your workflow file.`,
);
}
}
const changesetsCliCompatibilityError =
"This version of the Changesets action is designed to work with Changesets CLI v3. " +
"Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.";
export async function validateChangesetsCliVersion(cwd: string) {
const { rootPackage } = await getPackages(cwd);
const packageJson = rootPackage?.packageJson;
const declaredVersion =
packageJson?.devDependencies?.["@changesets/cli"] ??
packageJson?.dependencies?.["@changesets/cli"];
if (typeof declaredVersion === "string") {
const range = declaredVersion.startsWith("workspace:")
? declaredVersion.slice("workspace:".length)
: declaredVersion;
let isV2 = false;
try {
isV2 = subset(range, ">=2.0.0-0 <3.0.0-0", {
includePrerelease: true,
});
} catch {
// it could be a non-semver protocol
}
if (isV2) {
throw new Error(changesetsCliCompatibilityError);
}
}
let cliPackageJson;
try {
cliPackageJson = require(
require.resolve("@changesets/cli/package.json", { paths: [cwd] }),
);
} catch {
return;
}
if (
typeof cliPackageJson.version === "string" &&
major(cliPackageJson.version) === 2
) {
throw new Error(changesetsCliCompatibilityError);
}
}
function resolveChangesetsCli(cwd: string) {
return require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
});
}
interface ExecOptions extends Omit<ActionsExecOptions, "env"> {
env?: Record<string, string | undefined>;
}
export function execChangesetsCli(args: string[], options?: ExecOptions) {
return exec(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export function getExecOutputChangesetsCli(
args: string[],
options?: ExecOptions,
): Promise<ExecOutput> {
return getExecOutput(
"node",
[resolveChangesetsCli(options?.cwd ?? process.cwd()), ...args],
options as ActionsExecOptions,
);
}
export async function downloadArtifact(
tmpDir: string,
artifactId: number,
name: string,
) {
if (!Number.isInteger(artifactId) || artifactId <= 0) {
throw new Error(
`Invalid ${JSON.stringify(name)} artifact id: ${artifactId}`,
);
}
const downloadPath = path.join(tmpDir, `${name}-${artifactId}-${Date.now()}`);
const result = await artifact.downloadArtifact(artifactId, {
path: downloadPath,
});
if (!result.downloadPath) {
throw new Error(
`${JSON.stringify(name)} artifact download did not return a path for artifact ${artifactId}`,
);
}
return result.downloadPath;
}
-53
View File
@@ -1,53 +0,0 @@
import * as core from "@actions/core";
import { GitHub } from "../github.ts";
import { runVersion } from "../run.ts";
import {
getOptionalInput,
getRequiredInput,
throwOnRemovedCommitModeInput,
validateChangesetsCliVersion,
} from "../utils.ts";
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const cwd = getOptionalInput("cwd") || process.cwd();
await validateChangesetsCliVersion(cwd);
throwOnRemovedCommitModeInput();
const githubToken = getRequiredInput("github-token");
const script = getOptionalInput("script");
const commitMessage = getRequiredInput("commit-message");
const prTitle = getRequiredInput("pr-title");
const prDraft = getOptionalInput("pr-draft");
const prBaseBranch = getOptionalInput("pr-base-branch");
const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
// Validations
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
throw new Error(`Invalid pr-draft input: ${prDraft}`);
}
const github = new GitHub({
cwd,
githubToken,
pushWithGitCli,
});
const { pullRequestNumber } = await runVersion({
script,
github,
cwd,
prTitle,
commitMessage,
// TODO: Use neutral message for PR description
hasPublishScript: true,
prDraft,
branch: prBaseBranch,
});
core.setOutput("pr-number", String(pullRequestNumber));
}
+7 -4
View File
@@ -1,11 +1,14 @@
{ {
"extends": "@tsconfig/node24/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"allowImportingTsExtensions": true, "allowImportingTsExtensions": true,
"erasableSyntaxOnly": true, "erasableSyntaxOnly": true,
"verbatimModuleSyntax": true, "isolatedModules": true,
"strict": true, "module": "node18",
"moduleResolution": "node16",
"noEmit": true, "noEmit": true,
"types": ["node"] "resolveJsonModule": true,
"strict": true,
"target": "esnext",
"verbatimModuleSyntax": true
} }
} }
+17
View File
@@ -0,0 +1,17 @@
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;
};
}
-43
View File
@@ -1,43 +0,0 @@
# changesets/action/version
This action versions packages and creates or updates a pull request with the changes.
## Requirements
- Needs repo checked out and `@changesets/cli` installed
- [Job permissions][job-permissions]:
- `contents: write`: to commit version changes
- `pull-requests: write`: to create pull request
- [Workflow triggers][workflow-triggers]: _any_
> [!NOTE]
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
## Usage
> [!TIP]
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
## API
<!-- api-start -->
| Inputs | Description |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
| `script` | The command to use to version packages |
| `commit-message` | The commit message. Default to `Version Packages` |
| `pr-title` | The pull request title. Default to `Version Packages` |
| `pr-draft` | Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them. |
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits. Defaults to `false`. When using the GitHub API, commits are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
| Outputs | Description |
| ----------- | --------------------------------------------------- |
| `pr-number` | The pull request number that was created or updated |
<!-- api-end -->
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
-45
View File
@@ -1,45 +0,0 @@
name: Changesets - Version
description: Version packages
runs:
using: node24
main: ../dist/version.js
inputs:
github-token:
description: >
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
To use a custom token, pass it explicitly to this input.
required: false
default: ${{ github.token }}
script:
description: "The command to use to version packages"
required: false
commit-message:
description: "The commit message. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-title:
description: "The pull request title. Default to `Version Packages`"
required: false
default: "Version Packages"
pr-draft:
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
required: false
pr-base-branch:
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
required: false
push-with-git-cli:
description: >
Whether to use the Git CLI instead of the GitHub API to push release commits.
Defaults to `false`. When using the GitHub API, commits are signed using GitHub's
GPG key and attributed to the user or app that owns the `github-token`.
required: false
default: false
cwd:
description: "The working directory to execute Changesets in. Defaults to the root of the repository."
required: false
outputs:
pr-number:
description: The pull request number that was created or updated
branding:
icon: package
color: blue
+3069
View File
File diff suppressed because it is too large Load Diff