mirror of
https://github.com/changesets/action
synced 2026-10-26 16:39:56 +08:00
Compare commits
@@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"presets": [
|
|
||||||
["@babel/preset-env", { "targets": { "node": 10 } }],
|
|
||||||
"@babel/preset-typescript"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Changesets
|
||||||
|
|
||||||
|
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
||||||
|
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
||||||
|
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
||||||
|
|
||||||
|
We have a quick list of common questions to get you started engaging with this project in
|
||||||
|
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://unpkg.com/@changesets/config@1.6.2/schema.json",
|
||||||
|
"changelog": [
|
||||||
|
"@changesets/changelog-github",
|
||||||
|
{ "repo": "changesets/action" }
|
||||||
|
],
|
||||||
|
"commit": false,
|
||||||
|
"linked": [],
|
||||||
|
"access": "restricted",
|
||||||
|
"baseBranch": "main",
|
||||||
|
"updateInternalDependencies": "patch",
|
||||||
|
"ignore": []
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
/.github/workflows/** @Andarist @bluwy @emmatown
|
||||||
|
/action.yml @Andarist @bluwy @emmatown
|
||||||
|
/scripts/bump.ts @Andarist @bluwy @emmatown
|
||||||
|
/scripts/release.ts @Andarist @bluwy @emmatown
|
||||||
|
/scripts/release-pr.ts @Andarist @bluwy @emmatown
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
name: Setup CI
|
||||||
|
description: Setup CI
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
skip-cache:
|
||||||
|
description: "Whether to skip the cache"
|
||||||
|
required: false
|
||||||
|
default: "false"
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- name: Set up pnpm
|
||||||
|
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
|
||||||
|
|
||||||
|
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
|
with:
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
package-manager-cache: ${{ inputs.skip-cache != 'true' }}
|
||||||
|
cache: ${{ inputs.skip-cache != 'true' && 'pnpm' || '' }}
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
shell: bash
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# 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
|
||||||
+83
-12
@@ -1,23 +1,94 @@
|
|||||||
name: Node CI
|
name: CI
|
||||||
|
|
||||||
on: [push]
|
on:
|
||||||
|
pull_request:
|
||||||
|
# merge queue is required so all commits on target branches trigger this workflow
|
||||||
|
# despite lack of the push event trigger here
|
||||||
|
merge_group:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.sha }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
lint-workflows:
|
||||||
timeout-minutes: 20
|
name: Lint workflows
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
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
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- name: Check out repo
|
||||||
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Use Node.js 12
|
|
||||||
uses: actions/setup-node@v1
|
|
||||||
with:
|
with:
|
||||||
node-version: 12.x
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Install dependencies
|
- uses: ./.github/actions/ci-setup
|
||||||
run: yarn
|
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
run: yarn test
|
run: pnpm 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')) }}
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
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
|
||||||
@@ -0,0 +1,242 @@
|
|||||||
|
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 }}
|
||||||
+3
-1
@@ -1,4 +1,6 @@
|
|||||||
node_modules
|
node_modules
|
||||||
.parcel-cache
|
.parcel-cache
|
||||||
.cache
|
.cache
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
|
dist/
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
v24.11.0
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"$schema": "./node_modules/oxfmt/configuration_schema.json",
|
||||||
|
"printWidth": 80,
|
||||||
|
"sortImports": {
|
||||||
|
"newlinesBetween": false
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+16
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Debug Current Test File",
|
||||||
|
"autoAttachChildProcesses": true,
|
||||||
|
"skipFiles": [],
|
||||||
|
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
|
||||||
|
"args": ["run", "${relativeFile}"],
|
||||||
|
"smartStep": true,
|
||||||
|
"console": "integratedTerminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Vendored
+4
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"js/ts.tsdk.path": "node_modules/typescript/lib",
|
||||||
|
"editor.defaultFormatter": "oxc.oxc-vscode"
|
||||||
|
}
|
||||||
+215
@@ -0,0 +1,215 @@
|
|||||||
|
# @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
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#255](https://github.com/changesets/action/pull/255) [`f2660aa`](https://github.com/changesets/action/commit/f2660aa7e78365f53dbeb4cfa774c1499ec6483a) Thanks [@ernestognw](https://github.com/ernestognw)! - Allow customize PR `branch` field
|
||||||
|
|
||||||
|
## 1.4.6
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#350](https://github.com/changesets/action/pull/350) [`9385be9`](https://github.com/changesets/action/commit/9385be9e757839189ea5ee63ec4e3caa8a6ca71b) Thanks [@m-shaka](https://github.com/m-shaka)! - Bump the used node.js from 16 to 20
|
||||||
|
|
||||||
|
## 1.4.5
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#282](https://github.com/changesets/action/pull/282) [`eb19e25`](https://github.com/changesets/action/commit/eb19e25e7797cf33dc2de4caa071e85a8057a0f0) Thanks [@mark-omarov](https://github.com/mark-omarov)! - Updated a few dependencies to patch the security vulnerabilities that were reported for their older versions.
|
||||||
|
|
||||||
|
## 1.4.4
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#291](https://github.com/changesets/action/pull/291) [`db8a109`](https://github.com/changesets/action/commit/db8a1099bc0ba1dd6f46a5b9df4212e4f69e78c9) Thanks [@varl](https://github.com/varl)! - Wire up [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) with all GitHub Octokit instances
|
||||||
|
|
||||||
|
## 1.4.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#289](https://github.com/changesets/action/pull/289) [`8b28186`](https://github.com/changesets/action/commit/8b2818674de86a7fc69aebb9ed6b486ee32eb96e) Thanks [@varl](https://github.com/varl)! - Use logging provided by `@actions/core`
|
||||||
|
|
||||||
|
## 1.4.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#286](https://github.com/changesets/action/pull/286) [`225a1e8`](https://github.com/changesets/action/commit/225a1e8cbcabb7b585174ba0ad806549db40d4cd) Thanks [@varl](https://github.com/varl)! - This patch implements the [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) plugin and [wires
|
||||||
|
it up with the internal GitHub Octokit instance](https://github.com/actions/toolkit/tree/457303960f03375db6f033e214b9f90d79c3fe5c/packages/github#extending-the-octokit-instance).
|
||||||
|
|
||||||
|
This plugin is recommended by [the Octokit docs](://octokit.github.io/rest.js/v19#throttling) as it implements all the GitHub [best practices for integrators](https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28).
|
||||||
|
|
||||||
|
This should help with `changesets/action` gitting spurious secondary rate limits and failing CI jobs, for which the only known workaround is to simply re-run the job.
|
||||||
|
|
||||||
|
## 1.4.1
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#123](https://github.com/changesets/action/pull/123) [`b78f480`](https://github.com/changesets/action/commit/b78f48099899f0a853c5d9cd3feb21a5440babbd) Thanks [@Andarist](https://github.com/Andarist)! - Updated `@actions/*` dependencies to avoid using deprecated features of the runner.
|
||||||
|
|
||||||
|
## 1.4.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- [#216](https://github.com/changesets/action/pull/216) [`398d7ed`](https://github.com/changesets/action/commit/398d7ed) Thanks [@quinnjn](https://github.com/quinnjn)! - Execute action with node16 instead of node12.
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#228](https://github.com/changesets/action/pull/228) [`bff53cc`](https://github.com/changesets/action/commit/bff53cc50c1ebb33f8f558f9de2e0eb9a99230c6) Thanks [@iansan5653](https://github.com/iansan5653)! - Add `is:pull-request` to search query when looking for existing PR. This fixes an issue with user-owned PATs.
|
||||||
|
|
||||||
|
* [#206](https://github.com/changesets/action/pull/206) [`8c3f5f5`](https://github.com/changesets/action/commit/8c3f5f5637a95a2327e78d5dabcf357978aedcbb) Thanks [@glasser](https://github.com/glasser)! - Skip creating a PR when all existing changesets are empty.
|
||||||
|
|
||||||
|
## 1.3.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- [#167](https://github.com/changesets/action/pull/167) [`993a0a0`](https://github.com/changesets/action/commit/993a0a090df78cee07481d3886dcd8b29deb9567) Thanks [@dmregister](https://github.com/dmregister)! - Added `pullRequestNumber` to the action's outputs
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#157](https://github.com/changesets/action/pull/157) [`521c27b`](https://github.com/changesets/action/commit/521c27bf86ec53547d6a350d208fbbbc9d576fbc) Thanks [@emmenko](https://github.com/emmenko)! - Automatically adjust GitHub PR message if it exceeds a size limit of 60k characters by omitting some of the changelog information.
|
||||||
|
|
||||||
|
## 1.2.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#161](https://github.com/changesets/action/pull/161) [`52c9ce7`](https://github.com/changesets/action/commit/52c9ce75d9d8a14ea2d75e4157b0c15b7a4ac313) Thanks [@bicknellr](https://github.com/bicknellr)! - Change directory to `cwd` before running git user setup. This fixes an issue when the action starts its execution not in a git repository.
|
||||||
|
|
||||||
|
## 1.2.1
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- [#144](https://github.com/changesets/action/pull/144) [`898d125`](https://github.com/changesets/action/commit/898d125cee6ba00c6a11b6cadca512752c6c910c) Thanks [@Andarist](https://github.com/Andarist)! - Updated all Changesets dependencies. This should fix parsing issues for completely empty summaries that has been fixed in `@changesets/parse@0.3.11`.
|
||||||
|
|
||||||
|
## 1.2.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- [#130](https://github.com/changesets/action/pull/130) [`5c0997b`](https://github.com/changesets/action/commit/5c0997b25e175ecf5e1723ba07210bbcea5d92fb) Thanks [@akphi](https://github.com/akphi)! - Added `createGithubReleases` input option (defaults to `true`) to control whether to create Github releases during publish or not.
|
||||||
|
|
||||||
|
* [#134](https://github.com/changesets/action/pull/134) [`1ed9bc2`](https://github.com/changesets/action/commit/1ed9bc24b7a56462c183eb815c8f4bdf0e2e5785) Thanks [@dmregister](https://github.com/dmregister)! - Added `cwd` input option that can be used in projects that are not in the root directory.
|
||||||
|
|
||||||
|
## 1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- [#128](https://github.com/changesets/action/pull/128) [`1937303`](https://github.com/changesets/action/commit/19373036c4bad4b0183344b6f2623a3b0e42da6c) Thanks [@dhruvdutt](https://github.com/dhruvdutt)! - Setup the git user in the local config instead of the global one.
|
||||||
|
|
||||||
|
* [#131](https://github.com/changesets/action/pull/131) [`d3db9ec`](https://github.com/changesets/action/commit/d3db9eceaf41d42c56d5370d504c86851627188f) Thanks [@jacklesliewise](https://github.com/jacklesliewise)! - Added `setupGitUser` option to enable or disable setting up a default git user
|
||||||
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
### Major Changes
|
||||||
|
|
||||||
|
- [#118](https://github.com/changesets/action/pull/118) [`05c863d`](https://github.com/changesets/action/commit/05c863d3f980125585016a593b5cb45b27d19c2c) Thanks [@Andarist](https://github.com/Andarist)! - From now on this action will be released using the Changesets-based workflow (using itself). Thanks to that we'll have a good release history. The users will be able to find specific versions of the action and will be able to track changes over time. It also improves the security as the build artifact will always get built in the CI environment, using a frozen lockfile.
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) Changesets team and other contributors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,8 +1,11 @@
|
|||||||
# Changesets Release Action
|
# Changesets Release Action
|
||||||
|
|
||||||
> ⚠️ This branch has been frozen and deprecated. Please update your workflow to either use `@v1` or a specific commit SHA that is tagged.
|
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 master, the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
|
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
|
||||||
|
|
||||||
@@ -12,13 +15,18 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a
|
|||||||
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
|
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
|
||||||
- commit - The commit message to use. Default to `Version Packages`
|
- commit - The commit message to use. Default to `Version Packages`
|
||||||
- title - The pull request title. Default to `Version Packages`
|
- title - The pull request title. Default to `Version Packages`
|
||||||
|
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
|
||||||
|
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
|
||||||
|
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
|
||||||
|
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
|
||||||
|
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
|
||||||
|
|
||||||
### Outputs
|
### Outputs
|
||||||
|
|
||||||
- published - A boolean value to indicate whether a publishing is happened or not
|
- published - A boolean value to indicate whether a publishing has happened or not
|
||||||
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
||||||
|
|
||||||
### Example workflow:
|
### Example workflow
|
||||||
|
|
||||||
#### Without Publishing
|
#### Without Publishing
|
||||||
|
|
||||||
@@ -30,7 +38,9 @@ name: Release
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
|
|
||||||
|
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
@@ -38,23 +48,21 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v6
|
||||||
with:
|
|
||||||
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Setup Node.js 12.x
|
- name: Setup pnpm
|
||||||
uses: actions/setup-node@master
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
|
- name: Setup Node.js 26
|
||||||
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 12.x
|
node-version: 26
|
||||||
|
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: yarn
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Create Release Pull Request
|
- name: Create Release Pull Request
|
||||||
uses: changesets/action@master
|
uses: changesets/action@v1
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### With Publishing
|
#### With Publishing
|
||||||
@@ -67,7 +75,9 @@ name: Release
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
|
|
||||||
|
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
@@ -75,27 +85,26 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v6
|
||||||
with:
|
|
||||||
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Setup Node.js 12.x
|
- name: Setup pnpm
|
||||||
uses: actions/setup-node@master
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
|
- name: Setup Node.js 26
|
||||||
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 12.x
|
node-version: 26
|
||||||
|
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: yarn
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Create Release Pull Request or Publish to npm
|
- name: Create Release Pull Request or Publish to npm
|
||||||
id: changesets
|
id: changesets
|
||||||
uses: changesets/action@master
|
uses: changesets/action@v1
|
||||||
with:
|
with:
|
||||||
# This expects you to have a script called release which does a build for your packages and calls changeset publish
|
# This expects you to have a script called release which does a build for your packages and calls changeset publish
|
||||||
publish: yarn release
|
publish: pnpm release
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
|
|
||||||
- name: Send a Slack notification if a publish happens
|
- name: Send a Slack notification if a publish happens
|
||||||
@@ -106,7 +115,7 @@ jobs:
|
|||||||
|
|
||||||
By default the GitHub Action creates a `.npmrc` file with the following content:
|
By default the GitHub Action creates a `.npmrc` file with the following content:
|
||||||
|
|
||||||
```
|
```txt
|
||||||
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
|
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -117,13 +126,55 @@ For example, you can add a step before running the Changesets GitHub Action:
|
|||||||
- name: Creating .npmrc
|
- name: Creating .npmrc
|
||||||
run: |
|
run: |
|
||||||
cat << EOF > "$HOME/.npmrc"
|
cat << EOF > "$HOME/.npmrc"
|
||||||
email=my@email.com
|
|
||||||
//registry.npmjs.org/:_authToken=$NPM_TOKEN
|
//registry.npmjs.org/:_authToken=$NPM_TOKEN
|
||||||
EOF
|
EOF
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Custom Publishing
|
||||||
|
|
||||||
|
If you want to hook into when publishing should occur but have your own publishing functionality, you can utilize the `hasChangesets` output.
|
||||||
|
|
||||||
|
Note that you might need to account for things already being published in your script because a commit without any new changesets can always land on your base branch after a successful publish. In such a case you need to figure out on your own how to skip over the actual publishing logic or handle errors gracefully as most package registries won't allow you to publish over already published version.
|
||||||
|
|
||||||
|
```yml
|
||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Release
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout Repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Setup pnpm
|
||||||
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
|
- name: Setup Node.js 26
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: 26
|
||||||
|
|
||||||
|
- name: Install Dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Create Release Pull Request or Publish to npm
|
||||||
|
id: changesets
|
||||||
|
uses: changesets/action@v1
|
||||||
|
|
||||||
|
- name: Publish
|
||||||
|
if: steps.changesets.outputs.hasChangesets == 'false'
|
||||||
|
# You can do something when a publish should happen.
|
||||||
|
run: pnpm publish
|
||||||
|
```
|
||||||
|
|
||||||
#### With version script
|
#### With version script
|
||||||
|
|
||||||
If you need to add additional logic to the version command, you can do so by using a version script.
|
If you need to add additional logic to the version command, you can do so by using a version script.
|
||||||
@@ -136,7 +187,9 @@ name: Release
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
|
|
||||||
|
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
@@ -144,25 +197,24 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v6
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Setup Node.js 12.x
|
- name: Setup pnpm
|
||||||
uses: actions/setup-node@master
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
|
- name: Setup Node.js 26
|
||||||
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 12.x
|
node-version: 26
|
||||||
|
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: yarn
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Create Release Pull Request
|
- name: Create Release Pull Request
|
||||||
uses: changesets/action@master
|
uses: changesets/action@v1
|
||||||
with:
|
with:
|
||||||
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
|
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
|
||||||
version: yarn version
|
version: pnpm version
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### With Yarn 2 / Plug'n'Play
|
#### With Yarn 2 / Plug'n'Play
|
||||||
@@ -170,8 +222,8 @@ jobs:
|
|||||||
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI:
|
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: changesets/action@master
|
- uses: changesets/action@v1
|
||||||
with:
|
with:
|
||||||
version: yarn changeset version
|
version: yarn changeset version
|
||||||
...
|
# ...
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json",
|
|
||||||
"ignore": ["ignored-package-pkg-a"]
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"private": true,
|
|
||||||
"name": "ignored-package",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"workspaces": [
|
|
||||||
"packages/*"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "ignored-package-pkg-a",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"dependencies": {
|
|
||||||
"ignored-package-pkg-b": "1.0.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "ignored-package-pkg-b",
|
|
||||||
"version": "1.0.0"
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://unpkg.com/@changesets/config@1.3.0/schema.json"
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"private": true,
|
|
||||||
"name": "simple-project",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"workspaces": [
|
|
||||||
"packages/*"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "simple-project-pkg-a",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"dependencies": {
|
|
||||||
"simple-project-pkg-b": "1.0.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "simple-project-pkg-b",
|
|
||||||
"version": "1.0.0"
|
|
||||||
}
|
|
||||||
+34
-1
@@ -1,15 +1,22 @@
|
|||||||
name: Changesets
|
name: Changesets
|
||||||
description: A GitHub action to automate releases with Changesets
|
description: A GitHub action to automate releases with Changesets
|
||||||
runs:
|
runs:
|
||||||
using: "node12"
|
using: "node24"
|
||||||
main: "dist/index.js"
|
main: "dist/index.js"
|
||||||
inputs:
|
inputs:
|
||||||
|
github-token:
|
||||||
|
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
|
||||||
|
required: false
|
||||||
|
default: ${{ github.token }}
|
||||||
publish:
|
publish:
|
||||||
description: "The command to use to build and publish packages"
|
description: "The command to use to build and publish packages"
|
||||||
required: false
|
required: false
|
||||||
version:
|
version:
|
||||||
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
|
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
|
||||||
required: false
|
required: false
|
||||||
|
cwd:
|
||||||
|
description: Sets the cwd for the node process. Default to `process.cwd()`
|
||||||
|
required: false
|
||||||
commit:
|
commit:
|
||||||
description: |
|
description: |
|
||||||
The commit message. Default to `Version Packages`
|
The commit message. Default to `Version Packages`
|
||||||
@@ -17,12 +24,38 @@ inputs:
|
|||||||
title:
|
title:
|
||||||
description: The pull request title. Default to `Version Packages`
|
description: The pull request title. Default to `Version Packages`
|
||||||
required: false
|
required: false
|
||||||
|
setupGitUser:
|
||||||
|
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
createGithubReleases:
|
||||||
|
description: "A boolean value to indicate whether to create Github releases after `publish` or not"
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
commitMode:
|
||||||
|
description: >
|
||||||
|
An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
|
||||||
|
or "github-api" to push changes via the GitHub API. When using "github-api",
|
||||||
|
all commits and tags are signed using GitHub's GPG key and attributed to the user
|
||||||
|
or app who owns the GITHUB_TOKEN.
|
||||||
|
required: false
|
||||||
|
default: "git-cli"
|
||||||
|
branch:
|
||||||
|
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
|
||||||
|
required: false
|
||||||
|
prDraft:
|
||||||
|
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
|
||||||
|
required: false
|
||||||
outputs:
|
outputs:
|
||||||
published:
|
published:
|
||||||
description: A boolean value to indicate whether a publishing is happened or not
|
description: A boolean value to indicate whether a publishing is happened or not
|
||||||
publishedPackages:
|
publishedPackages:
|
||||||
description: >
|
description: >
|
||||||
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
||||||
|
hasChangesets:
|
||||||
|
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
|
||||||
|
pullRequestNumber:
|
||||||
|
description: The pull request number that was created or updated
|
||||||
branding:
|
branding:
|
||||||
icon: "package"
|
icon: "package"
|
||||||
color: "blue"
|
color: "blue"
|
||||||
|
|||||||
Vendored
+18
File diff suppressed because one or more lines are too long
Vendored
+150
-1061
File diff suppressed because one or more lines are too long
Vendored
+96
File diff suppressed because one or more lines are too long
Vendored
+1
@@ -0,0 +1 @@
|
|||||||
|
import{a as e,c as t,n,o as r,s as i,t as a}from"./github-DTObde6f.js";try{await o()}catch(e){i(e.message)}async function o(){let i=a.payload.pull_request;if(!i)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let o=e(`github-token`,{required:!0}),c=e(`body`,{required:!0}),l=e(`update-id`),u=l?s(l):null,d=u?`${u}\n\n${c}`:c,f={repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number,body:d},p=n(o),m;u&&(r(`Checking for existing comment...`),m=await p.rest.issues.listComments({repo:i.base.repo.name,owner:i.base.repo.owner.login,issue_number:i.number}).then(e=>e.data.find(e=>e.body?.includes(u))?.id)),m?(r(`Updating existing comment (id: ${m})...`),await p.rest.issues.updateComment({...f,comment_id:m}),t(`comment-id`,m)):(r(`Creating new comment...`),t(`comment-id`,(await p.rest.issues.createComment(f)).data.id)),r(`Done!`)}function s(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
|
||||||
Vendored
+39
File diff suppressed because one or more lines are too long
+45
-41
@@ -1,50 +1,54 @@
|
|||||||
{
|
{
|
||||||
"name": "@changesets/action",
|
"name": "@changesets/action",
|
||||||
"version": "0.1.0",
|
"version": "1.9.0",
|
||||||
"main": "dist/index.js",
|
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"type": "module",
|
||||||
"@changesets/cli": "^2.9.1",
|
"main": "dist/index.js",
|
||||||
"@changesets/write": "^0.1.3",
|
|
||||||
"fixturez": "^1.1.0",
|
|
||||||
"parcel": "^1.12.3",
|
|
||||||
"prettier": "^2.0.5",
|
|
||||||
"typescript": "^3.5.3"
|
|
||||||
},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "parcel build ./src/index.ts --no-source-maps --target=node --bundle-node-modules",
|
"build": "rolldown -c",
|
||||||
"test": "jest",
|
"test": "vitest",
|
||||||
"test:watch": "yarn test --watch"
|
"test:watch": "pnpm test --watch",
|
||||||
|
"typecheck": "tsc",
|
||||||
|
"format": "oxfmt --check",
|
||||||
|
"format:fix": "oxfmt",
|
||||||
|
"changeset": "changeset",
|
||||||
|
"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": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.6.0",
|
"@actions/core": "^3.0.1",
|
||||||
"@actions/exec": "^1.0.4",
|
"@actions/exec": "^3.0.0",
|
||||||
"@actions/github": "^4.0.0",
|
"@actions/github": "^9.1.1",
|
||||||
"@babel/core": "^7.13.10",
|
"@changesets/get-release-plan": "^4.0.16",
|
||||||
"@babel/preset-env": "^7.13.10",
|
"@changesets/ghcommit": "^2.1.1",
|
||||||
"@babel/preset-typescript": "^7.13.0",
|
"@changesets/git": "^3.0.4",
|
||||||
"@changesets/pre": "^1.0.4",
|
"@changesets/pre": "^2.0.2",
|
||||||
"@changesets/read": "^0.4.6",
|
"@changesets/read": "^0.6.7",
|
||||||
"@manypkg/get-packages": "^1.1.1",
|
"@manypkg/get-packages": "^1.1.3",
|
||||||
"@types/fs-extra": "^8.0.0",
|
"@octokit/core": "^7.0.6",
|
||||||
"@types/jest": "^24.0.18",
|
"@octokit/plugin-throttling": "^11.0.3",
|
||||||
"@types/node": "^12.7.1",
|
"human-id": "^4.1.3",
|
||||||
"@types/semver": "^6.0.2",
|
"markdown-table": "^3.0.4",
|
||||||
"babel-jest": "^24.9.0",
|
"semver": "^7.8.0",
|
||||||
"fs-extra": "^8.1.0",
|
"tinyexec": "^1.1.2"
|
||||||
"husky": "^3.0.3",
|
|
||||||
"jest": "^24.9.0",
|
|
||||||
"mdast-util-to-string": "^1.0.6",
|
|
||||||
"remark-parse": "^7.0.1",
|
|
||||||
"remark-stringify": "^7.0.3",
|
|
||||||
"resolve-from": "^5.0.0",
|
|
||||||
"semver": "^6.3.0",
|
|
||||||
"unified": "^8.3.2"
|
|
||||||
},
|
},
|
||||||
"husky": {
|
"devDependencies": {
|
||||||
"hooks": {
|
"@changesets/changelog-github": "^0.7.0",
|
||||||
"pre-commit": "yarn build && git add dist/index.js"
|
"@changesets/cli": "^2.31.0",
|
||||||
}
|
"@changesets/types": "^6.1.0",
|
||||||
|
"@changesets/write": "^0.4.0",
|
||||||
|
"@tsconfig/node24": "^24.0.4",
|
||||||
|
"@types/node": "^24.12.4",
|
||||||
|
"@types/semver": "^7.7.1",
|
||||||
|
"fs-fixture": "^2.13.0",
|
||||||
|
"oxfmt": "^0.48.0",
|
||||||
|
"rolldown": "^1.0.1",
|
||||||
|
"typescript": "^6.0.3",
|
||||||
|
"vitest": "^4.1.6"
|
||||||
},
|
},
|
||||||
"prettier": {}
|
"engines": {
|
||||||
|
"node": ">=24"
|
||||||
|
},
|
||||||
|
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a"
|
||||||
}
|
}
|
||||||
|
|||||||
Generated
+2405
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,13 @@
|
|||||||
|
blockExoticSubdeps: true
|
||||||
|
dedupePeers: true
|
||||||
|
dedupePeerDependents: true
|
||||||
|
minimumReleaseAge: 10080
|
||||||
|
minimumReleaseAgeExclude:
|
||||||
|
- "@changesets/ghcommit@2.1.1"
|
||||||
|
|
||||||
|
overrides:
|
||||||
|
lightningcss: "-" # we do not bundle any css
|
||||||
|
postcss: "-" # we do not bundle any css
|
||||||
|
|
||||||
|
shellEmulator: true
|
||||||
|
trustPolicy: no-downgrade
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# @changesets/action/pr-comment
|
||||||
|
|
||||||
|
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md).
|
||||||
|
|
||||||
|
This action is intentionally simple without advanced features. Check out other actions if so, such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
|
||||||
|
|
||||||
|
See the [action metadata](action.yml) for details on the inputs and outputs.
|
||||||
|
|
||||||
|
## Example setup
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: PR Comment
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
pr-comment:
|
||||||
|
runs-on: ubuntu-slim
|
||||||
|
permissions:
|
||||||
|
pull-requests: write # to create and update comments on PRs
|
||||||
|
steps:
|
||||||
|
- uses: changesets/action/pr-comment@v1
|
||||||
|
with:
|
||||||
|
body: Hello world!
|
||||||
|
```
|
||||||
|
|
||||||
|
When called repeatedly, the action will update the comment it created by default. If you use this action to create different types of comments, pass an `update-id` value to differentiate them.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
pr-comment:
|
||||||
|
# ...
|
||||||
|
steps:
|
||||||
|
- uses: changesets/action/pr-comment@v1
|
||||||
|
with:
|
||||||
|
body: Hello world!
|
||||||
|
update-id: my-tag
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to always create new comments, pass an empty value to `update-id`.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
pr-comment:
|
||||||
|
# ...
|
||||||
|
steps:
|
||||||
|
- uses: changesets/action/pr-comment@v1
|
||||||
|
with:
|
||||||
|
body: Hello world!
|
||||||
|
update-id: ""
|
||||||
|
```
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
name: Changesets - PR Comment
|
||||||
|
description: A simple GitHub Action to comment on PRs
|
||||||
|
runs:
|
||||||
|
using: node24
|
||||||
|
main: ../dist/pr-comment.js
|
||||||
|
inputs:
|
||||||
|
github-token:
|
||||||
|
description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
|
||||||
|
required: false
|
||||||
|
default: ${{ github.token }}
|
||||||
|
body:
|
||||||
|
description: "The comment body to post on the PR."
|
||||||
|
required: true
|
||||||
|
update-id:
|
||||||
|
description: >
|
||||||
|
By default, the action will create and update a comment with this id. Pass a different id to
|
||||||
|
create and update a new comment, or pass an empty string to disable updating comments.
|
||||||
|
required: false
|
||||||
|
default: "changesets-action-pr-comment"
|
||||||
|
outputs:
|
||||||
|
comment-id:
|
||||||
|
description: "The comment id of the comment that was created or updated."
|
||||||
|
branding:
|
||||||
|
icon: message-circle
|
||||||
|
color: blue
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
# changesets/action/pr-status
|
||||||
|
|
||||||
|
This action generates the changesets status in PRs, e.g. whether it has changeset files and which packages will be released if the PR is merged.
|
||||||
|
|
||||||
|
It requires the repo to be checked out, and automatically fetches the PR head ref into a temporary detached worktree in order to infer the changed files and packages. It also requires the [`pull_request_target`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) event to be triggered in order to have permissions to comment on the PR and to work in PRs from forks.
|
||||||
|
|
||||||
|
You can also use the [`pull_request`](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request) event if you prefer to lock permissions down and not run for PRs from forks. Make sure to add an if check to prevent the action from failing in fork PRs:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
pr-status:
|
||||||
|
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||||
|
# ...
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [action metadata](action.yml) for details on the inputs and outputs.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> **Do not run untrusted code** when using the `pull_request_target` event. The example below only checks out code and does not run any code from the PR. Read more about the `pull_request_target` event in the [GitHub documentation](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target).
|
||||||
|
|
||||||
|
## Example setup
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# .github/workflows/comment-changesets-pr-status.yml
|
||||||
|
name: Comment Changesets status in PRs
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
pr-status:
|
||||||
|
runs-on: ubuntu-slim
|
||||||
|
permissions:
|
||||||
|
contents: read # to check out files in the repo
|
||||||
|
outputs:
|
||||||
|
comment-body: ${{ steps.pr-status.outputs.comment-body }}
|
||||||
|
steps:
|
||||||
|
- name: Check out repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Generate status
|
||||||
|
id: pr-status
|
||||||
|
uses: changesets/action/pr-status@v1
|
||||||
|
|
||||||
|
pr-comment:
|
||||||
|
needs: pr-status
|
||||||
|
runs-on: ubuntu-slim
|
||||||
|
permissions:
|
||||||
|
pull-requests: write # to create and update comments on PRs
|
||||||
|
steps:
|
||||||
|
- name: Comment on PR
|
||||||
|
uses: changesets/action/pr-comment@v1
|
||||||
|
with:
|
||||||
|
body: ${{ needs.pr-status.outputs.comment-body }}
|
||||||
|
```
|
||||||
|
|
||||||
|
The workflow uses [`@changesets/action/pr-comment`](../pr-comment/README.md), which is a simple GitHub Action to comment on PRs.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
name: Changesets - PR Status
|
||||||
|
description: Generate the changesets status in PRs
|
||||||
|
runs:
|
||||||
|
using: node24
|
||||||
|
main: ../dist/pr-status.js
|
||||||
|
inputs: {}
|
||||||
|
outputs:
|
||||||
|
comment-body:
|
||||||
|
description: The generated comment body to present the changesets status in PRs.
|
||||||
|
branding:
|
||||||
|
icon: package
|
||||||
|
color: blue
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
import { defineConfig } from "rolldown";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
input: {
|
||||||
|
index: "src/index.ts",
|
||||||
|
["pr-status"]: "src/pr-status/index.ts",
|
||||||
|
["pr-comment"]: "src/pr-comment/index.ts",
|
||||||
|
},
|
||||||
|
output: {
|
||||||
|
dir: "dist",
|
||||||
|
format: "esm",
|
||||||
|
cleanDir: true,
|
||||||
|
minify: true,
|
||||||
|
comments: false,
|
||||||
|
},
|
||||||
|
platform: "node",
|
||||||
|
});
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import fs from "node:fs";
|
||||||
|
import path from "node:path";
|
||||||
|
import { exec } from "@actions/exec";
|
||||||
|
import pkgJson from "../package.json" with { type: "json" };
|
||||||
|
|
||||||
|
process.chdir(path.join(import.meta.dirname, ".."));
|
||||||
|
|
||||||
|
await exec("changeset", ["version"]);
|
||||||
|
|
||||||
|
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
|
||||||
|
|
||||||
|
const readmePath = path.join(import.meta.dirname, "..", "README.md");
|
||||||
|
const content = fs.readFileSync(readmePath, "utf8");
|
||||||
|
const updatedContent = content.replace(
|
||||||
|
/changesets\/action@[^\s]+/g,
|
||||||
|
`changesets/action@${releaseLine}`,
|
||||||
|
);
|
||||||
|
fs.writeFileSync(readmePath, updatedContent);
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
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}`,
|
||||||
|
]);
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import path from "node:path";
|
||||||
|
import { exec, getExecOutput } from "@actions/exec";
|
||||||
|
import pkgJson from "../package.json" with { type: "json" };
|
||||||
|
|
||||||
|
const tag = `v${pkgJson.version}`;
|
||||||
|
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
|
||||||
|
|
||||||
|
process.chdir(path.join(import.meta.dirname, ".."));
|
||||||
|
|
||||||
|
(async () => {
|
||||||
|
const { exitCode, stderr } = await getExecOutput(
|
||||||
|
`git`,
|
||||||
|
["ls-remote", "--exit-code", "origin", "--tags", `refs/tags/${tag}`],
|
||||||
|
{
|
||||||
|
ignoreReturnCode: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
if (exitCode === 0) {
|
||||||
|
console.log(
|
||||||
|
`Action is not being published because version ${tag} is already published`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (exitCode !== 2) {
|
||||||
|
throw new Error(`git ls-remote exited with ${exitCode}:\n${stderr}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
await exec("git", ["checkout", "--detach"]);
|
||||||
|
await exec("git", ["add", "--force", "dist"]);
|
||||||
|
await exec("git", ["commit", "-m", tag]);
|
||||||
|
|
||||||
|
await exec("changeset", ["tag"]);
|
||||||
|
|
||||||
|
await exec("git", [
|
||||||
|
"push",
|
||||||
|
"--force",
|
||||||
|
"--follow-tags",
|
||||||
|
"origin",
|
||||||
|
`HEAD:refs/heads/${releaseLine}`,
|
||||||
|
]);
|
||||||
|
})();
|
||||||
@@ -1,29 +1,51 @@
|
|||||||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||||
|
|
||||||
exports[`version creates simple PR 1`] = `
|
exports[`version > creates a draft PR when prDraft is "create" 1`] = `
|
||||||
Array [
|
[
|
||||||
Object {
|
{
|
||||||
"base": "some-branch",
|
"base": "some-branch",
|
||||||
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
# Releases
|
# Releases
|
||||||
## simple-project-pkg-a@1.1.0
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
### Minor Changes
|
### Minor Changes
|
||||||
|
|
||||||
- Awesome feature
|
- Awesome feature",
|
||||||
|
"draft": true,
|
||||||
|
"head": "changeset-release/some-branch",
|
||||||
|
"owner": "changesets",
|
||||||
|
"repo": "action",
|
||||||
|
"title": "Version Packages",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`version > creates simple PR 1`] = `
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"base": "some-branch",
|
||||||
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
|
# Releases
|
||||||
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- Awesome feature
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|
||||||
- Updated dependencies [undefined]
|
- Updated dependencies
|
||||||
- simple-project-pkg-b@1.1.0
|
- changesets-dev-simple-project-pkg-b@1.1.0
|
||||||
|
## changesets-dev-simple-project-pkg-b@1.1.0
|
||||||
## simple-project-pkg-b@1.1.0
|
|
||||||
|
|
||||||
### Minor Changes
|
### Minor Changes
|
||||||
|
|
||||||
- Awesome feature
|
- Awesome feature",
|
||||||
",
|
"draft": false,
|
||||||
"head": "changeset-release/some-branch",
|
"head": "changeset-release/some-branch",
|
||||||
"owner": "changesets",
|
"owner": "changesets",
|
||||||
"repo": "action",
|
"repo": "action",
|
||||||
@@ -32,19 +54,17 @@ Array [
|
|||||||
]
|
]
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`version doesn't include ignored package that got a dependency update in the PR body 1`] = `
|
exports[`version > does not include any release information if a message with simplified release info exceeds size limit 1`] = `
|
||||||
Array [
|
[
|
||||||
Object {
|
{
|
||||||
"base": "some-branch",
|
"base": "some-branch",
|
||||||
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
# Releases
|
# Releases
|
||||||
## ignored-package-pkg-b@1.1.0
|
|
||||||
|
|
||||||
### Minor Changes
|
> All release information have been omitted from this message, as the content exceeds the size limit.",
|
||||||
|
"draft": false,
|
||||||
- Awesome feature
|
|
||||||
",
|
|
||||||
"head": "changeset-release/some-branch",
|
"head": "changeset-release/some-branch",
|
||||||
"owner": "changesets",
|
"owner": "changesets",
|
||||||
"repo": "action",
|
"repo": "action",
|
||||||
@@ -53,19 +73,21 @@ Array [
|
|||||||
]
|
]
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`version only includes bumped packages in the PR body 1`] = `
|
exports[`version > does not include changelog entries if full message exceeds size limit 1`] = `
|
||||||
Array [
|
[
|
||||||
Object {
|
{
|
||||||
"base": "some-branch",
|
"base": "some-branch",
|
||||||
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
# Releases
|
# Releases
|
||||||
## simple-project-pkg-a@1.1.0
|
|
||||||
|
|
||||||
### Minor Changes
|
> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.
|
||||||
|
|
||||||
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
- Awesome feature
|
|
||||||
",
|
",
|
||||||
|
"draft": false,
|
||||||
"head": "changeset-release/some-branch",
|
"head": "changeset-release/some-branch",
|
||||||
"owner": "changesets",
|
"owner": "changesets",
|
||||||
"repo": "action",
|
"repo": "action",
|
||||||
@@ -73,3 +95,136 @@ Array [
|
|||||||
},
|
},
|
||||||
]
|
]
|
||||||
`;
|
`;
|
||||||
|
|
||||||
|
exports[`version > doesn't include ignored package that got a dependency update in the PR body 1`] = `
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"base": "some-branch",
|
||||||
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
|
# Releases
|
||||||
|
## changesets-dev-ignored-package-pkg-b@1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- Awesome feature",
|
||||||
|
"draft": false,
|
||||||
|
"head": "changeset-release/some-branch",
|
||||||
|
"owner": "changesets",
|
||||||
|
"repo": "action",
|
||||||
|
"title": "Version Packages",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`version > only includes bumped packages in the PR body 1`] = `
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"base": "some-branch",
|
||||||
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
|
# Releases
|
||||||
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- Awesome feature",
|
||||||
|
"draft": false,
|
||||||
|
"head": "changeset-release/some-branch",
|
||||||
|
"owner": "changesets",
|
||||||
|
"repo": "action",
|
||||||
|
"title": "Version Packages",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`version > updates an existing PR via GraphQL and converts it to draft when prDraft is "always" 1`] = `
|
||||||
|
[
|
||||||
|
"
|
||||||
|
mutation UpdatePullRequest(
|
||||||
|
$pullRequestId: ID!
|
||||||
|
$title: String!
|
||||||
|
$body: String!
|
||||||
|
) {
|
||||||
|
|
||||||
|
convertPullRequestToDraft(
|
||||||
|
input: {
|
||||||
|
pullRequestId: $pullRequestId
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
pullRequest {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
updatePullRequest(
|
||||||
|
input: {
|
||||||
|
pullRequestId: $pullRequestId
|
||||||
|
title: $title
|
||||||
|
body: $body
|
||||||
|
state: OPEN
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
pullRequest {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
",
|
||||||
|
{
|
||||||
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
|
# Releases
|
||||||
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- Awesome feature",
|
||||||
|
"pullRequestId": "PR_kwDOA",
|
||||||
|
"title": "Version Packages",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`version > updates an existing PR via GraphQL without converting it to draft when prDraft is "create" 1`] = `
|
||||||
|
[
|
||||||
|
"
|
||||||
|
mutation UpdatePullRequest(
|
||||||
|
$pullRequestId: ID!
|
||||||
|
$title: String!
|
||||||
|
$body: String!
|
||||||
|
) {
|
||||||
|
|
||||||
|
|
||||||
|
updatePullRequest(
|
||||||
|
input: {
|
||||||
|
pullRequestId: $pullRequestId
|
||||||
|
title: $title
|
||||||
|
body: $body
|
||||||
|
state: OPEN
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
pullRequest {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
",
|
||||||
|
{
|
||||||
|
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||||
|
|
||||||
|
|
||||||
|
# Releases
|
||||||
|
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- Awesome feature",
|
||||||
|
"pullRequestId": "PR_kwDOA",
|
||||||
|
"title": "Version Packages",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
`;
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||||
|
|
||||||
exports[`it sorts the things right 1`] = `
|
exports[`it sorts the things right 1`] = `
|
||||||
Array [
|
[
|
||||||
Object {
|
{
|
||||||
"highestLevel": 3,
|
"highestLevel": 3,
|
||||||
"name": "c",
|
"name": "c",
|
||||||
"private": false,
|
"private": false,
|
||||||
},
|
},
|
||||||
Object {
|
{
|
||||||
"highestLevel": 1,
|
"highestLevel": 1,
|
||||||
"name": "b",
|
"name": "b",
|
||||||
"private": false,
|
"private": false,
|
||||||
},
|
},
|
||||||
Object {
|
{
|
||||||
"highestLevel": 3,
|
"highestLevel": 3,
|
||||||
"name": "a",
|
"name": "a",
|
||||||
"private": true,
|
"private": true,
|
||||||
@@ -23,23 +23,21 @@ Array [
|
|||||||
exports[`it works 1`] = `
|
exports[`it works 1`] = `
|
||||||
"### Major Changes
|
"### Major Changes
|
||||||
|
|
||||||
- [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779):
|
- [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779):
|
||||||
|
|
||||||
- Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated
|
- Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|
||||||
- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):
|
- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):
|
||||||
|
|
||||||
- Update dependencies
|
- Update dependencies"
|
||||||
"
|
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`it works 2`] = `
|
exports[`it works 2`] = `
|
||||||
"### Patch Changes
|
"### Patch Changes
|
||||||
|
|
||||||
- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):
|
- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):
|
||||||
|
|
||||||
Move frontmatter in docs into comments
|
Move frontmatter in docs into comments"
|
||||||
"
|
|
||||||
`;
|
`;
|
||||||
|
|||||||
+129
@@ -0,0 +1,129 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
import { exec, getExecOutput } from "@actions/exec";
|
||||||
|
import * as github from "@actions/github";
|
||||||
|
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
|
||||||
|
import type { Octokit } from "./octokit.ts";
|
||||||
|
|
||||||
|
type GitOptions = {
|
||||||
|
cwd: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
const push = async (branch: string, options: GitOptions) => {
|
||||||
|
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
|
||||||
|
};
|
||||||
|
|
||||||
|
const switchToMaybeExistingBranch = async (
|
||||||
|
branch: string,
|
||||||
|
options: GitOptions,
|
||||||
|
) => {
|
||||||
|
let { stderr } = await getExecOutput("git", ["checkout", branch], {
|
||||||
|
ignoreReturnCode: true,
|
||||||
|
...options,
|
||||||
|
});
|
||||||
|
let isCreatingBranch = !stderr
|
||||||
|
.toString()
|
||||||
|
.includes(`Switched to a new branch '${branch}'`);
|
||||||
|
if (isCreatingBranch) {
|
||||||
|
await exec("git", ["checkout", "-b", branch], options);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const reset = async (pathSpec: string, options: GitOptions) => {
|
||||||
|
await exec("git", ["reset", `--hard`, pathSpec], options);
|
||||||
|
};
|
||||||
|
|
||||||
|
const commitAll = async (message: string, options: GitOptions) => {
|
||||||
|
await exec("git", ["add", "."], options);
|
||||||
|
await exec("git", ["commit", "-m", message], options);
|
||||||
|
};
|
||||||
|
|
||||||
|
const checkIfClean = async (options: GitOptions): Promise<boolean> => {
|
||||||
|
const { stdout } = await getExecOutput(
|
||||||
|
"git",
|
||||||
|
["status", "--porcelain"],
|
||||||
|
options,
|
||||||
|
);
|
||||||
|
return !stdout.length;
|
||||||
|
};
|
||||||
|
|
||||||
|
export class Git {
|
||||||
|
readonly octokit: Octokit | null;
|
||||||
|
readonly cwd: string;
|
||||||
|
|
||||||
|
constructor(args: { octokit?: Octokit; cwd: string }) {
|
||||||
|
this.octokit = args.octokit ?? null;
|
||||||
|
this.cwd = args.cwd;
|
||||||
|
}
|
||||||
|
|
||||||
|
async setupUser() {
|
||||||
|
if (this.octokit) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
|
||||||
|
cwd: this.cwd,
|
||||||
|
});
|
||||||
|
await exec(
|
||||||
|
"git",
|
||||||
|
[
|
||||||
|
"config",
|
||||||
|
"user.email",
|
||||||
|
`"41898282+github-actions[bot]@users.noreply.github.com"`,
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd: this.cwd,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async pushTag(tag: string) {
|
||||||
|
if (this.octokit) {
|
||||||
|
return this.octokit.rest.git
|
||||||
|
.createRef({
|
||||||
|
...github.context.repo,
|
||||||
|
ref: `refs/tags/${tag}`,
|
||||||
|
sha: github.context.sha,
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
// Assuming tag was manually pushed in custom publish script
|
||||||
|
core.warning(`Failed to create tag ${tag}: ${err.message}`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
await exec("git", ["push", "origin", tag], { cwd: this.cwd });
|
||||||
|
}
|
||||||
|
|
||||||
|
async prepareBranch(branch: string) {
|
||||||
|
if (this.octokit) {
|
||||||
|
// Preparing a new local branch is not necessary when using the API
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
|
||||||
|
await reset(github.context.sha, { cwd: this.cwd });
|
||||||
|
}
|
||||||
|
|
||||||
|
async pushChanges({ branch, message }: { branch: string; message: string }) {
|
||||||
|
if (this.octokit) {
|
||||||
|
/**
|
||||||
|
* Only add files form the current working directory
|
||||||
|
*
|
||||||
|
* This will emulate the behavior of `git add .`,
|
||||||
|
* used in {@link commitAll}.
|
||||||
|
*/
|
||||||
|
const addFromDirectory = this.cwd;
|
||||||
|
return commitChangesFromRepo({
|
||||||
|
octokit: this.octokit,
|
||||||
|
...github.context.repo,
|
||||||
|
branch,
|
||||||
|
message,
|
||||||
|
base: {
|
||||||
|
commit: github.context.sha,
|
||||||
|
},
|
||||||
|
cwd: this.cwd,
|
||||||
|
force: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (!(await checkIfClean({ cwd: this.cwd }))) {
|
||||||
|
await commitAll(message, { cwd: this.cwd });
|
||||||
|
}
|
||||||
|
await push(branch, { cwd: this.cwd });
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
import { exec } from "@actions/exec";
|
|
||||||
import { execWithOutput } from "./utils";
|
|
||||||
|
|
||||||
export const setupUser = async () => {
|
|
||||||
await exec("git", [
|
|
||||||
"config",
|
|
||||||
"--global",
|
|
||||||
"user.name",
|
|
||||||
`"github-actions[bot]"`,
|
|
||||||
]);
|
|
||||||
await exec("git", [
|
|
||||||
"config",
|
|
||||||
"--global",
|
|
||||||
"user.email",
|
|
||||||
`"github-actions[bot]@users.noreply.github.com"`,
|
|
||||||
]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const pullBranch = async (branch: string) => {
|
|
||||||
await exec("git", ["pull", "origin", branch]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const push = async (
|
|
||||||
branch: string,
|
|
||||||
{ force }: { force?: boolean } = {}
|
|
||||||
) => {
|
|
||||||
await exec(
|
|
||||||
"git",
|
|
||||||
["push", "origin", `HEAD:${branch}`, force && "--force"].filter<string>(
|
|
||||||
Boolean as any
|
|
||||||
)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const pushTags = async () => {
|
|
||||||
await exec("git", ["push", "origin", "--tags"]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const switchToMaybeExistingBranch = async (branch: string) => {
|
|
||||||
let { stderr } = await execWithOutput("git", ["checkout", branch], {
|
|
||||||
ignoreReturnCode: true,
|
|
||||||
});
|
|
||||||
let isCreatingBranch = !stderr
|
|
||||||
.toString()
|
|
||||||
.includes(`Switched to a new branch '${branch}'`);
|
|
||||||
if (isCreatingBranch) {
|
|
||||||
await exec("git", ["checkout", "-b", branch]);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export const reset = async (
|
|
||||||
pathSpec: string,
|
|
||||||
mode: "hard" | "soft" | "mixed" = "hard"
|
|
||||||
) => {
|
|
||||||
await exec("git", ["reset", `--${mode}`, pathSpec]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const commitAll = async (message: string) => {
|
|
||||||
await exec("git", ["add", "."]);
|
|
||||||
await exec("git", ["commit", "-m", message]);
|
|
||||||
};
|
|
||||||
|
|
||||||
export const checkIfClean = async (): Promise<boolean> => {
|
|
||||||
const { stdout } = await execWithOutput("git", ["status", "--porcelain"]);
|
|
||||||
return !stdout.length;
|
|
||||||
};
|
|
||||||
+116
-41
@@ -1,36 +1,63 @@
|
|||||||
|
import fs from "node:fs/promises";
|
||||||
|
import path from "node:path";
|
||||||
import * as core from "@actions/core";
|
import * as core from "@actions/core";
|
||||||
import fs from "fs-extra";
|
import { Git } from "./git.ts";
|
||||||
import * as gitUtils from "./gitUtils";
|
import { setupOctokit } from "./octokit.ts";
|
||||||
import { runPublish, runVersion } from "./run";
|
import readChangesetState from "./readChangesetState.ts";
|
||||||
import readChangesetState from "./readChangesetState";
|
import { runPublish, runVersion } from "./run.ts";
|
||||||
|
import { fileExists } from "./utils.ts";
|
||||||
core.warning(
|
|
||||||
"The workflow file using `changesets/action` is currently using `@master` as the version. This branch has been frozen and deprecated. Please update your workflow to either use `@v1` or a specific commit SHA that is tagged."
|
|
||||||
);
|
|
||||||
|
|
||||||
const getOptionalInput = (name: string) => core.getInput(name) || undefined;
|
const getOptionalInput = (name: string) => core.getInput(name) || undefined;
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
let githubToken = process.env.GITHUB_TOKEN;
|
// to maintain compatibility with workflows created before github-token input was introduced
|
||||||
|
// it's important to prefer the explicitly set GITHUB_TOKEN over the default token coming from github.token
|
||||||
|
let githubToken = process.env.GITHUB_TOKEN || core.getInput("github-token");
|
||||||
|
|
||||||
if (!githubToken) {
|
if (!githubToken) {
|
||||||
core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
|
core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log("setting git user");
|
const cwd = path.resolve(getOptionalInput("cwd") ?? "");
|
||||||
await gitUtils.setupUser();
|
core.info(`using resolved cwd: ${cwd}`);
|
||||||
|
|
||||||
console.log("setting GitHub credentials");
|
const octokit = setupOctokit(githubToken);
|
||||||
|
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
|
||||||
|
const prDraft = getOptionalInput("prDraft");
|
||||||
|
if (commitMode !== "git-cli" && commitMode !== "github-api") {
|
||||||
|
core.setFailed(`Invalid commit mode: ${commitMode}`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
|
||||||
|
core.setFailed(`Invalid prDraft: ${prDraft}`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const git = new Git({
|
||||||
|
octokit: commitMode === "github-api" ? octokit : undefined,
|
||||||
|
cwd,
|
||||||
|
});
|
||||||
|
|
||||||
|
let setupGitUser = core.getBooleanInput("setupGitUser");
|
||||||
|
|
||||||
|
if (setupGitUser) {
|
||||||
|
core.info("setting git user");
|
||||||
|
await git.setupUser();
|
||||||
|
}
|
||||||
|
|
||||||
|
core.info("setting GitHub credentials");
|
||||||
await fs.writeFile(
|
await fs.writeFile(
|
||||||
`${process.env.HOME}/.netrc`,
|
`${process.env.HOME}/.netrc`,
|
||||||
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
|
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
let { changesets } = await readChangesetState();
|
let { changesets } = await readChangesetState(cwd);
|
||||||
|
|
||||||
let publishScript = core.getInput("publish");
|
let publishScript = core.getInput("publish");
|
||||||
let hasChangesets = changesets.length !== 0;
|
let hasChangesets = changesets.length !== 0;
|
||||||
|
const hasNonEmptyChangesets = changesets.some(
|
||||||
|
(changeset) => changeset.releases.length > 0,
|
||||||
|
);
|
||||||
let hasPublishScript = !!publishScript;
|
let hasPublishScript = !!publishScript;
|
||||||
|
|
||||||
core.setOutput("published", "false");
|
core.setOutput("published", "false");
|
||||||
@@ -39,67 +66,115 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
|
|||||||
|
|
||||||
switch (true) {
|
switch (true) {
|
||||||
case !hasChangesets && !hasPublishScript:
|
case !hasChangesets && !hasPublishScript:
|
||||||
console.log("No changesets found");
|
core.info(
|
||||||
|
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
|
||||||
|
);
|
||||||
return;
|
return;
|
||||||
case !hasChangesets && hasPublishScript: {
|
case !hasChangesets && hasPublishScript: {
|
||||||
console.log(
|
core.info(
|
||||||
"No changesets found, attempting to publish any unpublished packages to npm"
|
"No changesets found. Attempting to publish any unpublished packages to npm",
|
||||||
);
|
);
|
||||||
|
|
||||||
let userNpmrcPath = `${process.env.HOME}/.npmrc`;
|
if (process.env.NPM_TOKEN) {
|
||||||
if (fs.existsSync(userNpmrcPath)) {
|
const userNpmrcPath = `${process.env.HOME}/.npmrc`;
|
||||||
console.log("Found existing user .npmrc file");
|
|
||||||
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
|
if (await fileExists(userNpmrcPath)) {
|
||||||
const authLine = userNpmrcContent.split("\n").find((line) => {
|
core.info("Found existing user .npmrc file");
|
||||||
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
|
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
|
||||||
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
|
const authLine = userNpmrcContent.split("\n").find((line) => {
|
||||||
});
|
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
|
||||||
if (authLine) {
|
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
|
||||||
console.log(
|
});
|
||||||
"Found existing auth token for the npm registry in the user .npmrc file"
|
if (authLine) {
|
||||||
);
|
core.info(
|
||||||
|
"Found existing auth token for the npm registry in the user .npmrc file",
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
core.info(
|
||||||
|
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one",
|
||||||
|
);
|
||||||
|
await fs.appendFile(
|
||||||
|
userNpmrcPath,
|
||||||
|
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`,
|
||||||
|
);
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
console.log(
|
core.info(
|
||||||
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one"
|
"No user .npmrc file found, creating one with NPM_TOKEN used as auth token",
|
||||||
);
|
);
|
||||||
fs.appendFileSync(
|
await fs.writeFile(
|
||||||
userNpmrcPath,
|
userNpmrcPath,
|
||||||
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
|
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
} else if (
|
||||||
|
process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN &&
|
||||||
|
process.env.ACTIONS_ID_TOKEN_REQUEST_URL
|
||||||
|
) {
|
||||||
|
core.info(
|
||||||
|
"No NPM_TOKEN found, but OIDC is available - using npm trusted publishing",
|
||||||
|
);
|
||||||
} else {
|
} else {
|
||||||
console.log("No user .npmrc file found, creating one");
|
core.info(
|
||||||
fs.writeFileSync(
|
"No NPM_TOKEN or OIDC available - assuming npm is already authenticated",
|
||||||
userNpmrcPath,
|
|
||||||
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await runPublish({
|
const result = await runPublish({
|
||||||
script: publishScript,
|
script: publishScript,
|
||||||
githubToken,
|
githubToken,
|
||||||
|
git,
|
||||||
|
octokit,
|
||||||
|
createGithubReleases: core.getBooleanInput("createGithubReleases"),
|
||||||
|
cwd,
|
||||||
});
|
});
|
||||||
|
|
||||||
if (result.published) {
|
if (result.published) {
|
||||||
core.setOutput("published", "true");
|
core.setOutput("published", "true");
|
||||||
core.setOutput(
|
core.setOutput(
|
||||||
"publishedPackages",
|
"publishedPackages",
|
||||||
JSON.stringify(result.publishedPackages)
|
JSON.stringify(result.publishedPackages),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (result.exitCode !== 0) {
|
||||||
|
core.error(
|
||||||
|
`Publish command exited with code ${result.exitCode}${
|
||||||
|
result.published
|
||||||
|
? `, but some packages were published: ${result.publishedPackages
|
||||||
|
.map((p) => `${p.name}@${p.version}`)
|
||||||
|
.join(", ")}`
|
||||||
|
: ""
|
||||||
|
}`,
|
||||||
|
);
|
||||||
|
process.exit(result.exitCode);
|
||||||
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
case hasChangesets:
|
case hasChangesets && !hasNonEmptyChangesets:
|
||||||
await runVersion({
|
core.info("All changesets are empty; not creating PR");
|
||||||
|
return;
|
||||||
|
case hasChangesets: {
|
||||||
|
const octokit = setupOctokit(githubToken);
|
||||||
|
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"),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
core.setOutput("pullRequestNumber", String(pullRequestNumber));
|
||||||
|
|
||||||
return;
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
})().catch((err) => {
|
})().catch((err) => {
|
||||||
console.error(err);
|
core.error(err);
|
||||||
core.setFailed(err.message);
|
core.setFailed(err.message);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
import { getOctokit } from "@actions/github";
|
||||||
|
import { throttling } from "@octokit/plugin-throttling";
|
||||||
|
|
||||||
|
export const setupOctokit = (githubToken: string) => {
|
||||||
|
return getOctokit(
|
||||||
|
githubToken,
|
||||||
|
{
|
||||||
|
throttle: {
|
||||||
|
onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
|
||||||
|
core.warning(
|
||||||
|
`Request quota exhausted for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (retryCount <= 2) {
|
||||||
|
core.info(`Retrying after ${retryAfter} seconds!`);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onSecondaryRateLimit: (
|
||||||
|
retryAfter,
|
||||||
|
options: any,
|
||||||
|
octokit,
|
||||||
|
retryCount,
|
||||||
|
) => {
|
||||||
|
core.warning(
|
||||||
|
`SecondaryRateLimit detected for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (retryCount <= 2) {
|
||||||
|
core.info(`Retrying after ${retryAfter} seconds!`);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
throttling,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Octokit = ReturnType<typeof setupOctokit>;
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
import * as github from "@actions/github";
|
||||||
|
|
||||||
|
type Octokit = ReturnType<typeof github.getOctokit>;
|
||||||
|
type CreateCommentParams = NonNullable<
|
||||||
|
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
|
||||||
|
>;
|
||||||
|
type UpdateCommentParams = NonNullable<
|
||||||
|
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
|
||||||
|
>;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await main();
|
||||||
|
} catch (err) {
|
||||||
|
core.setFailed((err as Error).message);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const context = github.context.payload.pull_request;
|
||||||
|
if (!context) {
|
||||||
|
throw new Error(
|
||||||
|
"This action should only be run on `pull_request_target` or `pull_request` events",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const githubToken = core.getInput("github-token", { required: true });
|
||||||
|
const body = core.getInput("body", { required: true });
|
||||||
|
const updateId = core.getInput("update-id");
|
||||||
|
|
||||||
|
const commentMarker = updateId ? getCommentMarker(updateId) : null;
|
||||||
|
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
|
||||||
|
const commentParam: CreateCommentParams | UpdateCommentParams = {
|
||||||
|
repo: context.base.repo.name,
|
||||||
|
owner: context.base.repo.owner.login,
|
||||||
|
issue_number: context.number,
|
||||||
|
body: commentBody,
|
||||||
|
};
|
||||||
|
|
||||||
|
const octokit = github.getOctokit(githubToken);
|
||||||
|
|
||||||
|
let existingCommentId: number | undefined;
|
||||||
|
if (commentMarker) {
|
||||||
|
core.info("Checking for existing comment...");
|
||||||
|
existingCommentId = await octokit.rest.issues
|
||||||
|
.listComments({
|
||||||
|
repo: context.base.repo.name,
|
||||||
|
owner: context.base.repo.owner.login,
|
||||||
|
issue_number: context.number,
|
||||||
|
})
|
||||||
|
.then((res) => {
|
||||||
|
const comment = res.data.find((c) => c.body?.includes(commentMarker));
|
||||||
|
return comment?.id;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (existingCommentId) {
|
||||||
|
core.info(`Updating existing comment (id: ${existingCommentId})...`);
|
||||||
|
await octokit.rest.issues.updateComment({
|
||||||
|
...commentParam,
|
||||||
|
comment_id: existingCommentId,
|
||||||
|
});
|
||||||
|
core.setOutput("comment-id", existingCommentId);
|
||||||
|
} else {
|
||||||
|
core.info("Creating new comment...");
|
||||||
|
const result = await octokit.rest.issues.createComment(commentParam);
|
||||||
|
core.setOutput("comment-id", result.data.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
core.info("Done!");
|
||||||
|
}
|
||||||
|
|
||||||
|
function getCommentMarker(updateId: string) {
|
||||||
|
const prefix = "changesets-action-pr-comment";
|
||||||
|
return prefix === updateId
|
||||||
|
? `<!-- ${prefix} -->`
|
||||||
|
: `<!-- ${prefix}:${updateId} -->`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
import * as github from "@actions/github";
|
||||||
|
import { getCommentMessage } from "./message.ts";
|
||||||
|
|
||||||
|
try {
|
||||||
|
await main();
|
||||||
|
} catch (err) {
|
||||||
|
core.setFailed((err as Error).message);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const context = github.context.payload.pull_request;
|
||||||
|
if (!context) {
|
||||||
|
throw new Error(
|
||||||
|
"This action should only be run on `pull_request_target` or `pull_request` events",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
core.info("Creating comment message...");
|
||||||
|
const commentBody = await getCommentMessage(context);
|
||||||
|
core.setOutput("comment-body", commentBody);
|
||||||
|
core.info("Done!");
|
||||||
|
}
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
import * as github from "@actions/github";
|
||||||
|
import getReleasePlan from "@changesets/get-release-plan";
|
||||||
|
import type {
|
||||||
|
ComprehensiveRelease,
|
||||||
|
ReleasePlan,
|
||||||
|
VersionType,
|
||||||
|
} from "@changesets/types";
|
||||||
|
import { markdownTable } from "markdown-table";
|
||||||
|
import {
|
||||||
|
getNewChangesetTemplateContent,
|
||||||
|
getNewChangesetUrl,
|
||||||
|
} from "./template.ts";
|
||||||
|
import { getPullRequestWorktree } from "./worktree.ts";
|
||||||
|
|
||||||
|
type PullRequestContext = NonNullable<
|
||||||
|
typeof github.context.payload.pull_request
|
||||||
|
>;
|
||||||
|
|
||||||
|
export async function getCommentMessage(context: PullRequestContext) {
|
||||||
|
await using worktree = await getPullRequestWorktree(context);
|
||||||
|
|
||||||
|
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
|
||||||
|
const templateContent = await getNewChangesetTemplateContent(
|
||||||
|
worktree.cwd,
|
||||||
|
worktree.baseRef,
|
||||||
|
context.title,
|
||||||
|
);
|
||||||
|
|
||||||
|
const newChangesetUrl = getNewChangesetUrl(
|
||||||
|
context.head.repo.html_url,
|
||||||
|
context.head.ref,
|
||||||
|
templateContent,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (releasePlan.changesets.length > 0) {
|
||||||
|
return getApproveMessage(context.head.sha, newChangesetUrl, releasePlan);
|
||||||
|
} else {
|
||||||
|
return getAbsentMessage(context.head.sha, newChangesetUrl, releasePlan);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getApproveMessage(
|
||||||
|
commitSha: string,
|
||||||
|
newChangesetUrl: string,
|
||||||
|
releasePlan: ReleasePlan,
|
||||||
|
) {
|
||||||
|
return `\
|
||||||
|
### 🦋 Changeset detected
|
||||||
|
|
||||||
|
Latest commit: ${commitSha}
|
||||||
|
|
||||||
|
**The changes in this PR will be included in the next version bump.**
|
||||||
|
|
||||||
|
${getReleasePlanMessage(releasePlan)}
|
||||||
|
|
||||||
|
Not sure what this means? [Click here to learn what changesets are](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
|
||||||
|
|
||||||
|
[Click here if you're a maintainer who wants to add another changeset to this PR](${newChangesetUrl})`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getAbsentMessage(
|
||||||
|
commitSha: string,
|
||||||
|
newChangesetUrl: string,
|
||||||
|
releasePlan: ReleasePlan,
|
||||||
|
) {
|
||||||
|
return `\
|
||||||
|
### ⚠️ No Changeset found
|
||||||
|
|
||||||
|
Latest commit: ${commitSha}
|
||||||
|
|
||||||
|
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
|
||||||
|
|
||||||
|
${getReleasePlanMessage(releasePlan)}
|
||||||
|
|
||||||
|
[Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
|
||||||
|
|
||||||
|
[Click here if you're a maintainer who wants to add a changeset to this PR](${newChangesetUrl})`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getReleasePlanMessage(releasePlan: ReleasePlan) {
|
||||||
|
const publishableReleases = releasePlan.releases.filter(
|
||||||
|
(r) => r.type !== "none",
|
||||||
|
) as (ComprehensiveRelease & { type: Exclude<VersionType, "none"> })[];
|
||||||
|
|
||||||
|
const table = markdownTable([
|
||||||
|
["Name", "Type"],
|
||||||
|
...publishableReleases.map((release) => {
|
||||||
|
return [
|
||||||
|
release.name,
|
||||||
|
{
|
||||||
|
major: "Major",
|
||||||
|
minor: "Minor",
|
||||||
|
patch: "Patch",
|
||||||
|
}[release.type],
|
||||||
|
];
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
|
||||||
|
let summary = "This PR includes ";
|
||||||
|
if (releasePlan.changesets.length === 0) {
|
||||||
|
summary += "no changesets";
|
||||||
|
} else {
|
||||||
|
summary += `changesets to release ${publishableReleases.length} package`;
|
||||||
|
if (publishableReleases.length !== 1) {
|
||||||
|
summary += "s";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return `\
|
||||||
|
<details>
|
||||||
|
<summary>${summary}</summary>
|
||||||
|
|
||||||
|
${
|
||||||
|
publishableReleases.length > 0
|
||||||
|
? table
|
||||||
|
: "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
|
||||||
|
}
|
||||||
|
|
||||||
|
</details>`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import { getChangedPackagesSinceRef } from "@changesets/git";
|
||||||
|
import { humanId } from "human-id";
|
||||||
|
|
||||||
|
export function getNewChangesetUrl(
|
||||||
|
headRepoUrl: string,
|
||||||
|
headRef: string,
|
||||||
|
templateContent: string,
|
||||||
|
) {
|
||||||
|
const fileName = humanId({ separator: "-", capitalize: false });
|
||||||
|
return `${headRepoUrl}/new/${headRef}?filename=.changeset/${fileName}.md&value=${encodeURIComponent(templateContent)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getNewChangesetTemplateContent(
|
||||||
|
cwd: string,
|
||||||
|
baseRef: string,
|
||||||
|
prTitle: string,
|
||||||
|
) {
|
||||||
|
const changedPackages = await getChangedPackagesSinceRef({
|
||||||
|
cwd,
|
||||||
|
ref: baseRef,
|
||||||
|
});
|
||||||
|
|
||||||
|
return `\
|
||||||
|
---
|
||||||
|
${changedPackages.map((p) => `"${p.packageJson.name}": patch`).join("\n")}
|
||||||
|
---
|
||||||
|
|
||||||
|
${prTitle}
|
||||||
|
`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
import { pathToFileURL } from "node:url";
|
||||||
|
import type * as github from "@actions/github";
|
||||||
|
import getReleasePlan from "@changesets/get-release-plan";
|
||||||
|
import { createFixture } from "fs-fixture";
|
||||||
|
import { exec } from "tinyexec";
|
||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { getPullRequestWorktree } from "./worktree.ts";
|
||||||
|
|
||||||
|
type PullRequestContext = NonNullable<
|
||||||
|
typeof github.context.payload.pull_request
|
||||||
|
>;
|
||||||
|
|
||||||
|
async function git(cwd: string, args: string[]) {
|
||||||
|
const output = await exec("git", args, {
|
||||||
|
nodeOptions: { cwd },
|
||||||
|
throwOnError: true,
|
||||||
|
});
|
||||||
|
return output.stdout.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("getPullRequestWorktree", () => {
|
||||||
|
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
|
||||||
|
// Local source repo
|
||||||
|
await using sourceRepoFixture = await createFixture({
|
||||||
|
".changeset/config.json": JSON.stringify({}),
|
||||||
|
"package.json": JSON.stringify({
|
||||||
|
name: "repo",
|
||||||
|
private: true,
|
||||||
|
workspaces: ["packages/*"],
|
||||||
|
}),
|
||||||
|
"packages/pkg-a/package.json": JSON.stringify({
|
||||||
|
name: "pkg-a",
|
||||||
|
version: "1.0.0",
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
const sourceRepo = sourceRepoFixture.path;
|
||||||
|
await git(sourceRepo, ["init", "-b", "main"]);
|
||||||
|
await git(sourceRepo, ["config", "user.name", "Test User"]);
|
||||||
|
await git(sourceRepo, ["config", "user.email", "test@example.com"]);
|
||||||
|
await git(sourceRepo, ["add", "."]);
|
||||||
|
await git(sourceRepo, ["commit", "-m", "base"]);
|
||||||
|
|
||||||
|
// Simulate remote bare git server
|
||||||
|
await using originBareFixture = await createFixture();
|
||||||
|
const originBare = originBareFixture.path;
|
||||||
|
await git(originBare, ["clone", "--bare", sourceRepo, originBare]);
|
||||||
|
|
||||||
|
// Simulate checkout PR in github action
|
||||||
|
await using checkoutRepoFixture = await createFixture();
|
||||||
|
const checkoutRepo = checkoutRepoFixture.path;
|
||||||
|
await git(checkoutRepo, [
|
||||||
|
"clone",
|
||||||
|
"--depth",
|
||||||
|
"1",
|
||||||
|
"--branch",
|
||||||
|
"main",
|
||||||
|
pathToFileURL(originBare).toString(),
|
||||||
|
checkoutRepo,
|
||||||
|
]);
|
||||||
|
|
||||||
|
// Simulate remote fork bare git server
|
||||||
|
await using forkBareFixture = await createFixture();
|
||||||
|
const forkBare = forkBareFixture.path;
|
||||||
|
await git(forkBare, ["clone", "--bare", originBare, forkBare]);
|
||||||
|
|
||||||
|
await using forkRepoFixture = await createFixture();
|
||||||
|
const forkRepo = forkRepoFixture.path;
|
||||||
|
await git(forkRepo, [
|
||||||
|
"clone",
|
||||||
|
"--depth",
|
||||||
|
"1",
|
||||||
|
"--branch",
|
||||||
|
"main",
|
||||||
|
pathToFileURL(forkBare).toString(),
|
||||||
|
forkRepo,
|
||||||
|
]);
|
||||||
|
await git(forkRepo, ["config", "user.name", "Test User"]);
|
||||||
|
await git(forkRepo, ["config", "user.email", "test@example.com"]);
|
||||||
|
await git(forkRepo, ["checkout", "-b", "feature"]);
|
||||||
|
|
||||||
|
await forkRepoFixture.mkdir("packages/pkg-a/src");
|
||||||
|
await forkRepoFixture.writeFile(
|
||||||
|
"packages/pkg-a/src/index.ts",
|
||||||
|
"export const value = 1;\n",
|
||||||
|
);
|
||||||
|
await forkRepoFixture.writeFile(
|
||||||
|
".changeset/add-pkg-a.md",
|
||||||
|
`\
|
||||||
|
---
|
||||||
|
"pkg-a": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Add pkg-a
|
||||||
|
`,
|
||||||
|
);
|
||||||
|
|
||||||
|
await git(forkRepo, ["add", "."]);
|
||||||
|
await git(forkRepo, ["commit", "-m", "feature"]);
|
||||||
|
await git(forkRepo, ["push", "origin", "feature"]);
|
||||||
|
|
||||||
|
// Run tests
|
||||||
|
const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
|
||||||
|
const context = {
|
||||||
|
number: 123,
|
||||||
|
base: {
|
||||||
|
ref: "main",
|
||||||
|
repo: {
|
||||||
|
clone_url: pathToFileURL(originBare).toString(),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
head: {
|
||||||
|
ref: "feature",
|
||||||
|
repo: {
|
||||||
|
clone_url: pathToFileURL(forkBare).toString(),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
await using worktree = await getPullRequestWorktree(
|
||||||
|
context satisfies PullRequestContext as PullRequestContext,
|
||||||
|
checkoutRepo,
|
||||||
|
);
|
||||||
|
|
||||||
|
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
|
||||||
|
|
||||||
|
const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
|
||||||
|
expect(currentHead).not.toBe(originalHead);
|
||||||
|
|
||||||
|
const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
|
||||||
|
expect(currentBranch).toBe("");
|
||||||
|
|
||||||
|
const releases = releasePlan.releases.map((release) => ({
|
||||||
|
name: release.name,
|
||||||
|
type: release.type,
|
||||||
|
newVersion: release.newVersion,
|
||||||
|
}));
|
||||||
|
expect(releases).toEqual([
|
||||||
|
{
|
||||||
|
name: "pkg-a",
|
||||||
|
type: "patch",
|
||||||
|
newVersion: "1.0.1",
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
|
||||||
|
expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
import { randomUUID } from "node:crypto";
|
||||||
|
import fs from "node:fs/promises";
|
||||||
|
import os from "node:os";
|
||||||
|
import path from "node:path";
|
||||||
|
import type * as github from "@actions/github";
|
||||||
|
import { isRepoShallow } from "@changesets/git";
|
||||||
|
import { exec } from "tinyexec";
|
||||||
|
|
||||||
|
type PullRequestContext = NonNullable<
|
||||||
|
typeof github.context.payload.pull_request
|
||||||
|
>;
|
||||||
|
|
||||||
|
type WorktreeInfo = {
|
||||||
|
baseRef: string;
|
||||||
|
cwd: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
type TinyexecOptions = Parameters<typeof exec>[2];
|
||||||
|
|
||||||
|
function git(cwd: string, args: string[], opts: TinyexecOptions = {}) {
|
||||||
|
return exec("git", args, {
|
||||||
|
nodeOptions: { cwd, ...opts.nodeOptions },
|
||||||
|
throwOnError: true,
|
||||||
|
...opts,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Ref {
|
||||||
|
fetchSource: string;
|
||||||
|
local: string;
|
||||||
|
remote: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getRefs(context: PullRequestContext): Record<"base" | "head", Ref> {
|
||||||
|
const suffix = `${context.number}-${randomUUID()}`;
|
||||||
|
return {
|
||||||
|
base: {
|
||||||
|
fetchSource: "origin",
|
||||||
|
local: `refs/changesets-action-pr-status/base/${suffix}`,
|
||||||
|
remote: `refs/heads/${context.base.ref}`,
|
||||||
|
},
|
||||||
|
head: {
|
||||||
|
fetchSource: context.head.repo.clone_url,
|
||||||
|
local: `refs/changesets-action-pr-status/head/${suffix}`,
|
||||||
|
remote: `refs/heads/${context.head.ref}`,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function deepenRef(cwd: string, ref: Ref, deepenBy: number) {
|
||||||
|
await git(cwd, [
|
||||||
|
"fetch",
|
||||||
|
"--no-tags",
|
||||||
|
`--deepen=${deepenBy}`,
|
||||||
|
ref.fetchSource,
|
||||||
|
`${ref.remote}:${ref.local}`,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ensureMergeBase(args: {
|
||||||
|
cwd: string;
|
||||||
|
refs: ReturnType<typeof getRefs>;
|
||||||
|
deepenBy?: number;
|
||||||
|
}) {
|
||||||
|
const { cwd, refs, deepenBy = 50 } = args;
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
const mergeBase = await git(cwd, ["merge-base", refs.base.local, "HEAD"], {
|
||||||
|
throwOnError: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (mergeBase.exitCode === 0) {
|
||||||
|
return mergeBase.stdout.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!(await isRepoShallow({ cwd }))) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to find merge base between "${refs.base.local}" and HEAD, and the repository is no longer shallow.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
await deepenRef(cwd, refs.base, deepenBy);
|
||||||
|
await deepenRef(cwd, refs.head, deepenBy);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function mkdtemp(prefix: string) {
|
||||||
|
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
|
||||||
|
|
||||||
|
return {
|
||||||
|
dir,
|
||||||
|
async [Symbol.asyncDispose]() {
|
||||||
|
await fs.rm(dir, { recursive: true, force: true });
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function tempRef(cwd: string, ref: Ref) {
|
||||||
|
await git(cwd, [
|
||||||
|
"fetch",
|
||||||
|
"--no-tags",
|
||||||
|
"--depth=1",
|
||||||
|
ref.fetchSource,
|
||||||
|
`${ref.remote}:${ref.local}`,
|
||||||
|
]);
|
||||||
|
return {
|
||||||
|
async [Symbol.asyncDispose]() {
|
||||||
|
await git(cwd, ["update-ref", "-d", ref.local], { throwOnError: false });
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function tempWorktree(cwd: string, dir: string, ref: Ref) {
|
||||||
|
await git(cwd, ["worktree", "add", "--detach", dir, ref.local]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
async [Symbol.asyncDispose]() {
|
||||||
|
await git(cwd, ["worktree", "remove", "--force", dir], {
|
||||||
|
throwOnError: false,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
type WithAsyncDispose<T> = T & {
|
||||||
|
[Symbol.asyncDispose](): Promise<void>;
|
||||||
|
};
|
||||||
|
|
||||||
|
function moveDisposable<T extends object>(
|
||||||
|
stack: AsyncDisposableStack,
|
||||||
|
value: T,
|
||||||
|
): WithAsyncDispose<T> {
|
||||||
|
const moved = stack.move();
|
||||||
|
return Object.assign(value, {
|
||||||
|
async [Symbol.asyncDispose]() {
|
||||||
|
await moved.disposeAsync();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getPullRequestWorktree(
|
||||||
|
context: PullRequestContext,
|
||||||
|
cwd: string = process.cwd(),
|
||||||
|
): Promise<WithAsyncDispose<WorktreeInfo>> {
|
||||||
|
await using stack = new AsyncDisposableStack();
|
||||||
|
const worktreeDir = stack.use(
|
||||||
|
await mkdtemp("changesets-action-pr-status-"),
|
||||||
|
).dir;
|
||||||
|
|
||||||
|
const refs = getRefs(context);
|
||||||
|
|
||||||
|
stack.use(await tempRef(cwd, refs.base));
|
||||||
|
stack.use(await tempRef(cwd, refs.head));
|
||||||
|
stack.use(await tempWorktree(cwd, worktreeDir, refs.head));
|
||||||
|
|
||||||
|
await ensureMergeBase({
|
||||||
|
cwd: worktreeDir,
|
||||||
|
refs,
|
||||||
|
});
|
||||||
|
|
||||||
|
return moveDisposable(stack, {
|
||||||
|
baseRef: refs.base.local,
|
||||||
|
cwd: worktreeDir,
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import { PreState, NewChangeset } from "@changesets/types";
|
|
||||||
import { readPreState } from "@changesets/pre";
|
import { readPreState } from "@changesets/pre";
|
||||||
import readChangesets from "@changesets/read";
|
import readChangesets from "@changesets/read";
|
||||||
|
import type { PreState, NewChangeset } from "@changesets/types";
|
||||||
|
|
||||||
export type ChangesetState = {
|
export type ChangesetState = {
|
||||||
preState: PreState | undefined;
|
preState: PreState | undefined;
|
||||||
@@ -8,20 +8,22 @@ export type ChangesetState = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export default async function readChangesetState(
|
export default async function readChangesetState(
|
||||||
cwd: string = process.cwd()
|
cwd: string = process.cwd(),
|
||||||
): Promise<ChangesetState> {
|
): Promise<ChangesetState> {
|
||||||
let preState = await readPreState(cwd);
|
let preState = await readPreState(cwd);
|
||||||
let isInPreMode = preState !== undefined && preState.mode === "pre";
|
|
||||||
|
|
||||||
let changesets = await readChangesets(cwd);
|
let changesets = await readChangesets(cwd);
|
||||||
|
|
||||||
if (isInPreMode) {
|
if (preState !== undefined && preState.mode === "pre") {
|
||||||
let changesetsToFilter = new Set(preState.changesets);
|
let changesetsToFilter = new Set(preState.changesets);
|
||||||
changesets = changesets.filter((x) => !changesetsToFilter.has(x.id));
|
|
||||||
|
return {
|
||||||
|
preState,
|
||||||
|
changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
preState: isInPreMode ? preState : undefined,
|
preState: undefined,
|
||||||
changesets,
|
changesets,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
+327
-46
@@ -1,12 +1,13 @@
|
|||||||
import fixturez from "fixturez";
|
import path from "node:path";
|
||||||
import * as github from "@actions/github";
|
import type { Changeset } from "@changesets/types";
|
||||||
import fs from "fs-extra";
|
|
||||||
import path from "path";
|
|
||||||
import writeChangeset from "@changesets/write";
|
import writeChangeset from "@changesets/write";
|
||||||
import { Changeset } from "@changesets/types";
|
import { createFixture } from "fs-fixture";
|
||||||
import { runVersion } from "./run";
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||||
|
import { Git } from "./git.ts";
|
||||||
|
import { setupOctokit } from "./octokit.ts";
|
||||||
|
import { runVersion } from "./run.ts";
|
||||||
|
|
||||||
jest.mock("@actions/github", () => ({
|
vi.mock("@actions/github", () => ({
|
||||||
context: {
|
context: {
|
||||||
repo: {
|
repo: {
|
||||||
owner: "changesets",
|
owner: "changesets",
|
||||||
@@ -15,100 +16,190 @@ jest.mock("@actions/github", () => ({
|
|||||||
ref: "refs/heads/some-branch",
|
ref: "refs/heads/some-branch",
|
||||||
sha: "xeac7",
|
sha: "xeac7",
|
||||||
},
|
},
|
||||||
getOctokit: jest.fn(),
|
getOctokit: () => ({
|
||||||
|
rest: mockedGithubMethods,
|
||||||
|
graphql: mockedGraphql,
|
||||||
|
}),
|
||||||
}));
|
}));
|
||||||
jest.mock("./gitUtils");
|
vi.mock("./git.ts");
|
||||||
|
vi.mock("@changesets/ghcommit/git");
|
||||||
|
|
||||||
let mockedGithubMethods = {
|
let mockedGithubMethods = {
|
||||||
search: {
|
|
||||||
issuesAndPullRequests: jest.fn(),
|
|
||||||
},
|
|
||||||
pulls: {
|
pulls: {
|
||||||
create: jest.fn(),
|
create: vi.fn(),
|
||||||
|
list: vi.fn(),
|
||||||
},
|
},
|
||||||
repos: {
|
repos: {
|
||||||
createRelease: jest.fn(),
|
createRelease: vi.fn(),
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
(github.getOctokit as any).mockImplementation(() => mockedGithubMethods);
|
let mockedGraphql = vi.fn();
|
||||||
|
|
||||||
let f = fixturez(__dirname);
|
const nodeModulesDir = path.join(import.meta.dirname, "..", "node_modules");
|
||||||
|
|
||||||
|
function createSimpleProjectFixture() {
|
||||||
|
return createFixture({
|
||||||
|
node_modules: (api) => api.symlink(nodeModulesDir),
|
||||||
|
".changeset/config.json": JSON.stringify({}),
|
||||||
|
"packages/pkg-a/package.json": JSON.stringify({
|
||||||
|
name: "changesets-dev-simple-project-pkg-a",
|
||||||
|
version: "1.0.0",
|
||||||
|
dependencies: {
|
||||||
|
"changesets-dev-simple-project-pkg-b": "1.0.0",
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
"packages/pkg-b/package.json": JSON.stringify({
|
||||||
|
name: "changesets-dev-simple-project-pkg-b",
|
||||||
|
version: "1.0.0",
|
||||||
|
}),
|
||||||
|
"package.json": JSON.stringify({
|
||||||
|
name: "simple-project",
|
||||||
|
version: "1.0.0",
|
||||||
|
private: true,
|
||||||
|
workspaces: ["packages/*"],
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function createIgnoredPackageFixture() {
|
||||||
|
return createFixture({
|
||||||
|
node_modules: (api) => api.symlink(nodeModulesDir),
|
||||||
|
".changeset/config.json": JSON.stringify({
|
||||||
|
ignore: ["changesets-dev-ignored-package-pkg-a"],
|
||||||
|
}),
|
||||||
|
"packages/pkg-a/package.json": JSON.stringify({
|
||||||
|
name: "changesets-dev-ignored-package-pkg-a",
|
||||||
|
version: "1.0.0",
|
||||||
|
dependencies: {
|
||||||
|
"changesets-dev-ignored-package-pkg-b": "1.0.0",
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
"packages/pkg-b/package.json": JSON.stringify({
|
||||||
|
name: "changesets-dev-ignored-package-pkg-b",
|
||||||
|
version: "1.0.0",
|
||||||
|
}),
|
||||||
|
"package.json": JSON.stringify({
|
||||||
|
name: "ignored-package",
|
||||||
|
version: "1.0.0",
|
||||||
|
private: true,
|
||||||
|
workspaces: ["packages/*"],
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
const linkNodeModules = async (cwd: string) => {
|
|
||||||
await fs.symlink(
|
|
||||||
path.join(__dirname, "..", "node_modules"),
|
|
||||||
path.join(cwd, "node_modules")
|
|
||||||
);
|
|
||||||
};
|
|
||||||
const writeChangesets = (changesets: Changeset[], cwd: string) => {
|
const writeChangesets = (changesets: Changeset[], cwd: string) => {
|
||||||
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
|
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
|
||||||
};
|
};
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
jest.clearAllMocks();
|
vi.clearAllMocks();
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("version", () => {
|
describe("version", () => {
|
||||||
it("creates simple PR", async () => {
|
it("creates simple PR", async () => {
|
||||||
let cwd = f.copy("simple-project");
|
await using fixture = await createSimpleProjectFixture();
|
||||||
linkNodeModules(cwd);
|
const cwd = fixture.path;
|
||||||
|
|
||||||
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
|
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||||
() => ({ data: { items: [] } })
|
|
||||||
);
|
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
|
||||||
|
data: { number: 123 },
|
||||||
|
}));
|
||||||
|
|
||||||
await writeChangesets(
|
await writeChangesets(
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
releases: [
|
releases: [
|
||||||
{
|
{
|
||||||
name: "simple-project-pkg-a",
|
name: "changesets-dev-simple-project-pkg-a",
|
||||||
type: "minor",
|
type: "minor",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "simple-project-pkg-b",
|
name: "changesets-dev-simple-project-pkg-b",
|
||||||
type: "minor",
|
type: "minor",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
summary: "Awesome feature",
|
summary: "Awesome feature",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
cwd
|
cwd,
|
||||||
);
|
);
|
||||||
|
|
||||||
await runVersion({
|
await runVersion({
|
||||||
|
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("only includes bumped packages in the PR body", async () => {
|
it('creates a draft PR when prDraft is "create"', async () => {
|
||||||
let cwd = f.copy("simple-project");
|
await using fixture = await createSimpleProjectFixture();
|
||||||
linkNodeModules(cwd);
|
const cwd = fixture.path;
|
||||||
|
|
||||||
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
|
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||||
() => ({ data: { items: [] } })
|
|
||||||
);
|
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
|
||||||
|
data: { number: 123 },
|
||||||
|
}));
|
||||||
|
|
||||||
await writeChangesets(
|
await writeChangesets(
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
releases: [
|
releases: [
|
||||||
{
|
{
|
||||||
name: "simple-project-pkg-a",
|
name: "changesets-dev-simple-project-pkg-a",
|
||||||
type: "minor",
|
type: "minor",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
summary: "Awesome feature",
|
summary: "Awesome feature",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
cwd
|
cwd,
|
||||||
);
|
);
|
||||||
|
|
||||||
await runVersion({
|
await runVersion({
|
||||||
|
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||||
githubToken: "@@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 () => {
|
||||||
|
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,
|
cwd,
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -116,33 +207,223 @@ describe("version", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it("doesn't include ignored package that got a dependency update in the PR body", async () => {
|
it("doesn't include ignored package that got a dependency update in the PR body", async () => {
|
||||||
let cwd = f.copy("ignored-package");
|
await using fixture = await createIgnoredPackageFixture();
|
||||||
linkNodeModules(cwd);
|
const cwd = fixture.path;
|
||||||
|
|
||||||
mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
|
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||||
() => ({ data: { items: [] } })
|
|
||||||
);
|
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
|
||||||
|
data: { number: 123 },
|
||||||
|
}));
|
||||||
|
|
||||||
await writeChangesets(
|
await writeChangesets(
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
releases: [
|
releases: [
|
||||||
{
|
{
|
||||||
name: "ignored-package-pkg-b",
|
name: "changesets-dev-ignored-package-pkg-b",
|
||||||
type: "minor",
|
type: "minor",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
summary: "Awesome feature",
|
summary: "Awesome feature",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
cwd
|
cwd,
|
||||||
);
|
);
|
||||||
|
|
||||||
await runVersion({
|
await runVersion({
|
||||||
|
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("does not include changelog entries if full message exceeds size limit", async () => {
|
||||||
|
await using fixture = await createSimpleProjectFixture();
|
||||||
|
const cwd = fixture.path;
|
||||||
|
|
||||||
|
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||||
|
|
||||||
|
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
|
||||||
|
data: { number: 123 },
|
||||||
|
}));
|
||||||
|
|
||||||
|
await writeChangesets(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
releases: [
|
||||||
|
{
|
||||||
|
name: "changesets-dev-simple-project-pkg-a",
|
||||||
|
type: "minor",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
summary: `# Non manus superum
|
||||||
|
|
||||||
|
## Nec cornibus aequa numinis multo onerosior adde
|
||||||
|
|
||||||
|
Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
|
||||||
|
limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
|
||||||
|
locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
|
||||||
|
viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
|
||||||
|
dictis, qua, in.
|
||||||
|
|
||||||
|
In modo. Nomen illa membra.
|
||||||
|
|
||||||
|
> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
|
||||||
|
> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
|
||||||
|
> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
|
||||||
|
> dividite proculcat facit, visa.
|
||||||
|
|
||||||
|
Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
|
||||||
|
decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
|
||||||
|
fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
cwd,
|
||||||
|
);
|
||||||
|
|
||||||
|
await runVersion({
|
||||||
|
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||||
|
githubToken: "@@GITHUB_TOKEN",
|
||||||
|
git: new Git({ cwd }),
|
||||||
|
cwd,
|
||||||
|
prBodyMaxCharacters: 1000,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
|
||||||
|
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
|
||||||
|
/The changelog information of each package has been omitted from this message/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
|
||||||
|
await using fixture = await createSimpleProjectFixture();
|
||||||
|
const cwd = fixture.path;
|
||||||
|
|
||||||
|
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||||
|
|
||||||
|
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
|
||||||
|
data: { number: 123 },
|
||||||
|
}));
|
||||||
|
|
||||||
|
await writeChangesets(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
releases: [
|
||||||
|
{
|
||||||
|
name: "changesets-dev-simple-project-pkg-a",
|
||||||
|
type: "minor",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
summary: `# Non manus superum
|
||||||
|
|
||||||
|
## Nec cornibus aequa numinis multo onerosior adde
|
||||||
|
|
||||||
|
Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
|
||||||
|
limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
|
||||||
|
locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
|
||||||
|
viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
|
||||||
|
dictis, qua, in.
|
||||||
|
|
||||||
|
In modo. Nomen illa membra.
|
||||||
|
|
||||||
|
> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
|
||||||
|
> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
|
||||||
|
> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
|
||||||
|
> dividite proculcat facit, visa.
|
||||||
|
|
||||||
|
Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
|
||||||
|
decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
|
||||||
|
fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
cwd,
|
||||||
|
);
|
||||||
|
|
||||||
|
await runVersion({
|
||||||
|
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||||
|
githubToken: "@@GITHUB_TOKEN",
|
||||||
|
git: new Git({ cwd }),
|
||||||
|
cwd,
|
||||||
|
prBodyMaxCharacters: 500,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
|
||||||
|
expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
|
||||||
|
/All release information have been omitted from this message, as the content exceeds the size limit/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
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();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
+321
-174
@@ -1,57 +1,70 @@
|
|||||||
import { exec } from "@actions/exec";
|
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 * as github from "@actions/github";
|
import * as github from "@actions/github";
|
||||||
import fs from "fs-extra";
|
import type { PreState } from "@changesets/types";
|
||||||
import { getPackages, Package } from "@manypkg/get-packages";
|
import { type Package, getPackages } from "@manypkg/get-packages";
|
||||||
import path from "path";
|
import semverLt from "semver/functions/lt.js";
|
||||||
import * as semver from "semver";
|
import { Git } from "./git.ts";
|
||||||
|
import type { Octokit } from "./octokit.ts";
|
||||||
|
import readChangesetState from "./readChangesetState.ts";
|
||||||
import {
|
import {
|
||||||
getChangelogEntry,
|
|
||||||
execWithOutput,
|
|
||||||
getChangedPackages,
|
getChangedPackages,
|
||||||
sortTheThings,
|
getChangelogEntry,
|
||||||
getVersionsByDirectory,
|
getVersionsByDirectory,
|
||||||
} from "./utils";
|
isErrorWithCode,
|
||||||
import * as gitUtils from "./gitUtils";
|
sortTheThings,
|
||||||
import readChangesetState from "./readChangesetState";
|
} from "./utils.ts";
|
||||||
import resolveFrom from "resolve-from";
|
|
||||||
|
const require = createRequire(import.meta.url);
|
||||||
|
|
||||||
|
// GitHub Issues/PRs messages have a max size limit on the
|
||||||
|
// message body payload.
|
||||||
|
// `body is too long (maximum is 65536 characters)`.
|
||||||
|
// To avoid that, we ensure to cap the message to 60k chars.
|
||||||
|
const MAX_CHARACTERS_PER_MESSAGE = 60000;
|
||||||
|
|
||||||
const createRelease = async (
|
const createRelease = async (
|
||||||
octokit: ReturnType<typeof github.getOctokit>,
|
octokit: Octokit,
|
||||||
{ pkg, tagName }: { pkg: Package; tagName: string }
|
{ pkg, tagName }: { pkg: Package; tagName: string },
|
||||||
) => {
|
) => {
|
||||||
|
let changelog;
|
||||||
try {
|
try {
|
||||||
let changelogFileName = path.join(pkg.dir, "CHANGELOG.md");
|
changelog = await fs.readFile(path.join(pkg.dir, "CHANGELOG.md"), "utf8");
|
||||||
|
|
||||||
let changelog = await fs.readFile(changelogFileName, "utf8");
|
|
||||||
|
|
||||||
let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version);
|
|
||||||
if (!changelogEntry) {
|
|
||||||
// we can find a changelog but not the entry for this version
|
|
||||||
// if this is true, something has probably gone wrong
|
|
||||||
throw new Error(
|
|
||||||
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
await octokit.repos.createRelease({
|
|
||||||
name: tagName,
|
|
||||||
tag_name: tagName,
|
|
||||||
body: changelogEntry.content,
|
|
||||||
prerelease: pkg.packageJson.version.includes("-"),
|
|
||||||
...github.context.repo,
|
|
||||||
});
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
// if we can't find a changelog, the user has probably disabled changelogs
|
if (isErrorWithCode(err, "ENOENT")) {
|
||||||
if (err.code !== "ENOENT") {
|
// if we can't find a changelog, the user has probably disabled changelogs
|
||||||
throw err;
|
return;
|
||||||
}
|
}
|
||||||
|
throw err;
|
||||||
}
|
}
|
||||||
|
let changelogEntry = getChangelogEntry(changelog, pkg.packageJson.version);
|
||||||
|
if (!changelogEntry) {
|
||||||
|
// we can find a changelog but not the entry for this version
|
||||||
|
// if this is true, something has probably gone wrong
|
||||||
|
throw new Error(
|
||||||
|
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
await octokit.rest.repos.createRelease({
|
||||||
|
name: tagName,
|
||||||
|
tag_name: tagName,
|
||||||
|
body: changelogEntry.content,
|
||||||
|
prerelease: pkg.packageJson.version.includes("-"),
|
||||||
|
...github.context.repo,
|
||||||
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
type PublishOptions = {
|
type PublishOptions = {
|
||||||
script: string;
|
script: string;
|
||||||
githubToken: string;
|
githubToken: string;
|
||||||
cwd?: string;
|
octokit: Octokit;
|
||||||
|
createGithubReleases: boolean;
|
||||||
|
git: Git;
|
||||||
|
cwd: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
type PublishedPackage = { name: string; version: string };
|
type PublishedPackage = { name: string; version: string };
|
||||||
@@ -60,26 +73,26 @@ 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,
|
||||||
cwd = process.cwd(),
|
git,
|
||||||
|
octokit,
|
||||||
|
createGithubReleases,
|
||||||
|
cwd,
|
||||||
}: PublishOptions): Promise<PublishResult> {
|
}: PublishOptions): Promise<PublishResult> {
|
||||||
let octokit = github.getOctokit(githubToken);
|
let changesetPublishOutput = await getExecOutput(script, undefined, {
|
||||||
let [publishCommand, ...publishArgs] = script.split(/\s+/);
|
cwd,
|
||||||
|
ignoreReturnCode: true,
|
||||||
let changesetPublishOutput = await execWithOutput(
|
env: { ...process.env, GITHUB_TOKEN: githubToken },
|
||||||
publishCommand,
|
});
|
||||||
publishArgs,
|
|
||||||
{ cwd }
|
|
||||||
);
|
|
||||||
|
|
||||||
await gitUtils.pushTags();
|
|
||||||
|
|
||||||
let { packages, tool } = await getPackages(cwd);
|
let { packages, tool } = await getPackages(cwd);
|
||||||
let releasedPackages: Package[] = [];
|
let releasedPackages: Package[] = [];
|
||||||
@@ -98,25 +111,26 @@ 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);
|
||||||
}
|
}
|
||||||
|
|
||||||
await Promise.all(
|
if (createGithubReleases) {
|
||||||
releasedPackages.map((pkg) =>
|
await Promise.all(
|
||||||
createRelease(octokit, {
|
releasedPackages.map(async (pkg) => {
|
||||||
pkg,
|
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
|
||||||
tagName: `${pkg.packageJson.name}@${pkg.packageJson.version}`,
|
await git.pushTag(tagName);
|
||||||
})
|
await createRelease(octokit, { pkg, tagName });
|
||||||
)
|
}),
|
||||||
);
|
);
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
if (packages.length === 0) {
|
if (packages.length === 0) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`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];
|
||||||
@@ -127,10 +141,11 @@ export async function runPublish({
|
|||||||
|
|
||||||
if (match) {
|
if (match) {
|
||||||
releasedPackages.push(pkg);
|
releasedPackages.push(pkg);
|
||||||
await createRelease(octokit, {
|
if (createGithubReleases) {
|
||||||
pkg,
|
const tagName = `v${pkg.packageJson.version}`;
|
||||||
tagName: `v${pkg.packageJson.version}`,
|
await git.pushTag(tagName);
|
||||||
});
|
await createRelease(octokit, { pkg, tagName });
|
||||||
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -143,151 +158,283 @@ export async function runPublish({
|
|||||||
name: pkg.packageJson.name,
|
name: pkg.packageJson.name,
|
||||||
version: pkg.packageJson.version,
|
version: pkg.packageJson.version,
|
||||||
})),
|
})),
|
||||||
|
exitCode: changesetPublishOutput.exitCode,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
return { published: false };
|
return { published: false, exitCode: changesetPublishOutput.exitCode };
|
||||||
}
|
}
|
||||||
|
|
||||||
const requireChangesetsCliPkgJson = (cwd: string) => {
|
const requireChangesetsCliPkgJson = (cwd: string) => {
|
||||||
try {
|
try {
|
||||||
return require(resolveFrom(cwd, "@changesets/cli/package.json"));
|
return require(
|
||||||
|
require.resolve("@changesets/cli/package.json", {
|
||||||
|
paths: [cwd],
|
||||||
|
}),
|
||||||
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
if (err && err.code === "MODULE_NOT_FOUND") {
|
if (isErrorWithCode(err, "MODULE_NOT_FOUND")) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`
|
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`,
|
||||||
|
{ cause: err },
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
type VersionOptions = {
|
type GetMessageOptions = {
|
||||||
script?: string;
|
hasPublishScript: boolean;
|
||||||
githubToken: string;
|
branch: string;
|
||||||
cwd?: string;
|
changedPackagesInfo: {
|
||||||
prTitle?: string;
|
highestLevel: number;
|
||||||
commitMessage?: string;
|
private: boolean;
|
||||||
hasPublishScript?: boolean;
|
content: string;
|
||||||
|
header: string;
|
||||||
|
}[];
|
||||||
|
prBodyMaxCharacters: number;
|
||||||
|
preState?: PreState;
|
||||||
};
|
};
|
||||||
|
|
||||||
export async function runVersion({
|
export async function getVersionPrBody({
|
||||||
script,
|
hasPublishScript,
|
||||||
githubToken,
|
preState,
|
||||||
cwd = process.cwd(),
|
changedPackagesInfo,
|
||||||
prTitle = "Version Packages",
|
prBodyMaxCharacters,
|
||||||
commitMessage = "Version Packages",
|
branch,
|
||||||
hasPublishScript = false,
|
}: GetMessageOptions) {
|
||||||
}: VersionOptions) {
|
let messageHeader = `This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and ${
|
||||||
let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
|
hasPublishScript
|
||||||
let branch = github.context.ref.replace("refs/heads/", "");
|
? `the packages will be published to npm automatically`
|
||||||
let versionBranch = `changeset-release/${branch}`;
|
: `publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing)`
|
||||||
let octokit = github.getOctokit(githubToken);
|
}. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${branch}, this PR will be updated.
|
||||||
let { preState } = await readChangesetState(cwd);
|
`;
|
||||||
|
let messagePrestate = !!preState
|
||||||
await gitUtils.switchToMaybeExistingBranch(versionBranch);
|
? `⚠️⚠️⚠️⚠️⚠️⚠️
|
||||||
await gitUtils.reset(github.context.sha);
|
|
||||||
|
|
||||||
let versionsByDirectory = await getVersionsByDirectory(cwd);
|
|
||||||
|
|
||||||
if (script) {
|
|
||||||
let [versionCommand, ...versionArgs] = script.split(/\s+/);
|
|
||||||
await exec(versionCommand, versionArgs, { cwd });
|
|
||||||
} else {
|
|
||||||
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
|
|
||||||
let cmd = semver.lt(changesetsCliPkgJson.version, "2.0.0")
|
|
||||||
? "bump"
|
|
||||||
: "version";
|
|
||||||
await exec("node", [resolveFrom(cwd, "@changesets/cli/bin.js"), cmd], {
|
|
||||||
cwd,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
let searchQuery = `repo:${repo}+state:open+head:${versionBranch}+base:${branch}`;
|
|
||||||
let searchResultPromise = octokit.search.issuesAndPullRequests({
|
|
||||||
q: searchQuery,
|
|
||||||
});
|
|
||||||
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
|
|
||||||
|
|
||||||
let prBodyPromise = (async () => {
|
|
||||||
return (
|
|
||||||
`This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and ${
|
|
||||||
hasPublishScript
|
|
||||||
? `the packages will be published to npm automatically`
|
|
||||||
: `publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing)`
|
|
||||||
}. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${branch}, this PR will be updated.
|
|
||||||
${
|
|
||||||
!!preState
|
|
||||||
? `
|
|
||||||
⚠️⚠️⚠️⚠️⚠️⚠️
|
|
||||||
|
|
||||||
\`${branch}\` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run \`changeset pre exit\` on \`${branch}\`.
|
\`${branch}\` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run \`changeset pre exit\` on \`${branch}\`.
|
||||||
|
|
||||||
⚠️⚠️⚠️⚠️⚠️⚠️
|
⚠️⚠️⚠️⚠️⚠️⚠️
|
||||||
`
|
`
|
||||||
: ""
|
: "";
|
||||||
}
|
let messageReleasesHeading = `# Releases`;
|
||||||
# Releases
|
|
||||||
` +
|
|
||||||
(
|
|
||||||
await Promise.all(
|
|
||||||
changedPackages.map(async (pkg) => {
|
|
||||||
let changelogContents = await fs.readFile(
|
|
||||||
path.join(pkg.dir, "CHANGELOG.md"),
|
|
||||||
"utf8"
|
|
||||||
);
|
|
||||||
|
|
||||||
let entry = getChangelogEntry(
|
let fullMessage = [
|
||||||
changelogContents,
|
messageHeader,
|
||||||
pkg.packageJson.version
|
messagePrestate,
|
||||||
);
|
messageReleasesHeading,
|
||||||
return {
|
...changedPackagesInfo.map((info) => `${info.header}\n\n${info.content}`),
|
||||||
highestLevel: entry.highestLevel,
|
].join("\n");
|
||||||
private: !!pkg.packageJson.private,
|
|
||||||
content:
|
|
||||||
`## ${pkg.packageJson.name}@${pkg.packageJson.version}\n\n` +
|
|
||||||
entry.content,
|
|
||||||
};
|
|
||||||
})
|
|
||||||
)
|
|
||||||
)
|
|
||||||
.filter((x) => x)
|
|
||||||
.sort(sortTheThings)
|
|
||||||
.map((x) => x.content)
|
|
||||||
.join("\n ")
|
|
||||||
);
|
|
||||||
})();
|
|
||||||
|
|
||||||
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
|
// Check that the message does not exceed the size limit.
|
||||||
|
// If not, omit the changelog entries of each package.
|
||||||
// project with `commit: true` setting could have already committed files
|
if (fullMessage.length > prBodyMaxCharacters) {
|
||||||
if (!(await gitUtils.checkIfClean())) {
|
fullMessage = [
|
||||||
const finalCommitMessage = `${commitMessage}${
|
messageHeader,
|
||||||
!!preState ? ` (${preState.tag})` : ""
|
messagePrestate,
|
||||||
}`;
|
messageReleasesHeading,
|
||||||
await gitUtils.commitAll(finalCommitMessage);
|
`\n> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.\n`,
|
||||||
|
...changedPackagesInfo.map((info) => `${info.header}\n\n`),
|
||||||
|
].join("\n");
|
||||||
}
|
}
|
||||||
|
|
||||||
await gitUtils.push(versionBranch, { force: true });
|
// Check (again) that the message is within the size limit.
|
||||||
|
// If not, omit all release content this time.
|
||||||
|
if (fullMessage.length > prBodyMaxCharacters) {
|
||||||
|
fullMessage = [
|
||||||
|
messageHeader,
|
||||||
|
messagePrestate,
|
||||||
|
messageReleasesHeading,
|
||||||
|
`\n> All release information have been omitted from this message, as the content exceeds the size limit.`,
|
||||||
|
].join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
let searchResult = await searchResultPromise;
|
return fullMessage;
|
||||||
console.log(JSON.stringify(searchResult.data, null, 2));
|
}
|
||||||
if (searchResult.data.items.length === 0) {
|
|
||||||
console.log("creating pull request");
|
type VersionOptions = {
|
||||||
await octokit.pulls.create({
|
script?: string;
|
||||||
|
githubToken: string;
|
||||||
|
git: Git;
|
||||||
|
octokit: Octokit;
|
||||||
|
cwd?: string;
|
||||||
|
prTitle?: string;
|
||||||
|
commitMessage?: string;
|
||||||
|
hasPublishScript?: boolean;
|
||||||
|
prBodyMaxCharacters?: number;
|
||||||
|
prDraft?: "always" | "create";
|
||||||
|
branch?: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
type RunVersionResult = {
|
||||||
|
pullRequestNumber: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
export async function runVersion({
|
||||||
|
script,
|
||||||
|
githubToken,
|
||||||
|
git,
|
||||||
|
octokit,
|
||||||
|
cwd = process.cwd(),
|
||||||
|
prTitle = "Version Packages",
|
||||||
|
commitMessage = "Version Packages",
|
||||||
|
hasPublishScript = false,
|
||||||
|
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
|
||||||
|
branch = github.context.ref.replace("refs/heads/", ""),
|
||||||
|
prDraft,
|
||||||
|
}: VersionOptions): Promise<RunVersionResult> {
|
||||||
|
let versionBranch = `changeset-release/${branch}`;
|
||||||
|
|
||||||
|
let { preState } = await readChangesetState(cwd);
|
||||||
|
|
||||||
|
await git.prepareBranch(versionBranch);
|
||||||
|
|
||||||
|
let versionsByDirectory = await getVersionsByDirectory(cwd);
|
||||||
|
|
||||||
|
const env = { ...process.env, GITHUB_TOKEN: githubToken };
|
||||||
|
|
||||||
|
if (script) {
|
||||||
|
await exec(script, undefined, { cwd, env });
|
||||||
|
} else {
|
||||||
|
let changesetsCliPkgJson = requireChangesetsCliPkgJson(cwd);
|
||||||
|
let cmd = semverLt(changesetsCliPkgJson.version, "2.0.0")
|
||||||
|
? "bump"
|
||||||
|
: "version";
|
||||||
|
await exec(
|
||||||
|
"node",
|
||||||
|
[
|
||||||
|
require.resolve("@changesets/cli/bin.js", {
|
||||||
|
paths: [cwd],
|
||||||
|
}),
|
||||||
|
cmd,
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd,
|
||||||
|
env,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
|
||||||
|
let changedPackagesInfoPromises = Promise.all(
|
||||||
|
changedPackages.map(async (pkg) => {
|
||||||
|
let changelogContents = await fs.readFile(
|
||||||
|
path.join(pkg.dir, "CHANGELOG.md"),
|
||||||
|
"utf8",
|
||||||
|
);
|
||||||
|
|
||||||
|
let entry = getChangelogEntry(changelogContents, pkg.packageJson.version);
|
||||||
|
return {
|
||||||
|
highestLevel: entry.highestLevel,
|
||||||
|
private: !!pkg.packageJson.private,
|
||||||
|
content: entry.content,
|
||||||
|
header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`,
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
|
||||||
|
const finalCommitMessage = `${commitMessage}${
|
||||||
|
!!preState ? ` (${preState.tag})` : ""
|
||||||
|
}`;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch any existing pull requests that are open against the branch,
|
||||||
|
* before we push any changes that may inadvertently close the existing PRs.
|
||||||
|
*
|
||||||
|
* (`@changesets/ghcommit` has to reset the branch to the same commit as the base,
|
||||||
|
* which GitHub will then react to by closing the PRs)
|
||||||
|
*/
|
||||||
|
const existingPullRequests = await octokit.rest.pulls.list({
|
||||||
|
...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 });
|
||||||
|
|
||||||
|
const changedPackagesInfo = (await changedPackagesInfoPromises)
|
||||||
|
.filter((x) => x)
|
||||||
|
.sort(sortTheThings);
|
||||||
|
|
||||||
|
let prBody = await getVersionPrBody({
|
||||||
|
hasPublishScript,
|
||||||
|
preState,
|
||||||
|
branch,
|
||||||
|
changedPackagesInfo,
|
||||||
|
prBodyMaxCharacters,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (existingPullRequests.data.length === 0) {
|
||||||
|
core.info("creating pull request");
|
||||||
|
const { data: newPullRequest } = await octokit.rest.pulls.create({
|
||||||
base: branch,
|
base: branch,
|
||||||
head: versionBranch,
|
head: versionBranch,
|
||||||
title: finalPrTitle,
|
title: finalPrTitle,
|
||||||
body: await prBodyPromise,
|
body: prBody,
|
||||||
|
draft: prDraft !== undefined,
|
||||||
...github.context.repo,
|
...github.context.repo,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
pullRequestNumber: newPullRequest.number,
|
||||||
|
};
|
||||||
} else {
|
} else {
|
||||||
octokit.pulls.update({
|
const [pullRequest] = existingPullRequests.data;
|
||||||
pull_number: searchResult.data.items[0].number,
|
|
||||||
|
core.info(`updating found pull request #${pullRequest.number}`);
|
||||||
|
const convertPullRequestToDraftMutation =
|
||||||
|
prDraft === "always"
|
||||||
|
? `
|
||||||
|
convertPullRequestToDraft(
|
||||||
|
input: {
|
||||||
|
pullRequestId: $pullRequestId
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
pullRequest {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}`
|
||||||
|
: "";
|
||||||
|
const updatePullRequestMutation = `
|
||||||
|
mutation UpdatePullRequest(
|
||||||
|
$pullRequestId: ID!
|
||||||
|
$title: String!
|
||||||
|
$body: String!
|
||||||
|
) {
|
||||||
|
${convertPullRequestToDraftMutation}
|
||||||
|
|
||||||
|
updatePullRequest(
|
||||||
|
input: {
|
||||||
|
pullRequestId: $pullRequestId
|
||||||
|
title: $title
|
||||||
|
body: $body
|
||||||
|
state: OPEN
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
pullRequest {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
await octokit.graphql(updatePullRequestMutation, {
|
||||||
|
pullRequestId: pullRequest.node_id,
|
||||||
title: finalPrTitle,
|
title: finalPrTitle,
|
||||||
body: await prBodyPromise,
|
body: prBody,
|
||||||
...github.context.repo,
|
|
||||||
});
|
});
|
||||||
console.log("pull request found");
|
|
||||||
|
return {
|
||||||
|
pullRequestNumber: pullRequest.number,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-1
@@ -1,4 +1,5 @@
|
|||||||
import { getChangelogEntry, BumpLevels, sortTheThings } from "./utils";
|
import { expect, test } from "vitest";
|
||||||
|
import { BumpLevels, getChangelogEntry, sortTheThings } from "./utils.ts";
|
||||||
|
|
||||||
let changelog = `# @keystone-alpha/email
|
let changelog = `# @keystone-alpha/email
|
||||||
|
|
||||||
|
|||||||
+59
-73
@@ -1,10 +1,5 @@
|
|||||||
import unified from "unified";
|
import fs from "node:fs/promises";
|
||||||
import remarkParse from "remark-parse";
|
import { getPackages, type Package } from "@manypkg/get-packages";
|
||||||
import remarkStringify from "remark-stringify";
|
|
||||||
// @ts-ignore
|
|
||||||
import mdastToString from "mdast-util-to-string";
|
|
||||||
import { exec } from "@actions/exec";
|
|
||||||
import { getPackages, Package } from "@manypkg/get-packages";
|
|
||||||
|
|
||||||
export const BumpLevels = {
|
export const BumpLevels = {
|
||||||
dep: 0,
|
dep: 0,
|
||||||
@@ -20,7 +15,7 @@ export async function getVersionsByDirectory(cwd: string) {
|
|||||||
|
|
||||||
export async function getChangedPackages(
|
export async function getChangedPackages(
|
||||||
cwd: string,
|
cwd: string,
|
||||||
previousVersions: Map<string, string>
|
previousVersions: Map<string, string>,
|
||||||
) {
|
) {
|
||||||
let { packages } = await getPackages(cwd);
|
let { packages } = await getPackages(cwd);
|
||||||
let changedPackages = new Set<Package>();
|
let changedPackages = new Set<Package>();
|
||||||
@@ -36,86 +31,61 @@ export async function getChangedPackages(
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function getChangelogEntry(changelog: string, version: string) {
|
export function getChangelogEntry(changelog: string, version: string) {
|
||||||
let ast = unified().use(remarkParse).parse(changelog);
|
|
||||||
|
|
||||||
let highestLevel: number = BumpLevels.dep;
|
let highestLevel: number = BumpLevels.dep;
|
||||||
|
let headingStartInfo: { index: number; depth: number } | undefined;
|
||||||
let nodes = ast.children as Array<any>;
|
|
||||||
let headingStartInfo:
|
|
||||||
| {
|
|
||||||
index: number;
|
|
||||||
depth: number;
|
|
||||||
}
|
|
||||||
| undefined;
|
|
||||||
let endIndex: number | undefined;
|
let endIndex: number | undefined;
|
||||||
|
|
||||||
for (let i = 0; i < nodes.length; i++) {
|
// Iterate through each headings and code blocks (for skipping its contents)
|
||||||
let node = nodes[i];
|
const regex = /^(#{1,6})\s(.*)$|^(`{3,})/gm;
|
||||||
if (node.type === "heading") {
|
let match: RegExpExecArray | null;
|
||||||
let stringified: string = mdastToString(node);
|
while ((match = regex.exec(changelog)) != null) {
|
||||||
let match = stringified.toLowerCase().match(/(major|minor|patch)/);
|
// Skip over code blocks so we don't match any headings inside of them
|
||||||
if (match !== null) {
|
if (match[3]) {
|
||||||
let level = BumpLevels[match[0] as "major" | "minor" | "patch"];
|
const endOfCodeBlockRegex = new RegExp(`^${match[3]}`, "gm");
|
||||||
highestLevel = Math.max(level, highestLevel);
|
endOfCodeBlockRegex.lastIndex = regex.lastIndex;
|
||||||
}
|
const endMatch = endOfCodeBlockRegex.exec(changelog);
|
||||||
if (headingStartInfo === undefined && stringified === version) {
|
if (endMatch) {
|
||||||
headingStartInfo = {
|
// Start next search for headings after the end of the code block
|
||||||
index: i,
|
regex.lastIndex = endOfCodeBlockRegex.lastIndex;
|
||||||
depth: node.depth,
|
|
||||||
};
|
|
||||||
continue;
|
continue;
|
||||||
}
|
} else {
|
||||||
if (
|
// Can't find end of code block, probably malformed
|
||||||
endIndex === undefined &&
|
|
||||||
headingStartInfo !== undefined &&
|
|
||||||
headingStartInfo.depth === node.depth
|
|
||||||
) {
|
|
||||||
endIndex = i;
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
if (headingStartInfo) {
|
|
||||||
ast.children = (ast.children as any).slice(
|
|
||||||
headingStartInfo.index + 1,
|
|
||||||
endIndex
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
content: unified().use(remarkStringify).stringify(ast),
|
|
||||||
highestLevel: highestLevel,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function execWithOutput(
|
const headingDepth = match[1].length;
|
||||||
command: string,
|
const headingText = match[2].trim();
|
||||||
args?: string[],
|
|
||||||
options?: { ignoreReturnCode?: boolean; cwd?: string }
|
// Search for the highest bump level in the entire changelog
|
||||||
) {
|
const levelMatch = /(major|minor|patch)/.exec(headingText.toLowerCase());
|
||||||
let myOutput = "";
|
if (levelMatch != null) {
|
||||||
let myError = "";
|
const level = BumpLevels[levelMatch[0] as "major" | "minor" | "patch"];
|
||||||
|
highestLevel = Math.max(level, highestLevel);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Search for heading of the entry
|
||||||
|
if (headingText === version) {
|
||||||
|
headingStartInfo = { index: regex.lastIndex, depth: headingDepth };
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we've found the entry heading, search for the closing heading with the same depth
|
||||||
|
if (headingStartInfo && headingDepth === headingStartInfo.depth) {
|
||||||
|
endIndex = match.index;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
code: await exec(command, args, {
|
content: changelog.slice(headingStartInfo?.index, endIndex).trim(),
|
||||||
listeners: {
|
highestLevel,
|
||||||
stdout: (data: Buffer) => {
|
|
||||||
myOutput += data.toString();
|
|
||||||
},
|
|
||||||
stderr: (data: Buffer) => {
|
|
||||||
myError += data.toString();
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
...options,
|
|
||||||
}),
|
|
||||||
stdout: myOutput,
|
|
||||||
stderr: myError,
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export function sortTheThings(
|
export function sortTheThings(
|
||||||
a: { private: boolean; highestLevel: number },
|
a: { private: boolean; highestLevel: number },
|
||||||
b: { private: boolean; highestLevel: number }
|
b: { private: boolean; highestLevel: number },
|
||||||
) {
|
) {
|
||||||
if (a.private === b.private) {
|
if (a.private === b.private) {
|
||||||
return b.highestLevel - a.highestLevel;
|
return b.highestLevel - a.highestLevel;
|
||||||
@@ -125,3 +95,19 @@ export function sortTheThings(
|
|||||||
}
|
}
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function isErrorWithCode(err: unknown, code: string) {
|
||||||
|
return (
|
||||||
|
typeof err === "object" &&
|
||||||
|
err !== null &&
|
||||||
|
"code" in err &&
|
||||||
|
err.code === code
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function fileExists(filePath: string) {
|
||||||
|
return fs.access(filePath, fs.constants.F_OK).then(
|
||||||
|
() => true,
|
||||||
|
() => false,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
+7
-59
@@ -1,63 +1,11 @@
|
|||||||
{
|
{
|
||||||
|
"extends": "@tsconfig/node24/tsconfig.json",
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
/* Basic Options */
|
"allowImportingTsExtensions": true,
|
||||||
// "incremental": true, /* Enable incremental compilation */
|
"erasableSyntaxOnly": true,
|
||||||
"target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
|
"verbatimModuleSyntax": true,
|
||||||
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
|
"strict": true,
|
||||||
// "lib": [], /* Specify library files to be included in the compilation. */
|
"noEmit": true,
|
||||||
// "allowJs": true, /* Allow javascript files to be compiled. */
|
"types": ["node"]
|
||||||
// "checkJs": true, /* Report errors in .js files. */
|
|
||||||
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
|
|
||||||
// "declaration": true, /* Generates corresponding '.d.ts' file. */
|
|
||||||
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
|
||||||
// "sourceMap": true, /* Generates corresponding '.map' file. */
|
|
||||||
// "outFile": "./", /* Concatenate and emit output to single file. */
|
|
||||||
// "outDir": "./", /* Redirect output structure to the directory. */
|
|
||||||
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
|
||||||
// "composite": true, /* Enable project compilation */
|
|
||||||
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
|
||||||
// "removeComments": true, /* Do not emit comments to output. */
|
|
||||||
"noEmit": true /* Do not emit outputs. */,
|
|
||||||
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
|
||||||
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
|
||||||
"isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,
|
|
||||||
|
|
||||||
/* Strict Type-Checking Options */
|
|
||||||
"strict": true /* Enable all strict type-checking options. */,
|
|
||||||
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
|
||||||
// "strictNullChecks": true, /* Enable strict null checks. */
|
|
||||||
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
|
||||||
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
|
||||||
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
|
||||||
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
|
||||||
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
|
||||||
|
|
||||||
/* Additional Checks */
|
|
||||||
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
|
||||||
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
|
||||||
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
|
||||||
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
|
||||||
|
|
||||||
/* Module Resolution Options */
|
|
||||||
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
|
||||||
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
|
||||||
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
|
||||||
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
|
||||||
// "typeRoots": [], /* List of folders to include type definitions from. */
|
|
||||||
// "types": [], /* Type declaration files to be included in compilation. */
|
|
||||||
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
|
||||||
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
|
||||||
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
|
||||||
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
|
||||||
|
|
||||||
/* Source Map Options */
|
|
||||||
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
|
||||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
||||||
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
|
||||||
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
|
||||||
|
|
||||||
/* Experimental Options */
|
|
||||||
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
|
||||||
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Vendored
-17
@@ -1,17 +0,0 @@
|
|||||||
type Opts = {
|
|
||||||
glob?: string | Array<string>;
|
|
||||||
root?: string;
|
|
||||||
cleanup?: boolean;
|
|
||||||
};
|
|
||||||
|
|
||||||
declare module "fixturez" {
|
|
||||||
export default function (
|
|
||||||
cwd: string,
|
|
||||||
opts?: Opts
|
|
||||||
): {
|
|
||||||
find: (a: string) => string;
|
|
||||||
temp: () => string;
|
|
||||||
copy: (a: string) => string;
|
|
||||||
cleanup: () => any;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user