Compare commits

..
1 Commits
Author SHA1 Message Date
github-actions[bot] aba318e916 v1.4.7 2024-03-19 02:11:34 +00:00
61 changed files with 5947 additions and 5078 deletions
+6
View File
@@ -0,0 +1,6 @@
{
"presets": [
["@babel/preset-env", { "targets": { "node": 10 } }],
"@babel/preset-typescript"
]
}
-5
View File
@@ -1,5 +0,0 @@
/.github/workflows/** @Andarist @bluwy @emmatown
/action.yml @Andarist @bluwy @emmatown
/scripts/bump.ts @Andarist @bluwy @emmatown
/scripts/release.ts @Andarist @bluwy @emmatown
/scripts/release-pr.ts @Andarist @bluwy @emmatown
-24
View File
@@ -1,24 +0,0 @@
name: Setup CI
description: Setup CI
inputs:
skip-cache:
description: "Whether to skip the cache"
required: false
default: "false"
runs:
using: composite
steps:
- name: Set up pnpm
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version-file: ".node-version"
package-manager-cache: ${{ inputs.skip-cache != 'true' }}
cache: ${{ inputs.skip-cache != 'true' && 'pnpm' || '' }}
- name: Install dependencies
shell: bash
run: pnpm install --frozen-lockfile
-13
View File
@@ -1,13 +0,0 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
cooldown:
default-days: 7
+14 -84
View File
@@ -1,94 +1,24 @@
name: CI name: Node CI
on: on: [pull_request]
pull_request:
# merge queue is required so all commits on target branches trigger this workflow
# despite lack of the push event trigger here
merge_group:
branches:
- main
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.sha }}
cancel-in-progress: true
jobs: jobs:
lint-workflows: build:
name: Lint workflows
runs-on: ubuntu-latest
permissions:
actions: read # only required in private repos
security-events: write # allow writing security events
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Run zizmor
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
with:
persona: pedantic
annotations: true
advanced-security: false
test:
name: Test
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out repo - name: Checkout Repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 uses: actions/checkout@v2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup - name: Use Node.js 20
uses: actions/setup-node@v1
with:
node-version: 20.x
- name: Install Dependencies
run: yarn --frozen-lockfile
- name: Test - name: Test
run: pnpm test run: yarn test
typecheck:
name: Typecheck
timeout-minutes: 20
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Typecheck
run: pnpm typecheck
lint:
name: Lint
timeout-minutes: 20
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
- name: Format
run: pnpm format
ci-ok:
name: CI OK
runs-on: ubuntu-latest
if: always()
needs: [lint-workflows, test, typecheck, lint]
steps:
- name: Exit with error if some jobs are not successful
run: exit 1
if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
-86
View File
@@ -1,86 +0,0 @@
name: Publish
on:
push:
branches:
- main
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
queue: max
permissions: {} # each job should define its own permission explicitly
jobs:
version:
name: Version
runs-on: ubuntu-latest
environment: version
timeout-minutes: 20
outputs:
hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
permissions:
contents: write # to create release (changesets/action)
issues: write # to post issue comments (changesets/action)
pull-requests: write # to create pull request (changesets/action)
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Create or update release pull request
id: changesets
uses: ./
with:
github-token: ${{ steps.app-token.outputs.token }}
version: pnpm bump
publish:
name: Publish
if: needs.version.outputs.hasChangesets == 'false'
needs: version
runs-on: ubuntu-latest
environment: marketplace
timeout-minutes: 20
permissions:
contents: write # to create release and have it authored by github-actions (changesets/action)
steps:
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: true
# we need this token to bypass the branch and tag protection rules
token: ${{ steps.app-token.outputs.token }}
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Build
run: pnpm build
- name: Publish to marketplace
uses: ./
with:
publish: pnpm release
-242
View File
@@ -1,242 +0,0 @@
name: Release PR
on:
issue_comment:
types: [created]
concurrency:
group: ${{ github.workflow }}-${{ github.run_id }}
cancel-in-progress: true
permissions: {}
jobs:
release_check:
name: Validate release request
if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr')
timeout-minutes: 5
runs-on: ubuntu-latest
permissions:
contents: read # to inspect the pull request commit state (changesets/action)
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: read # to inspect the pull request head state (changesets/action)
steps:
- id: report_in_progress
run: |
in_progress_reaction_id=$(gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='eyes' --jq '.id')
echo "in_progress_reaction_id=$in_progress_reaction_id" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- id: parse_command
run: |
if [[ "$COMMENT_BODY" =~ ^/release-pr[[:space:]]+([0-9a-fA-F]{7,40})[[:space:]]*$ ]]
then
echo "requested_sha=${BASH_REMATCH[1]}" >> "$GITHUB_OUTPUT"
else
echo "Expected '/release-pr <sha>' where <sha> is a 7-40 character commit SHA."
exit 1
fi
env:
COMMENT_BODY: ${{ github.event.comment.body }}
- id: check_authorization
run: |
if [[ "$AUTHOR_ASSOCIATION" == 'MEMBER' || "$AUTHOR_ASSOCIATION" == 'OWNER' || "$AUTHOR_ASSOCIATION" == 'COLLABORATOR' ]]
then
echo "User is authorized to release"
else
echo "User is not authorized to release"
exit 1
fi
env:
AUTHOR_ASSOCIATION: ${{ github.event.comment.author_association }}
- id: resolve_requested_sha
run: |
requested_sha=$(echo "$REQUESTED_SHA" | tr '[:upper:]' '[:lower:]')
mapfile -t matches < <(
gh api "/repos/$GH_REPO/pulls/$ISSUE_NUMBER/commits" --paginate --jq '.[].sha' |
awk -v sha="$requested_sha" 'index(tolower($0), sha) == 1 { print $0 }'
)
if [[ ${#matches[@]} -eq 0 ]]
then
echo "Requested SHA $REQUESTED_SHA is not part of this pull request."
exit 1
fi
if [[ ${#matches[@]} -gt 1 ]]
then
echo "Requested SHA $REQUESTED_SHA is ambiguous for this pull request."
exit 1
fi
resolved_sha="${matches[0]}"
pr_head_sha=$(gh pr view "$ISSUE_NUMBER" --json headRefOid --jq '.headRefOid')
if [[ "$resolved_sha" != "$pr_head_sha" ]]
then
echo "Requested SHA $resolved_sha is not the current PR head $pr_head_sha."
exit 1
fi
echo "resolved_sha=$resolved_sha" >> "$GITHUB_OUTPUT"
echo "pr_head_sha=$pr_head_sha" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
REQUESTED_SHA: ${{ steps.parse_command.outputs.requested_sha }}
- id: get_pr_head_repository
run: |
head_repository=$(gh pr view "$ISSUE_NUMBER" --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')
echo "head_repository=$head_repository" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
outputs:
in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }}
requested_sha: ${{ steps.parse_command.outputs.requested_sha }}
resolved_sha: ${{ steps.resolve_requested_sha.outputs.resolved_sha }}
pr_head_sha: ${{ steps.resolve_requested_sha.outputs.pr_head_sha }}
head_repository: ${{ steps.get_pr_head_repository.outputs.head_repository }}
release:
name: Release snapshot
if: github.repository == 'changesets/action'
timeout-minutes: 20
runs-on: ubuntu-latest
needs: release_check
permissions:
contents: write # to create the release commit and publish snapshot artifacts (changesets/action)
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write # to comment on the pull request with the release result (changesets/action)
steps:
- name: Check out repo
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: ./.github/actions/ci-setup
with:
skip-cache: true # avoid cache poisoning attacks
- name: Fetch validated commit from pull request head repository
run: |
git remote add pr-head "https://github.com/$HEAD_REPOSITORY.git"
git fetch --no-tags pr-head "$RESOLVED_SHA"
env:
HEAD_REPOSITORY: ${{ needs.release_check.outputs.head_repository }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Checkout validated commit
run: git checkout --detach "$RESOLVED_SHA"
env:
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
- name: Check if Version Packages PR
id: check_version_packages
run: |
version_packages=$(gh pr view "$ISSUE_NUMBER" --json headRefName --jq '.headRefName|startswith("changeset-release/")')
echo "version_packages=$version_packages" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Reset Version Packages PR
if: steps.check_version_packages.outputs.version_packages == 'true'
run: git reset --hard HEAD~1
- name: Create snapshot version
run: pnpm changeset version --snapshot "pr$ISSUE_NUMBER"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
- name: Build
run: pnpm build
- name: Setup Git user
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Release snapshot version
run: pnpm release:pr
- name: Add success reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='rocket'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- name: Comment success
run: |
published_commit="$(git rev-parse HEAD)"
body="The release for \`$RESOLVED_SHA\` triggered by [this comment]($COMMENT_URL) has [succeeded]($RUN_URL). Published commit: [$GH_REPO@$published_commit](https://github.com/$GH_REPO/commit/$published_commit)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
RESOLVED_SHA: ${{ needs.release_check.outputs.resolved_sha }}
report-failure-if-needed:
name: Report failure
needs: [release_check, release]
timeout-minutes: 2
runs-on: ubuntu-latest
if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure')
permissions:
issues: write # to add and remove reactions on the triggering comment (changesets/action)
pull-requests: write # to comment on the pull request with the failure result (changesets/action)
steps:
- name: Add failure reaction
run: gh api "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions" -f content='-1'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
- name: Remove in-progress reaction
run: gh api -X DELETE "/repos/$GH_REPO/issues/comments/$COMMENT_ID/reactions/$IN_PROGRESS_REACTION_ID"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
COMMENT_ID: ${{ github.event.comment.id }}
IN_PROGRESS_REACTION_ID: ${{ needs.release_check.outputs.in_progress_reaction_id }}
- name: Comment failure
run: |
body="The release for \`$REQUESTED_SHA\` triggered by [this comment]($COMMENT_URL) has [failed]($RUN_URL)."
gh pr comment "$ISSUE_NUMBER" --body "$body"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
COMMENT_URL: ${{ github.event.comment.url }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
REQUESTED_SHA: ${{ needs.release_check.outputs.requested_sha }}
+35
View File
@@ -0,0 +1,35 @@
name: Version or Publish
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
changesets:
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v2
- name: Use Node.js 20
uses: actions/setup-node@v1
with:
node-version: 20.x
- name: Install Dependencies
run: yarn --frozen-lockfile
- name: Build
run: yarn build
- name: Create Release Pull Request or Publish
id: changesets
uses: ./
with:
version: yarn bump
publish: yarn release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-1
View File
@@ -1 +0,0 @@
v24.11.0
-7
View File
@@ -1,7 +0,0 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"printWidth": 80,
"sortImports": {
"newlinesBetween": false
}
}
-16
View File
@@ -1,16 +0,0 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Debug Current Test File",
"autoAttachChildProcesses": true,
"skipFiles": [],
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
"args": ["run", "${relativeFile}"],
"smartStep": true,
"console": "integratedTerminal"
}
]
}
-4
View File
@@ -1,4 +0,0 @@
{
"js/ts.tsdk.path": "node_modules/typescript/lib",
"editor.defaultFormatter": "oxc.oxc-vscode"
}
-111
View File
@@ -1,116 +1,5 @@
# @changesets/action # @changesets/action
## 1.9.0
### Minor Changes
- [#636](https://github.com/changesets/action/pull/636) [`b072bcc`](https://github.com/changesets/action/commit/b072bccc4c664a373c42168eed9139dce1e003b1) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-comment` sub-action to comment on PRs
- [#625](https://github.com/changesets/action/pull/625) [`8795eee`](https://github.com/changesets/action/commit/8795eee5eee884e887d352ac673a515ffe35aaa6) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-status` sub-action to generate the changeset status comment for PRs as an alternative to the [Changesets Bot](https://github.com/apps/changeset-bot).
### Patch Changes
- [#535](https://github.com/changesets/action/pull/535) [`34f64f6`](https://github.com/changesets/action/commit/34f64f6e2e1e47ddc183f174aa27c197aa47f520) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with GitHub releases not being created for successfully published packages when _some_ packages failed to be published to the registry.
- [#632](https://github.com/changesets/action/pull/632) [`1d54b9e`](https://github.com/changesets/action/commit/1d54b9e660e435237accbcae0b4581af3be641b4) Thanks [@bluwy](https://github.com/bluwy)! - Simplify internal implementation to get changelog entries for a package version
- [#629](https://github.com/changesets/action/pull/629) [`e0c90aa`](https://github.com/changesets/action/commit/e0c90aa7fbd0cc26931a679c5abe9bbc0deb0b50) Thanks [@bluwy](https://github.com/bluwy)! - Fix custom version and publish command argument parsing
- [#645](https://github.com/changesets/action/pull/645) [`f9585d9`](https://github.com/changesets/action/commit/f9585d966a9c7d2f668b97199990de6f885823cf) Thanks [@Andarist](https://github.com/Andarist)! - Improved force-push handling when using `commitMode: "github-api"` so updating an existing branch no longer temporarily resets the target branch to the base commit, avoiding cases where GitHub closes open pull requests during the update. This should remove a possibility of a GitHub state race that caused the force-pushed PRs not being reopened.
## 1.8.0
### Minor Changes
- [#258](https://github.com/changesets/action/pull/258) [`f5dbf72`](https://github.com/changesets/action/commit/f5dbf72f96949cb0daf45152f0f63062df70e97d) Thanks [@tom-sherman](https://github.com/tom-sherman)! - Support draft version PR modes with a new `prDraft` input. Use `create` to create new version PRs as drafts, or `always` to also convert existing version PRs back to draft when updating them.
### Patch Changes
- [#502](https://github.com/changesets/action/pull/502) [`6002dbd`](https://github.com/changesets/action/commit/6002dbd987f49a3c0a134910d9c7bca975b79977) Thanks [@oshytiko](https://github.com/oshytiko)! - Fixed initial `.changeset` state being picked up, when `cwd` parameter is provided
- [#536](https://github.com/changesets/action/pull/536) [`81b3f61`](https://github.com/changesets/action/commit/81b3f61ebffcb868f73e4c0b2682517149c834a2) Thanks [@radnan](https://github.com/radnan)! - Fixed `.changeset` state being picked for the version command when `cwd` parameter is provided
## 1.7.0
### Minor Changes
- [#564](https://github.com/changesets/action/pull/564) [`935fe87`](https://github.com/changesets/action/commit/935fe876b0054dfc962ac86bcddf028460040d46) Thanks [@Andarist](https://github.com/Andarist)! - Automatically use the GitHub-provided token to allow most users to avoid explicit `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` configuration.
### Patch Changes
- [#545](https://github.com/changesets/action/pull/545) [`54220dd`](https://github.com/changesets/action/commit/54220dd92c06e7da112b139f95d8beb933e4cdde) Thanks [@ryanbas21](https://github.com/ryanbas21)! - The `.npmrc` generation now intelligently handles both traditional NPM token authentication and trusted publishing scenarios by only appending the auth token when `NPM_TOKEN` is defined. This prevents 'undefined' from being written to the registry configuration when using OIDC tokens from GitHub Actions trusted publishing.
- [#563](https://github.com/changesets/action/pull/563) [`6af4a7e`](https://github.com/changesets/action/commit/6af4a7ec080d23ac6b304f69b67fd0aa92e089e7) Thanks [@Andarist](https://github.com/Andarist)! - Don't error on already committed symlinks and executables that stay untouched
## 1.6.0
### Minor Changes
- [#558](https://github.com/changesets/action/pull/558) [`342005d`](https://github.com/changesets/action/commit/342005d41242bccd9dd9ae8d3679efce96af48ae) Thanks [@harsha-venugopal-ledn](https://github.com/harsha-venugopal-ledn)! - Upgrade from Node.js 20 to Node.js 24 LTS
## 1.5.3
### Patch Changes
- [#477](https://github.com/changesets/action/pull/477) [`9d933dc`](https://github.com/changesets/action/commit/9d933dcd11c284ac49a835db884c3c1008b2b96f) Thanks [@Andarist](https://github.com/Andarist)! - Updated `@actions/*` and `@octokit/*` dependencies.
- [#479](https://github.com/changesets/action/pull/479) [`cf373e4`](https://github.com/changesets/action/commit/cf373e45c90a0cc564cd2770de3e9a3a4cdd4603) Thanks [@Andarist](https://github.com/Andarist)! - Switched to `esbuild` for bundling the dist file. This led to 45% file size reduction.
- [#488](https://github.com/changesets/action/pull/488) [`022692b`](https://github.com/changesets/action/commit/022692ba027b33bf46d4d41907a317fbf04461a7) Thanks [@s0](https://github.com/s0)! - Fix PRs sometimes not getting reopened with `commitMode: github-api`
There was a race-condition that means sometimes existing PRs would not be found,
and new PRs would be opened. This has now been fixed by fetching existing PRs
before making any changes.
- [#486](https://github.com/changesets/action/pull/486) [`7ed1955`](https://github.com/changesets/action/commit/7ed195554624ebd75c08aa477b53110f61cc78f7) Thanks [@s0](https://github.com/s0)! - Fixed situations in which `cwd` was specified as a relative path and used with (default) `commitMode: git-cli`
- [#461](https://github.com/changesets/action/pull/461) [`e9c36b6`](https://github.com/changesets/action/commit/e9c36b696406360bf04204ad32e3dcf3ad752b77) Thanks [@nayounsang](https://github.com/nayounsang)! - Avoid hitting a deprecation warning when encountering errors from `@octokit/request-error`
## 1.5.2
### Patch Changes
- [#473](https://github.com/changesets/action/pull/473) [`3c24abe`](https://github.com/changesets/action/commit/3c24abeab26da6335c181222faa2ea485a092cf8) Thanks [@s0](https://github.com/s0)! - Make git add work consistently with subdirectories
Ensure that when running the action from a subdirectory of a repository,
only the files from that directory are added, regardless of `commitMode`.
## 1.5.1
### Patch Changes
- [#471](https://github.com/changesets/action/pull/471) [`15ab130`](https://github.com/changesets/action/commit/15ab1306067a396fa9ba7ad363e8a041d457782a) Thanks [@h3rmanj](https://github.com/h3rmanj)! - Bump `@changesets/ghcommit` to v1.4.0, which fixes an issue running this action in monorepos with `commitMode: github-api`
- [#467](https://github.com/changesets/action/pull/467) [`6e57550`](https://github.com/changesets/action/commit/6e575506e63f9e69e475d3eccfdd61b448efc8ae) Thanks [@Vx-V](https://github.com/Vx-V)! - Avoid searching for an existing pull request early.
## 1.5.0
### Minor Changes
- [#391](https://github.com/changesets/action/pull/391) [`207dc3d`](https://github.com/changesets/action/commit/207dc3da2d1907cae0454ce123935401332be72b) Thanks [@s0](https://github.com/s0)! - Introduce a new input `commitMode` that allows using the GitHub API for pushing tags and commits instead of the Git CLI.
When used with `"github-api"` value all tags and commits will be attributed to the user whose GITHUB_TOKEN is used, and also signed using GitHub's internal GPG key.
## 1.4.10
### Patch Changes
- [#448](https://github.com/changesets/action/pull/448) [`8b16070`](https://github.com/changesets/action/commit/8b16070fe386eed3456c83eeed9460160432cf26) Thanks [@bluwy](https://github.com/bluwy)! - Use full git email (`41898282+github-actions[bot]@users.noreply.github.com`) for github-actions bot when making commits
## 1.4.9
### Patch Changes
- [#415](https://github.com/changesets/action/pull/415) [`57ab80c`](https://github.com/changesets/action/commit/57ab80c61104c270bebc125910ae32da3a5aca46) Thanks [@benmccann](https://github.com/benmccann)! - Improve error message when attempting to publish without publish script defined
## 1.4.8
### Patch Changes
- [#393](https://github.com/changesets/action/pull/393) [`48ab0d2`](https://github.com/changesets/action/commit/48ab0d2f2e77ae169182d022591ef5c18c931ff2) Thanks [@s0](https://github.com/s0)! - Ensure the PR remains open when updated
- [#393](https://github.com/changesets/action/pull/393) [`48ab0d2`](https://github.com/changesets/action/commit/48ab0d2f2e77ae169182d022591ef5c18c931ff2) Thanks [@s0](https://github.com/s0)! - Switch to cheaper API for querying existing PRs
## 1.4.7 ## 1.4.7
### Patch Changes ### Patch Changes
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) Changesets team and other contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+36 -48
View File
@@ -1,11 +1,6 @@
# Changesets Release Action # Changesets Release Action
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you. This action for [Changesets](https://github.com/atlassian/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
There are also sub-actions hosted in this repository. Check out their respective READMEs for more details:
- [pr-status](./pr-status/README.md): Generate changeset status in PRs.
- [pr-comment](./pr-comment/README.md): Comment on PRs.
## Usage ## Usage
@@ -17,16 +12,14 @@ There are also sub-actions hosted in this repository. Check out their respective
- title - The pull request title. Default to `Version Packages` - title - The pull request title. Default to `Version Packages`
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true` - setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true` - createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()` - cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
### Outputs ### Outputs
- published - A boolean value to indicate whether a publishing has happened or not - published - A boolean value to indicate whether a publishing is happened or not
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` - publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
### Example workflow ### Example workflow:
#### Without Publishing #### Without Publishing
@@ -48,21 +41,20 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v6 uses: actions/checkout@v3
- name: Setup pnpm - name: Setup Node.js 20
uses: pnpm/action-setup@v6 uses: actions/setup-node@v3
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 26 node-version: 20
- name: Install Dependencies - name: Install Dependencies
run: pnpm install --frozen-lockfile run: yarn
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### With Publishing #### With Publishing
@@ -85,26 +77,24 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v6 uses: actions/checkout@v3
- name: Setup pnpm - name: Setup Node.js 20.x
uses: pnpm/action-setup@v6 uses: actions/setup-node@v3
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 26 node-version: 20.x
- name: Install Dependencies - name: Install Dependencies
run: pnpm install --frozen-lockfile run: yarn
- name: Create Release Pull Request or Publish to npm - name: Create Release Pull Request or Publish to npm
id: changesets id: changesets
uses: changesets/action@v1 uses: changesets/action@v1
with: with:
# This expects you to have a script called release which does a build for your packages and calls changeset publish # This expects you to have a script called release which does a build for your packages and calls changeset publish
publish: pnpm release publish: yarn release
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Send a Slack notification if a publish happens - name: Send a Slack notification if a publish happens
@@ -115,7 +105,7 @@ jobs:
By default the GitHub Action creates a `.npmrc` file with the following content: By default the GitHub Action creates a `.npmrc` file with the following content:
```txt ```
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN} //registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
``` ```
@@ -134,7 +124,7 @@ For example, you can add a step before running the Changesets GitHub Action:
#### Custom Publishing #### Custom Publishing
If you want to hook into when publishing should occur but have your own publishing functionality, you can utilize the `hasChangesets` output. 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. 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.
@@ -152,27 +142,26 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v6 uses: actions/checkout@v3
- name: Setup pnpm - name: Setup Node.js 20.x
uses: pnpm/action-setup@v6 uses: actions/setup-node@v3
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 26 node-version: 20.x
- name: Install Dependencies - name: Install Dependencies
run: pnpm install --frozen-lockfile run: yarn
- name: Create Release Pull Request or Publish to npm - name: Create Release Pull Request or Publish to npm
id: changesets id: changesets
uses: changesets/action@v1 uses: changesets/action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Publish - name: Publish
if: steps.changesets.outputs.hasChangesets == 'false' if: steps.changesets.outputs.hasChangesets == 'false'
# You can do something when a publish should happen. # You can do something when a publish should happen.
run: pnpm publish run: yarn publish
``` ```
#### With version script #### With version script
@@ -197,24 +186,23 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v6 uses: actions/checkout@v3
- name: Setup pnpm - name: Setup Node.js 20.x
uses: pnpm/action-setup@v6 uses: actions/setup-node@v3
- name: Setup Node.js 26
uses: actions/setup-node@v6
with: with:
node-version: 26 node-version: 20.x
- name: Install Dependencies - name: Install Dependencies
run: pnpm install --frozen-lockfile run: yarn
- name: Create Release Pull Request - name: Create Release Pull Request
uses: changesets/action@v1 uses: changesets/action@v1
with: with:
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`. # this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
version: pnpm version version: yarn version
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### With Yarn 2 / Plug'n'Play #### With Yarn 2 / Plug'n'Play
@@ -225,5 +213,5 @@ If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you shoul
- uses: changesets/action@v1 - uses: changesets/action@v1
with: with:
version: yarn changeset version version: yarn changeset version
# ... ...
``` ```
@@ -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"
}
+1 -16
View File
@@ -1,13 +1,9 @@
name: Changesets name: Changesets
description: A GitHub action to automate releases with Changesets description: A GitHub action to automate releases with Changesets
runs: runs:
using: "node24" using: "node20"
main: "dist/index.js" main: "dist/index.js"
inputs: inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
publish: publish:
description: "The command to use to build and publish packages" description: "The command to use to build and publish packages"
required: false required: false
@@ -32,20 +28,9 @@ inputs:
description: "A boolean value to indicate whether to create Github releases after `publish` or not" description: "A boolean value to indicate whether to create Github releases after `publish` or not"
required: false required: false
default: true default: true
commitMode:
description: >
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
or "github-api" to push changes via the GitHub API. When using "github-api",
all commits and tags are signed using GitHub's GPG key and attributed to the user
or app who owns the GITHUB_TOKEN.
required: false
default: "git-cli"
branch: branch:
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
required: false required: false
prDraft:
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
required: false
outputs: outputs:
published: published:
description: A boolean value to indicate whether a publishing is happened or not description: A boolean value to indicate whether a publishing is happened or not
-18
View File
File diff suppressed because one or more lines are too long
+63 -150
View File
File diff suppressed because one or more lines are too long
-96
View File
File diff suppressed because one or more lines are too long
-1
View File
@@ -1 +0,0 @@
import{a as e,c as t,n,o as r,s as i,t as a}from"./github-DTObde6f.js";try{await o()}catch(e){i(e.message)}async function o(){let i=a.payload.pull_request;if(!i)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let o=e(`github-token`,{required:!0}),c=e(`body`,{required:!0}),l=e(`update-id`),u=l?s(l):null,d=u?`${u}\n\n${c}`:c,f={repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number,body:d},p=n(o),m;u&&(r(`Checking for existing comment...`),m=await p.rest.issues.listComments({repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number}).then(e=>e.data.find(e=>e.body?.includes(u))?.id)),m?(r(`Updating existing comment (id: ${m})...`),await p.rest.issues.updateComment({...f,comment_id:m}),t(`comment-id`,m)):(r(`Creating new comment...`),t(`comment-id`,(await p.rest.issues.createComment(f)).data.id)),r(`Done!`)}function s(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
-39
View File
File diff suppressed because one or more lines are too long
+53 -46
View File
@@ -1,54 +1,61 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "1.9.0", "version": "1.4.7",
"license": "MIT",
"type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "license": "MIT",
"build": "rolldown -c",
"test": "vitest",
"test:watch": "pnpm test --watch",
"typecheck": "tsc",
"format": "oxfmt --check",
"format:fix": "oxfmt",
"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"
},
"dependencies": {
"@actions/core": "^3.0.1",
"@actions/exec": "^3.0.0",
"@actions/github": "^9.1.1",
"@changesets/get-release-plan": "^4.0.16",
"@changesets/ghcommit": "^2.1.1",
"@changesets/git": "^3.0.4",
"@changesets/pre": "^2.0.2",
"@changesets/read": "^0.6.7",
"@manypkg/get-packages": "^1.1.3",
"@octokit/core": "^7.0.6",
"@octokit/plugin-throttling": "^11.0.3",
"human-id": "^4.1.3",
"markdown-table": "^3.0.4",
"semver": "^7.8.0",
"tinyexec": "^1.1.2"
},
"devDependencies": { "devDependencies": {
"@changesets/changelog-github": "^0.7.0", "@changesets/changelog-github": "^0.4.2",
"@changesets/cli": "^2.31.0", "@changesets/cli": "^2.20.0",
"@changesets/types": "^6.1.0", "@changesets/write": "^0.1.6",
"@changesets/write": "^0.4.0", "@vercel/ncc": "^0.36.1",
"@tsconfig/node24": "^24.0.4", "fixturez": "^1.1.0",
"@types/node": "^24.12.4", "prettier": "^2.0.5",
"@types/semver": "^7.7.1", "typescript": "^5.0.4",
"fs-fixture": "^2.13.0", "@babel/core": "^7.13.10",
"oxfmt": "^0.48.0", "@babel/preset-env": "^7.13.10",
"rolldown": "^1.0.1", "@babel/preset-typescript": "^7.13.0",
"typescript": "^6.0.3", "@types/fs-extra": "^8.0.0",
"vitest": "^4.1.6" "@types/jest": "^29.5.1",
"@types/node": "^20.11.17",
"@types/semver": "^7.5.0",
"babel-jest": "^29.5.0",
"husky": "^3.0.3",
"jest": "^29.5.0"
},
"scripts": {
"build": "ncc build src/index.ts -o dist --transpile-only --minify",
"test": "jest",
"test:watch": "yarn test --watch",
"changeset": "changeset",
"bump": "node ./scripts/bump.js",
"release": "node ./scripts/release.js"
}, },
"engines": { "engines": {
"node": ">=24" "node": ">= 20"
}, },
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a" "dependencies": {
"@actions/core": "^1.10.0",
"@actions/exec": "^1.1.1",
"@actions/github": "^5.1.1",
"@changesets/pre": "^1.0.9",
"@changesets/read": "^0.5.3",
"@manypkg/get-packages": "^1.1.3",
"@octokit/plugin-throttling": "^5.2.1",
"fs-extra": "^8.1.0",
"mdast-util-to-string": "^1.0.6",
"remark-parse": "^7.0.1",
"remark-stringify": "^7.0.3",
"resolve-from": "^5.0.0",
"semver": "^7.5.3",
"unified": "^8.3.2"
},
"husky": {
"hooks": {}
},
"prettier": {},
"resolutions": {
"**/@octokit/core": "4.2.0",
"trim": "^0.0.3",
"y18n": "^4.0.1"
}
} }
-2405
View File
File diff suppressed because it is too large Load Diff
-13
View File
@@ -1,13 +0,0 @@
blockExoticSubdeps: true
dedupePeers: true
dedupePeerDependents: true
minimumReleaseAge: 10080
minimumReleaseAgeExclude:
- "@changesets/ghcommit@2.1.1"
overrides:
lightningcss: "-" # we do not bundle any css
postcss: "-" # we do not bundle any css
shellEmulator: true
trustPolicy: no-downgrade
-52
View File
@@ -1,52 +0,0 @@
# @changesets/action/pr-comment
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md).
This action is intentionally simple without advanced features. Check out other actions if so, such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
See the [action metadata](action.yml) for details on the inputs and outputs.
## Example setup
```yaml
name: PR Comment
on:
pull_request:
jobs:
pr-comment:
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
```
When called repeatedly, the action will update the comment it created by default. If you use this action to create different types of comments, pass an `update-id` value to differentiate them.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: my-tag
```
If you want to always create new comments, pass an empty value to `update-id`.
```yaml
jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
with:
body: Hello world!
update-id: ""
```
-25
View File
@@ -1,25 +0,0 @@
name: Changesets - PR Comment
description: A simple GitHub Action to comment on PRs
runs:
using: node24
main: ../dist/pr-comment.js
inputs:
github-token:
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
required: false
default: ${{ github.token }}
body:
description: "The comment body to post on the PR."
required: true
update-id:
description: >
By default, the action will create and update a comment with this id. Pass a different id to
create and update a new comment, or pass an empty string to disable updating comments.
required: false
default: "changesets-action-pr-comment"
outputs:
comment-id:
description: "The comment id of the comment that was created or updated."
branding:
icon: message-circle
color: blue
-61
View File
@@ -1,61 +0,0 @@
# changesets/action/pr-status
This action generates the changesets status in PRs, e.g. whether it has changeset files and which packages will be released if the PR is merged.
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages. It also requires the [`pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) event to be triggered in order to have permissions to comment on the PR and to work in PRs from forks.
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs:
```yaml
jobs:
pr-status:
if: github.event.pull_request.head.repo.full_name == github.repository
# ...
```
See the [action metadata](action.yml) for details on the inputs and outputs.
> [!WARNING]
> **Do not run untrusted code** when using the `pull_request_target` event. The example below only checks out code and does not run any code from the PR. Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
## Example setup
```yaml
# .github/workflows/comment-changesets-pr-status.yml
name: Comment Changesets status in PRs
on:
pull_request_target:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
pr-status:
runs-on: ubuntu-slim
permissions:
contents: read # to check out files in the repo
outputs:
comment-body: ${{ steps.pr-status.outputs.comment-body }}
steps:
- name: Check out repo
uses: actions/checkout@v6
- name: Generate status
id: pr-status
uses: changesets/action/pr-status@v1
pr-comment:
needs: pr-status
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
steps:
- name: Comment on PR
uses: changesets/action/pr-comment@v1
with:
body: ${{ needs.pr-status.outputs.comment-body }}
```
The workflow uses [`@changesets/action/pr-comment`](../pr-comment/README.md), which is a simple GitHub Action to comment on PRs.
-12
View File
@@ -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
-17
View File
@@ -1,17 +0,0 @@
import { defineConfig } from "rolldown";
export default defineConfig({
input: {
index: "src/index.ts",
["pr-status"]: "src/pr-status/index.ts",
["pr-comment"]: "src/pr-comment/index.ts",
},
output: {
dir: "dist",
format: "esm",
cleanDir: true,
minify: true,
comments: false,
},
platform: "node",
});
+19
View File
@@ -0,0 +1,19 @@
const fs = require("fs");
const path = require("path");
const { exec } = require("@actions/exec");
process.chdir(path.join(__dirname, ".."));
(async () => {
await exec("changeset", ["version"]);
const releaseLine = `v${require("../package.json").version.split(".")[0]}`;
const readmePath = path.join(__dirname, "..", "README.md");
const content = fs.readFileSync(readmePath, "utf8");
const updatedContent = content.replace(
/changesets\/action@[^\s]+/g,
`changesets/action@${releaseLine}`
);
fs.writeFileSync(readmePath, updatedContent);
})();
-18
View File
@@ -1,18 +0,0 @@
import fs from "node:fs";
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
process.chdir(path.join(import.meta.dirname, ".."));
await exec("changeset", ["version"]);
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
const readmePath = path.join(import.meta.dirname, "..", "README.md");
const content = fs.readFileSync(readmePath, "utf8");
const updatedContent = content.replace(
/changesets\/action@[^\s]+/g,
`changesets/action@${releaseLine}`,
);
fs.writeFileSync(readmePath, updatedContent);
-19
View File
@@ -1,19 +0,0 @@
import path from "node:path";
import { exec } from "@actions/exec";
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`;
const releaseLine = "pr-release";
process.chdir(path.join(import.meta.dirname, ".."));
await exec("git", ["checkout", "--detach"]);
await exec("git", ["add", "--force", "dist"]);
await exec("git", ["commit", "-m", tag]);
await exec("git", [
"push",
"--force",
"origin",
`HEAD:refs/heads/${releaseLine}`,
]);
+8 -8
View File
@@ -1,11 +1,11 @@
import path from "node:path"; const path = require("path");
import { exec, getExecOutput } from "@actions/exec"; const { exec, getExecOutput } = require("@actions/exec");
import pkgJson from "../package.json" with { type: "json" };
const tag = `v${pkgJson.version}`; const { version } = require("../package.json");
const releaseLine = `v${pkgJson.version.split(".")[0]}`; const tag = `v${version}`;
const releaseLine = `v${version.split(".")[0]}`;
process.chdir(path.join(import.meta.dirname, "..")); process.chdir(path.join(__dirname, ".."));
(async () => { (async () => {
const { exitCode, stderr } = await getExecOutput( const { exitCode, stderr } = await getExecOutput(
@@ -13,11 +13,11 @@ process.chdir(path.join(import.meta.dirname, ".."));
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`], ["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
{ {
ignoreReturnCode: true, ignoreReturnCode: true,
}, }
); );
if (exitCode === 0) { if (exitCode === 0) {
console.log( console.log(
`Action is not being published because version ${tag} is already published`, `Action is not being published because version ${tag} is already published`
); );
return; return;
} }
+19 -131
View File
@@ -1,6 +1,6 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`version > creates a draft PR when prDraft is "create" 1`] = ` exports[`version creates simple PR 1`] = `
[ [
{ {
"base": "some-branch", "base": "some-branch",
@@ -8,29 +8,7 @@ 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
- Awesome feature",
"draft": true,
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > creates simple PR 1`] = `
[
{
"base": "some-branch",
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes ### Minor Changes
@@ -39,13 +17,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, ",
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -54,7 +33,7 @@ exports[`version > creates simple PR 1`] = `
] ]
`; `;
exports[`version > does not include any release information if a message with simplified release info exceeds size limit 1`] = ` exports[`version does not include any release information if a message with simplified release info exceeds size limit 1`] = `
[ [
{ {
"base": "some-branch", "base": "some-branch",
@@ -64,7 +43,6 @@ exports[`version > does not include any release information if a message with si
# Releases # Releases
> 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.",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -73,7 +51,7 @@ exports[`version > does not include any release information if a message with si
] ]
`; `;
exports[`version > does not include changelog entries if full message exceeds size limit 1`] = ` exports[`version does not include changelog entries if full message exceeds size limit 1`] = `
[ [
{ {
"base": "some-branch", "base": "some-branch",
@@ -84,10 +62,9 @@ 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,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -96,7 +73,7 @@ exports[`version > does not include changelog entries if full message exceeds si
] ]
`; `;
exports[`version > doesn't include ignored package that got a dependency update in the PR body 1`] = ` exports[`version doesn't include ignored package that got a dependency update in the PR body 1`] = `
[ [
{ {
"base": "some-branch", "base": "some-branch",
@@ -104,12 +81,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, ",
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -118,7 +95,7 @@ exports[`version > doesn't include ignored package that got a dependency update
] ]
`; `;
exports[`version > only includes bumped packages in the PR body 1`] = ` exports[`version only includes bumped packages in the PR body 1`] = `
[ [
{ {
"base": "some-branch", "base": "some-branch",
@@ -126,12 +103,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, ",
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -139,92 +116,3 @@ exports[`version > only includes bumped packages in the PR body 1`] = `
}, },
] ]
`; `;
exports[`version > updates an existing PR via GraphQL and converts it to draft when prDraft is "always" 1`] = `
[
"
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
",
{
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature",
"pullRequestId": "PR_kwDOA",
"title": "Version Packages",
},
]
`;
exports[`version > updates an existing PR via GraphQL without converting it to draft when prDraft is "create" 1`] = `
[
"
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
",
{
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
# Releases
## changesets-dev-simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature",
"pullRequestId": "PR_kwDOA",
"title": "Version Packages",
},
]
`;
+5 -3
View File
@@ -1,4 +1,4 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html // Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`it sorts the things right 1`] = ` exports[`it sorts the things right 1`] = `
[ [
@@ -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
@@ -1,129 +0,0 @@
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 });
}
}
+63
View File
@@ -0,0 +1,63 @@
import { exec, getExecOutput } from "@actions/exec";
export const setupUser = async () => {
await exec("git", [
"config",
"user.name",
`"github-actions[bot]"`,
]);
await exec("git", [
"config",
"user.email",
`"github-actions[bot]@users.noreply.github.com"`,
]);
};
export const pullBranch = async (branch: string) => {
await exec("git", ["pull", "origin", branch]);
};
export const push = async (
branch: string,
{ force }: { force?: boolean } = {}
) => {
await exec(
"git",
["push", "origin", `HEAD:${branch}`, force && "--force"].filter<string>(
Boolean as any
)
);
};
export const pushTags = async () => {
await exec("git", ["push", "origin", "--tags"]);
};
export const switchToMaybeExistingBranch = async (branch: string) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true,
});
let isCreatingBranch = !stderr
.toString()
.includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch]);
}
};
export const reset = async (
pathSpec: string,
mode: "hard" | "soft" | "mixed" = "hard"
) => {
await exec("git", ["reset", `--${mode}`, pathSpec]);
};
export const commitAll = async (message: string) => {
await exec("git", ["add", "."]);
await exec("git", ["commit", "-m", message]);
};
export const checkIfClean = async (): Promise<boolean> => {
const { stdout } = await getExecOutput("git", ["status", "--porcelain"]);
return !stdout.length;
};
+26 -84
View File
@@ -1,62 +1,44 @@
import fs from "node:fs/promises";
import path from "node:path";
import * as core from "@actions/core"; import * as core from "@actions/core";
import { Git } from "./git.ts"; import fs from "fs-extra";
import { setupOctokit } from "./octokit.ts"; import * as gitUtils from "./gitUtils";
import readChangesetState from "./readChangesetState.ts"; import { runPublish, runVersion } from "./run";
import { runPublish, runVersion } from "./run.ts"; import readChangesetState from "./readChangesetState";
import { fileExists } from "./utils.ts";
const getOptionalInput = (name: string) => core.getInput(name) || undefined; const getOptionalInput = (name: string) => core.getInput(name) || undefined;
(async () => { (async () => {
// to maintain compatibility with workflows created before github-token input was introduced let githubToken = process.env.GITHUB_TOKEN;
// it's important to prefer the explicitly set GITHUB_TOKEN over the default token coming from github.token
let githubToken = process.env.GITHUB_TOKEN || core.getInput("github-token");
if (!githubToken) { if (!githubToken) {
core.setFailed("Please add the GITHUB_TOKEN to the changesets action"); core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
return; return;
} }
const cwd = path.resolve(getOptionalInput("cwd") ?? ""); const inputCwd = core.getInput("cwd");
core.info(`using resolved cwd: ${cwd}`); if (inputCwd) {
core.info("changing directory to the one given as the input");
const octokit = setupOctokit(githubToken); process.chdir(inputCwd);
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,
});
let setupGitUser = core.getBooleanInput("setupGitUser"); let setupGitUser = core.getBooleanInput("setupGitUser");
if (setupGitUser) { if (setupGitUser) {
core.info("setting git user"); core.info("setting git user");
await git.setupUser(); await gitUtils.setupUser();
} }
core.info("setting GitHub credentials"); core.info("setting GitHub credentials");
await fs.writeFile( await fs.writeFile(
`${process.env.HOME}/.netrc`, `${process.env.HOME}/.netrc`,
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`, `machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
); );
let { changesets } = await readChangesetState(cwd); let { changesets } = await readChangesetState();
let publishScript = core.getInput("publish"); let publishScript = core.getInput("publish");
let hasChangesets = changesets.length !== 0; let hasChangesets = changesets.length !== 0;
const hasNonEmptyChangesets = changesets.some( const hasNonEmptyChangesets = changesets.some(
(changeset) => changeset.releases.length > 0, (changeset) => changeset.releases.length > 0
); );
let hasPublishScript = !!publishScript; let hasPublishScript = !!publishScript;
@@ -66,19 +48,15 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
switch (true) { switch (true) {
case !hasChangesets && !hasPublishScript: case !hasChangesets && !hasPublishScript:
core.info( core.info("No changesets found");
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
);
return; return;
case !hasChangesets && hasPublishScript: { case !hasChangesets && hasPublishScript: {
core.info( core.info(
"No changesets found. Attempting to publish any unpublished packages to npm", "No changesets found, attempting to publish any unpublished packages to npm"
); );
if (process.env.NPM_TOKEN) { let userNpmrcPath = `${process.env.HOME}/.npmrc`;
const userNpmrcPath = `${process.env.HOME}/.npmrc`; if (fs.existsSync(userNpmrcPath)) {
if (await fileExists(userNpmrcPath)) {
core.info("Found existing user .npmrc file"); core.info("Found existing user .npmrc file");
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8"); const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
const authLine = userNpmrcContent.split("\n").find((line) => { const authLine = userNpmrcContent.split("\n").find((line) => {
@@ -87,85 +65,50 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
}); });
if (authLine) { if (authLine) {
core.info( core.info(
"Found existing auth token for the npm registry in the user .npmrc file", "Found existing auth token for the npm registry in the user .npmrc file"
); );
} else { } else {
core.info( core.info(
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one", "Didn't find existing auth token for the npm registry in the user .npmrc file, creating one"
); );
await fs.appendFile( fs.appendFileSync(
userNpmrcPath, userNpmrcPath,
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`, `\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
); );
} }
} else { } else {
core.info( core.info("No user .npmrc file found, creating one");
"No user .npmrc file found, creating one with NPM_TOKEN used as auth token", fs.writeFileSync(
);
await fs.writeFile(
userNpmrcPath, userNpmrcPath,
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`, `//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
);
}
} 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,
githubToken, githubToken,
git,
octokit,
createGithubReleases: core.getBooleanInput("createGithubReleases"), createGithubReleases: core.getBooleanInput("createGithubReleases"),
cwd,
}); });
if (result.published) { if (result.published) {
core.setOutput("published", "true"); core.setOutput("published", "true");
core.setOutput( core.setOutput(
"publishedPackages", "publishedPackages",
JSON.stringify(result.publishedPackages), JSON.stringify(result.publishedPackages)
); );
} }
if (result.exitCode !== 0) {
core.error(
`Publish command exited with code ${result.exitCode}${
result.published
? `, but some packages were published: ${result.publishedPackages
.map((p) => `${p.name}@${p.version}`)
.join(", ")}`
: ""
}`,
);
process.exit(result.exitCode);
}
return; return;
} }
case hasChangesets && !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: getOptionalInput("version"),
githubToken, githubToken,
git,
octokit,
cwd,
prTitle: getOptionalInput("title"), prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit"), commitMessage: getOptionalInput("commit"),
hasPublishScript, hasPublishScript,
prDraft,
branch: getOptionalInput("branch"), branch: getOptionalInput("branch"),
}); });
@@ -173,7 +116,6 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
return; return;
} }
}
})().catch((err) => { })().catch((err) => {
core.error(err); core.error(err);
core.setFailed(err.message); core.setFailed(err.message);
-41
View File
@@ -1,41 +0,0 @@
import * as core from "@actions/core";
import { getOctokit } from "@actions/github";
import { throttling } from "@octokit/plugin-throttling";
export const setupOctokit = (githubToken: string) => {
return getOctokit(
githubToken,
{
throttle: {
onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
core.warning(
`Request quota exhausted for request ${options.method} ${options.url}`,
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
onSecondaryRateLimit: (
retryAfter,
options: any,
octokit,
retryCount,
) => {
core.warning(
`SecondaryRateLimit detected for request ${options.method} ${options.url}`,
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
},
},
throttling,
);
};
export type Octokit = ReturnType<typeof setupOctokit>;
-77
View File
@@ -1,77 +0,0 @@
import * as core from "@actions/core";
import * as github from "@actions/github";
type Octokit = ReturnType<typeof github.getOctokit>;
type CreateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
>;
type UpdateCommentParams = NonNullable<
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
>;
try {
await main();
} catch (err) {
core.setFailed((err as Error).message);
}
async function main() {
const context = github.context.payload.pull_request;
if (!context) {
throw new Error(
"This action should only be run on `pull_request_target` or `pull_request` events",
);
}
const githubToken = core.getInput("github-token", { required: true });
const body = core.getInput("body", { required: true });
const updateId = core.getInput("update-id");
const commentMarker = updateId ? getCommentMarker(updateId) : null;
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
const commentParam: CreateCommentParams | UpdateCommentParams = {
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
body: commentBody,
};
const octokit = github.getOctokit(githubToken);
let existingCommentId: number | undefined;
if (commentMarker) {
core.info("Checking for existing comment...");
existingCommentId = await octokit.rest.issues
.listComments({
repo: context.base.repo.name,
owner: context.base.repo.owner.login,
issue_number: context.number,
})
.then((res) => {
const comment = res.data.find((c) => c.body?.includes(commentMarker));
return comment?.id;
});
}
if (existingCommentId) {
core.info(`Updating existing comment (id: ${existingCommentId})...`);
await octokit.rest.issues.updateComment({
...commentParam,
comment_id: existingCommentId,
});
core.setOutput("comment-id", existingCommentId);
} else {
core.info("Creating new comment...");
const result = await octokit.rest.issues.createComment(commentParam);
core.setOutput("comment-id", result.data.id);
}
core.info("Done!");
}
function getCommentMarker(updateId: string) {
const prefix = "changesets-action-pr-comment";
return prefix === updateId
? `<!-- ${prefix} -->`
: `<!-- ${prefix}:${updateId} -->`;
}
-23
View File
@@ -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://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`;
}
function getAbsentMessage(
commitSha: string,
newChangesetUrl: string,
releasePlan: ReleasePlan,
) {
return `\
### ⚠️ No Changeset found
Latest commit: ${commitSha}
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
${getReleasePlanMessage(releasePlan)}
[Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
[Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
}
function getReleasePlanMessage(releasePlan: ReleasePlan) {
const publishableReleases = releasePlan.releases.filter(
(r) => r.type !== "none",
) as (ComprehensiveRelease & { type: Exclude<VersionType, "none"> })[];
const table = markdownTable([
["Name", "Type"],
...publishableReleases.map((release) => {
return [
release.name,
{
major: "Major",
minor: "Minor",
patch: "Patch",
}[release.type],
];
}),
]);
let summary = "This PR includes ";
if (releasePlan.changesets.length === 0) {
summary += "no changesets";
} else {
summary += `changesets to release ${publishableReleases.length} package`;
if (publishableReleases.length !== 1) {
summary += "s";
}
}
return `\
<details>
<summary>${summary}</summary>
${
publishableReleases.length > 0
? table
: "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
}
</details>`;
}
-30
View File
@@ -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}
`;
}
-148
View File
@@ -1,148 +0,0 @@
import { pathToFileURL } from "node:url";
import type * as github from "@actions/github";
import getReleasePlan from "@changesets/get-release-plan";
import { createFixture } from "fs-fixture";
import { exec } from "tinyexec";
import { describe, expect, it } from "vitest";
import { getPullRequestWorktree } from "./worktree.ts";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
async function git(cwd: string, args: string[]) {
const output = await exec("git", args, {
nodeOptions: { cwd },
throwOnError: true,
});
return output.stdout.trim();
}
describe("getPullRequestWorktree", () => {
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
// Local source repo
await using sourceRepoFixture = await createFixture({
".changeset/config.json": JSON.stringify({}),
"package.json": JSON.stringify({
name: "repo",
private: true,
workspaces: ["packages/*"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "pkg-a",
version: "1.0.0",
}),
});
const sourceRepo = sourceRepoFixture.path;
await git(sourceRepo, ["init", "-b", "main"]);
await git(sourceRepo, ["config", "user.name", "Test User"]);
await git(sourceRepo, ["config", "user.email", "test@example.com"]);
await git(sourceRepo, ["add", "."]);
await git(sourceRepo, ["commit", "-m", "base"]);
// Simulate remote bare git server
await using originBareFixture = await createFixture();
const originBare = originBareFixture.path;
await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
// Simulate checkout PR in github action
await using checkoutRepoFixture = await createFixture();
const checkoutRepo = checkoutRepoFixture.path;
await git(checkoutRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(originBare).toString(),
checkoutRepo,
]);
// Simulate remote fork bare git server
await using forkBareFixture = await createFixture();
const forkBare = forkBareFixture.path;
await git(forkBare, ["clone", "--bare", originBare, forkBare]);
await using forkRepoFixture = await createFixture();
const forkRepo = forkRepoFixture.path;
await git(forkRepo, [
"clone",
"--depth",
"1",
"--branch",
"main",
pathToFileURL(forkBare).toString(),
forkRepo,
]);
await git(forkRepo, ["config", "user.name", "Test User"]);
await git(forkRepo, ["config", "user.email", "test@example.com"]);
await git(forkRepo, ["checkout", "-b", "feature"]);
await forkRepoFixture.mkdir("packages/pkg-a/src");
await forkRepoFixture.writeFile(
"packages/pkg-a/src/index.ts",
"export const value = 1;\n",
);
await forkRepoFixture.writeFile(
".changeset/add-pkg-a.md",
`\
---
"pkg-a": patch
---
Add pkg-a
`,
);
await git(forkRepo, ["add", "."]);
await git(forkRepo, ["commit", "-m", "feature"]);
await git(forkRepo, ["push", "origin", "feature"]);
// Run tests
const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
const context = {
number: 123,
base: {
ref: "main",
repo: {
clone_url: pathToFileURL(originBare).toString(),
},
},
head: {
ref: "feature",
repo: {
clone_url: pathToFileURL(forkBare).toString(),
},
},
};
await using worktree = await getPullRequestWorktree(
context satisfies PullRequestContext as PullRequestContext,
checkoutRepo,
);
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
expect(currentHead).not.toBe(originalHead);
const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
expect(currentBranch).toBe("");
const releases = releasePlan.releases.map((release) => ({
name: release.name,
type: release.type,
newVersion: release.newVersion,
}));
expect(releases).toEqual([
{
name: "pkg-a",
type: "patch",
newVersion: "1.0.1",
},
]);
expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
});
});
-165
View File
@@ -1,165 +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";
type PullRequestContext = NonNullable<
typeof github.context.payload.pull_request
>;
type WorktreeInfo = {
baseRef: string;
cwd: string;
};
type TinyexecOptions = Parameters<typeof exec>[2];
function git(cwd: string, args: string[], opts: TinyexecOptions = {}) {
return exec("git", args, {
nodeOptions: { cwd, ...opts.nodeOptions },
throwOnError: true,
...opts,
});
}
interface Ref {
fetchSource: string;
local: string;
remote: string;
}
function getRefs(context: PullRequestContext): Record<"base" | "head", Ref> {
const suffix = `${context.number}-${randomUUID()}`;
return {
base: {
fetchSource: "origin",
local: `refs/changesets-action-pr-status/base/${suffix}`,
remote: `refs/heads/${context.base.ref}`,
},
head: {
fetchSource: context.head.repo.clone_url,
local: `refs/changesets-action-pr-status/head/${suffix}`,
remote: `refs/heads/${context.head.ref}`,
},
};
}
async function deepenRef(cwd: string, ref: Ref, deepenBy: number) {
await git(cwd, [
"fetch",
"--no-tags",
`--deepen=${deepenBy}`,
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
}
async function ensureMergeBase(args: {
cwd: string;
refs: ReturnType<typeof getRefs>;
deepenBy?: number;
}) {
const { cwd, refs, deepenBy = 50 } = args;
while (true) {
const mergeBase = await git(cwd, ["merge-base", refs.base.local, "HEAD"], {
throwOnError: false,
});
if (mergeBase.exitCode === 0) {
return mergeBase.stdout.trim();
}
if (!(await isRepoShallow({ cwd }))) {
throw new Error(
`Failed to find merge base between "${refs.base.local}" and HEAD, and the repository is no longer shallow.`,
);
}
await deepenRef(cwd, refs.base, deepenBy);
await deepenRef(cwd, refs.head, deepenBy);
}
}
async function mkdtemp(prefix: string) {
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
return {
dir,
async [Symbol.asyncDispose]() {
await fs.rm(dir, { recursive: true, force: true });
},
};
}
async function tempRef(cwd: string, ref: Ref) {
await git(cwd, [
"fetch",
"--no-tags",
"--depth=1",
ref.fetchSource,
`${ref.remote}:${ref.local}`,
]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["update-ref", "-d", ref.local], { throwOnError: false });
},
};
}
async function tempWorktree(cwd: string, dir: string, ref: Ref) {
await git(cwd, ["worktree", "add", "--detach", dir, ref.local]);
return {
async [Symbol.asyncDispose]() {
await git(cwd, ["worktree", "remove", "--force", dir], {
throwOnError: false,
});
},
};
}
type WithAsyncDispose<T> = T & {
[Symbol.asyncDispose](): Promise<void>;
};
function moveDisposable<T extends object>(
stack: AsyncDisposableStack,
value: T,
): WithAsyncDispose<T> {
const moved = stack.move();
return Object.assign(value, {
async [Symbol.asyncDispose]() {
await moved.disposeAsync();
},
});
}
export async function getPullRequestWorktree(
context: PullRequestContext,
cwd: string = process.cwd(),
): Promise<WithAsyncDispose<WorktreeInfo>> {
await using stack = new AsyncDisposableStack();
const worktreeDir = stack.use(
await mkdtemp("changesets-action-pr-status-"),
).dir;
const refs = getRefs(context);
stack.use(await tempRef(cwd, refs.base));
stack.use(await tempRef(cwd, refs.head));
stack.use(await tempWorktree(cwd, worktreeDir, refs.head));
await ensureMergeBase({
cwd: worktreeDir,
refs,
});
return moveDisposable(stack, {
baseRef: refs.base.local,
cwd: worktreeDir,
});
}
+2 -2
View File
@@ -1,6 +1,6 @@
import { PreState, NewChangeset } from "@changesets/types";
import { readPreState } from "@changesets/pre"; import { readPreState } from "@changesets/pre";
import readChangesets from "@changesets/read"; import readChangesets from "@changesets/read";
import type { PreState, NewChangeset } from "@changesets/types";
export type ChangesetState = { export type ChangesetState = {
preState: PreState | undefined; preState: PreState | undefined;
@@ -8,7 +8,7 @@ export type ChangesetState = {
}; };
export default async function readChangesetState( export default async function readChangesetState(
cwd: string = process.cwd(), cwd: string = process.cwd()
): Promise<ChangesetState> { ): Promise<ChangesetState> {
let preState = await readPreState(cwd); let preState = await readPreState(cwd);
let changesets = await readChangesets(cwd); let changesets = await readChangesets(cwd);
+73 -212
View File
@@ -1,13 +1,13 @@
import path from "node:path"; import fixturez from "fixturez";
import type { Changeset } from "@changesets/types"; import * as github from "@actions/github";
import * as githubUtils from "@actions/github/lib/utils";
import fs from "fs-extra";
import path from "path";
import writeChangeset from "@changesets/write"; import writeChangeset from "@changesets/write";
import { createFixture } from "fs-fixture"; import { Changeset } from "@changesets/types";
import { beforeEach, describe, expect, it, vi } from "vitest"; import { runVersion } from "./run";
import { Git } from "./git.ts";
import { setupOctokit } from "./octokit.ts";
import { runVersion } from "./run.ts";
vi.mock("@actions/github", () => ({ jest.mock("@actions/github", () => ({
context: { context: {
repo: { repo: {
owner: "changesets", owner: "changesets",
@@ -16,91 +16,58 @@ vi.mock("@actions/github", () => ({
ref: "refs/heads/some-branch", ref: "refs/heads/some-branch",
sha: "xeac7", sha: "xeac7",
}, },
getOctokit: () => ({
rest: mockedGithubMethods,
graphql: mockedGraphql,
}),
})); }));
vi.mock("./git.ts"); jest.mock("@actions/github/lib/utils", () => ({
vi.mock("@changesets/ghcommit/git"); GitHub: {
plugin: () => {
// function necessary to be used as constructor
return function() {
return {
rest: mockedGithubMethods,
}
}
},
},
getOctokitOptions: jest.fn(),
}));
jest.mock("./gitUtils");
let mockedGithubMethods = { let mockedGithubMethods = {
search: {
issuesAndPullRequests: jest.fn(),
},
pulls: { pulls: {
create: vi.fn(), create: jest.fn(),
list: vi.fn(),
}, },
repos: { repos: {
createRelease: vi.fn(), createRelease: jest.fn(),
}, },
}; };
let mockedGraphql = vi.fn();
const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules"); let f = fixturez(__dirname);
function createSimpleProjectFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-simple-project-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-simple-project-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "simple-project",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
function createIgnoredPackageFixture() {
return createFixture({
node_modules: (api) => api.symlink(nodeModulesDir),
".changeset/config.json": JSON.stringify({
ignore: ["changesets-dev-ignored-package-pkg-a"],
}),
"packages/pkg-a/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-a",
version: "1.0.0",
dependencies: {
"changesets-dev-ignored-package-pkg-b": "1.0.0",
},
}),
"packages/pkg-b/package.json": JSON.stringify({
name: "changesets-dev-ignored-package-pkg-b",
version: "1.0.0",
}),
"package.json": JSON.stringify({
name: "ignored-package",
version: "1.0.0",
private: true,
workspaces: ["packages/*"],
}),
});
}
const linkNodeModules = async (cwd: string) => {
await fs.symlink(
path.join(__dirname, "..", "node_modules"),
path.join(cwd, "node_modules")
);
};
const writeChangesets = (changesets: Changeset[], cwd: string) => { const writeChangesets = (changesets: Changeset[], cwd: string) => {
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd))); return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
}; };
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); jest.clearAllMocks();
}); });
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; linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
() => ({ data: { items: [] } })
);
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 }, data: { number: 123 },
@@ -111,71 +78,35 @@ 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({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN", githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
}); });
it('creates a draft PR when prDraft is "create"', async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "create",
});
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
});
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; linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
() => ({ data: { items: [] } })
);
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 }, data: { number: 123 },
@@ -186,20 +117,18 @@ 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({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN", githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -207,10 +136,12 @@ 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; linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
() => ({ data: { items: [] } })
);
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 }, data: { number: 123 },
@@ -221,20 +152,18 @@ 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({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN", githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd, cwd,
}); });
@@ -242,10 +171,12 @@ 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; linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
() => ({ data: { items: [] } })
);
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 }, data: { number: 123 },
@@ -256,7 +187,7 @@ describe("version", () => {
{ {
releases: [ releases: [
{ {
name: "changesets-dev-simple-project-pkg-a", name: "simple-project-pkg-a",
type: "minor", type: "minor",
}, },
], ],
@@ -283,28 +214,28 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@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; linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] })); mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
() => ({ data: { items: [] } })
);
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({ mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 }, data: { number: 123 },
@@ -315,7 +246,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",
}, },
], ],
@@ -342,88 +273,18 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
`, `,
}, },
], ],
cwd, cwd
); );
await runVersion({ await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@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 () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "create",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
await using fixture = await createSimpleProjectFixture();
const cwd = fixture.path;
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "changesets-dev-simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd,
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "always",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
}); });
+131 -149
View File
@@ -1,24 +1,22 @@
import fs from "node:fs/promises";
import { createRequire } from "node:module";
import path from "node:path";
import * as core from "@actions/core";
import { exec, getExecOutput } from "@actions/exec"; import { exec, getExecOutput } from "@actions/exec";
import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
import * as github from "@actions/github"; import * as github from "@actions/github";
import type { PreState } from "@changesets/types"; import * as core from "@actions/core";
import { type Package, getPackages } from "@manypkg/get-packages"; import fs from "fs-extra";
import semverLt from "semver/functions/lt.js"; import { getPackages, Package } from "@manypkg/get-packages";
import { Git } from "./git.ts"; import path from "path";
import type { Octokit } from "./octokit.ts"; import * as semver from "semver";
import readChangesetState from "./readChangesetState.ts"; import { PreState } from "@changesets/types";
import { import {
getChangedPackages,
getChangelogEntry, getChangelogEntry,
getVersionsByDirectory, getChangedPackages,
isErrorWithCode,
sortTheThings, sortTheThings,
} from "./utils.ts"; getVersionsByDirectory,
} from "./utils";
const require = createRequire(import.meta.url); import * as gitUtils from "./gitUtils";
import readChangesetState from "./readChangesetState";
import resolveFrom from "resolve-from";
import { throttling } from "@octokit/plugin-throttling";
// 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.
@@ -26,26 +24,55 @@ const require = createRequire(import.meta.url);
// To avoid that, we ensure to cap the message to 60k chars. // To avoid that, we ensure to cap the message to 60k chars.
const MAX_CHARACTERS_PER_MESSAGE = 60000; const MAX_CHARACTERS_PER_MESSAGE = 60000;
const setupOctokit = (githubToken: string) => {
return new (GitHub.plugin(throttling))(
getOctokitOptions(githubToken, {
throttle: {
onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
core.warning(
`Request quota exhausted for request ${options.method} ${options.url}`
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
onSecondaryRateLimit: (
retryAfter,
options: any,
octokit,
retryCount
) => {
core.warning(
`SecondaryRateLimit detected for request ${options.method} ${options.url}`
);
if (retryCount <= 2) {
core.info(`Retrying after ${retryAfter} seconds!`);
return true;
}
},
},
})
);
};
const createRelease = async ( const createRelease = async (
octokit: Octokit, octokit: ReturnType<typeof setupOctokit>,
{ pkg, tagName }: { pkg: Package; tagName: string }, { pkg, tagName }: { pkg: Package; tagName: string }
) => { ) => {
let changelog;
try { try {
changelog = await fs.readFile(path.join(pkg.dir, "CHANGELOG.md"), "utf8"); let changelogFileName = path.join(pkg.dir, "CHANGELOG.md");
} catch (err) {
if (isErrorWithCode(err, "ENOENT")) { let changelog = await fs.readFile(changelogFileName, "utf8");
// if we can't find a changelog, the user has probably disabled changelogs
return;
}
throw err;
}
let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version); let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version);
if (!changelogEntry) { if (!changelogEntry) {
// 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}`
); );
} }
@@ -56,15 +83,24 @@ const createRelease = async (
prerelease: pkg.packageJson.version.includes("-"), prerelease: pkg.packageJson.version.includes("-"),
...github.context.repo, ...github.context.repo,
}); });
} catch (err) {
// if we can't find a changelog, the user has probably disabled changelogs
if (
err &&
typeof err === "object" &&
"code" in err &&
err.code !== "ENOENT"
) {
throw err;
}
}
}; };
type PublishOptions = { type PublishOptions = {
script: string; script: string;
githubToken: string; githubToken: string;
octokit: Octokit;
createGithubReleases: boolean; createGithubReleases: boolean;
git: Git; cwd?: string;
cwd: string;
}; };
type PublishedPackage = { name: string; version: string }; type PublishedPackage = { name: string; version: string };
@@ -73,26 +109,28 @@ type PublishResult =
| { | {
published: true; published: true;
publishedPackages: PublishedPackage[]; publishedPackages: PublishedPackage[];
exitCode: number;
} }
| { | {
published: false; published: false;
exitCode: number;
}; };
export async function runPublish({ export async function runPublish({
script, script,
githubToken, githubToken,
git,
octokit,
createGithubReleases, createGithubReleases,
cwd, cwd = process.cwd(),
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
let changesetPublishOutput = await getExecOutput(script, undefined, { const octokit = setupOctokit(githubToken);
cwd,
ignoreReturnCode: true, let [publishCommand, ...publishArgs] = script.split(/\s+/);
env: { ...process.env, GITHUB_TOKEN: githubToken },
}); let changesetPublishOutput = await getExecOutput(
publishCommand,
publishArgs,
{ cwd }
);
await gitUtils.pushTags();
let { packages, tool } = await getPackages(cwd); let { packages, tool } = await getPackages(cwd);
let releasedPackages: Package[] = []; let releasedPackages: Package[] = [];
@@ -111,7 +149,7 @@ export async function runPublish({
if (pkg === undefined) { if (pkg === undefined) {
throw new Error( throw new Error(
`Package "${pkgName}" not found.` + `Package "${pkgName}" not found.` +
"This is probably a bug in the action, please open an issue", "This is probably a bug in the action, please open an issue"
); );
} }
releasedPackages.push(pkg); releasedPackages.push(pkg);
@@ -119,18 +157,19 @@ export async function runPublish({
if (createGithubReleases) { if (createGithubReleases) {
await Promise.all( await Promise.all(
releasedPackages.map(async (pkg) => { releasedPackages.map((pkg) =>
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`; createRelease(octokit, {
await git.pushTag(tagName); pkg,
await createRelease(octokit, { pkg, tagName }); tagName: `${pkg.packageJson.name}@${pkg.packageJson.version}`,
}), })
)
); );
} }
} else { } else {
if (packages.length === 0) { if (packages.length === 0) {
throw new Error( throw new Error(
`No package found.` + `No package found.` +
"This is probably a bug in the action, please open an issue", "This is probably a bug in the action, please open an issue"
); );
} }
let pkg = packages[0]; let pkg = packages[0];
@@ -142,9 +181,10 @@ export async function runPublish({
if (match) { if (match) {
releasedPackages.push(pkg); releasedPackages.push(pkg);
if (createGithubReleases) { if (createGithubReleases) {
const tagName = `v${pkg.packageJson.version}`; await createRelease(octokit, {
await git.pushTag(tagName); pkg,
await createRelease(octokit, { pkg, tagName }); tagName: `v${pkg.packageJson.version}`,
});
} }
break; break;
} }
@@ -158,25 +198,24 @@ export async function runPublish({
name: pkg.packageJson.name, name: pkg.packageJson.name,
version: pkg.packageJson.version, version: pkg.packageJson.version,
})), })),
exitCode: changesetPublishOutput.exitCode,
}; };
} }
return { published: false, exitCode: changesetPublishOutput.exitCode }; return { published: false };
} }
const requireChangesetsCliPkgJson = (cwd: string) => { const requireChangesetsCliPkgJson = (cwd: string) => {
try { try {
return require( return require(resolveFrom(cwd, "@changesets/cli/package.json"));
require.resolve("@changesets/cli/package.json", {
paths: [cwd],
}),
);
} catch (err) { } catch (err) {
if (isErrorWithCode(err, "MODULE_NOT_FOUND")) { if (
err &&
typeof err === "object" &&
"code" in err &&
err.code === "MODULE_NOT_FOUND"
) {
throw new Error( throw new Error(
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`, `Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`
{ cause: err },
); );
} }
throw err; throw err;
@@ -255,14 +294,11 @@ export async function getVersionPrBody({
type VersionOptions = { type VersionOptions = {
script?: string; script?: string;
githubToken: string; githubToken: string;
git: Git;
octokit: Octokit;
cwd?: string; cwd?: string;
prTitle?: string; prTitle?: string;
commitMessage?: string; commitMessage?: string;
hasPublishScript?: boolean; hasPublishScript?: boolean;
prBodyMaxCharacters?: number; prBodyMaxCharacters?: number;
prDraft?: "always" | "create";
branch?: string; branch?: string;
}; };
@@ -273,54 +309,49 @@ type RunVersionResult = {
export async function runVersion({ export async function runVersion({
script, script,
githubToken, 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 = github.context.ref.replace("refs/heads/", ""), branch,
prDraft,
}: VersionOptions): Promise<RunVersionResult> { }: VersionOptions): Promise<RunVersionResult> {
const octokit = setupOctokit(githubToken);
let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
branch = branch ?? github.context.ref.replace("refs/heads/", "");
let versionBranch = `changeset-release/${branch}`; let versionBranch = `changeset-release/${branch}`;
let { preState } = await readChangesetState(cwd); let { preState } = await readChangesetState(cwd);
await git.prepareBranch(versionBranch); await gitUtils.switchToMaybeExistingBranch(versionBranch);
await gitUtils.reset(github.context.sha);
let versionsByDirectory = await getVersionsByDirectory(cwd); let versionsByDirectory = await getVersionsByDirectory(cwd);
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 });
} else { } else {
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd); let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0") let cmd = semver.lt(changesetsCliPkgJson.version, "2.0.0")
? "bump" ? "bump"
: "version"; : "version";
await exec( await exec("node", [resolveFrom(cwd, "@changesets/cli/bin.js"), cmd], {
"node",
[
require.resolve("@changesets/cli/bin.js", {
paths: [cwd],
}),
cmd,
],
{
cwd, cwd,
env, });
},
);
} }
let searchQuery = `repo:${repo}+state:open+head:${versionBranch}+base:${branch}+is:pull-request`;
let searchResultPromise = octokit.rest.search.issuesAndPullRequests({
q: searchQuery,
});
let changedPackages = await getChangedPackages(cwd, versionsByDirectory); let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
let changedPackagesInfoPromises = Promise.all( let changedPackagesInfoPromises = Promise.all(
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);
@@ -330,36 +361,23 @@ 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})` : ""}`;
// project with `commit: true` setting could have already committed files
if (!(await gitUtils.checkIfClean())) {
const finalCommitMessage = `${commitMessage}${ const finalCommitMessage = `${commitMessage}${
!!preState ? ` (${preState.tag})` : "" !!preState ? ` (${preState.tag})` : ""
}`; }`;
await gitUtils.commitAll(finalCommitMessage);
}
/** await gitUtils.push(versionBranch, { force: true });
* 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({
...github.context.repo,
state: "open",
head: `${github.context.repo.owner}:${versionBranch}`,
base: branch,
});
core.info(
`Existing pull requests: ${JSON.stringify(
existingPullRequests.data,
null,
2,
)}`,
);
await git.pushChanges({ branch: versionBranch, message: finalCommitMessage }); let searchResult = await searchResultPromise;
core.info(JSON.stringify(searchResult.data, null, 2));
const changedPackagesInfo = (await changedPackagesInfoPromises) const changedPackagesInfo = (await changedPackagesInfoPromises)
.filter((x) => x) .filter((x) => x)
@@ -373,14 +391,13 @@ export async function runVersion({
prBodyMaxCharacters, prBodyMaxCharacters,
}); });
if (existingPullRequests.data.length === 0) { if (searchResult.data.items.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,
...github.context.repo, ...github.context.repo,
}); });
@@ -388,49 +405,14 @@ export async function runVersion({
pullRequestNumber: newPullRequest.number, pullRequestNumber: newPullRequest.number,
}; };
} else { } else {
const [pullRequest] = existingPullRequests.data; const [pullRequest] = searchResult.data.items;
core.info(`updating found pull request #${pullRequest.number}`); core.info(`updating found pull request #${pullRequest.number}`);
const convertPullRequestToDraftMutation = await octokit.rest.pulls.update({
prDraft === "always" pull_number: pullRequest.number,
? `
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}`
: "";
const updatePullRequestMutation = `
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
${convertPullRequestToDraftMutation}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
`;
await octokit.graphql(updatePullRequestMutation, {
pullRequestId: pullRequest.node_id,
title: finalPrTitle, title: finalPrTitle,
body: prBody, body: prBody,
...github.context.repo,
}); });
return { return {
+1 -2
View File
@@ -1,5 +1,4 @@
import { expect, test } from "vitest"; import { getChangelogEntry, BumpLevels, sortTheThings } from "./utils";
import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts";
let changelog = `# @keystone-alpha/email let changelog = `# @keystone-alpha/email
+45 -58
View File
@@ -1,5 +1,9 @@
import fs from "node:fs/promises"; import unified from "unified";
import { getPackages, type Package } from "@manypkg/get-packages"; import remarkParse from "remark-parse";
import remarkStringify from "remark-stringify";
// @ts-ignore
import mdastToString from "mdast-util-to-string";
import { getPackages, Package } from "@manypkg/get-packages";
export const BumpLevels = { export const BumpLevels = {
dep: 0, dep: 0,
@@ -15,7 +19,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>();
@@ -31,61 +35,60 @@ export async function getChangedPackages(
} }
export function getChangelogEntry(changelog: string, version: string) { export function getChangelogEntry(changelog: string, version: string) {
let ast = unified().use(remarkParse).parse(changelog);
let highestLevel: number = BumpLevels.dep; let highestLevel: number = BumpLevels.dep;
let headingStartInfo: { index: number; depth: number } | undefined;
let nodes = ast.children as Array<any>;
let headingStartInfo:
| {
index: number;
depth: number;
}
| undefined;
let endIndex: number | undefined; let endIndex: number | undefined;
// 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 as any).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;
@@ -95,19 +98,3 @@ export function sortTheThings(
} }
return -1; return -1;
} }
export function isErrorWithCode(err: unknown, code: string) {
return (
typeof err === "object" &&
err !== null &&
"code" in err &&
err.code === code
);
}
export function fileExists(filePath: string) {
return fs.access(filePath, fs.constants.F_OK).then(
() => true,
() => false,
);
}
+59 -7
View File
@@ -1,11 +1,63 @@
{ {
"extends": "@tsconfig/node24/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"allowImportingTsExtensions": true, /* Basic Options */
"erasableSyntaxOnly": true, // "incremental": true, /* Enable incremental compilation */
"verbatimModuleSyntax": true, "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
"strict": true, "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
"noEmit": true, // "lib": [], /* Specify library files to be included in the compilation. */
"types": ["node"] // "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
"noEmit": true /* Do not emit outputs. */,
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
"isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,
/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
} }
} }
+17
View File
@@ -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;
};
}
+5187
View File
File diff suppressed because it is too large Load Diff