mirror of
https://github.com/changesets/action
synced 2026-10-26 16:39:56 +08:00
Compare commits
101
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
74169fc1c6 | ||
|
|
d11394aa52 | ||
|
|
5fa67671df | ||
|
|
cae6353519 | ||
|
|
c1722b9aba | ||
|
|
77be81bcb9 | ||
|
|
cb3f0110d7 | ||
|
|
50de20a107 | ||
|
|
64b747d5f5 | ||
|
|
219ea82e52 | ||
|
|
469993ce57 | ||
|
|
8a9495e0ee | ||
|
|
5b307d3df2 | ||
|
|
84d78c68f9 | ||
|
|
c6cc0d84cb | ||
|
|
e3e2663c0e | ||
|
|
e43c867727 | ||
|
|
4b6e1f1099 | ||
|
|
cf45e93c21 | ||
|
|
73591071e6 | ||
|
|
f71ae043ed | ||
|
|
ca57073900 | ||
|
|
0eae789230 | ||
|
|
164652bdd6 | ||
|
|
a35a66bd1e | ||
|
|
823cf741ca | ||
|
|
b12c36a7bf | ||
|
|
5a8b9b721b | ||
|
|
0490518932 | ||
|
|
dc29b738b5 | ||
|
|
ccb38113ea | ||
|
|
cf37561cd9 | ||
|
|
5c88881fff | ||
|
|
dad5baf18b | ||
|
|
5210f6da68 | ||
|
|
a12d90de83 | ||
|
|
5649ff41b8 | ||
|
|
4f718b5921 | ||
|
|
1bf7c2782b | ||
|
|
310b913a84 | ||
|
|
7e238815d9 | ||
|
|
c211f5efab | ||
|
|
70a83f1bd1 | ||
|
|
5273feb188 | ||
|
|
8b7799e7d8 | ||
|
|
b459b1eaa0 | ||
|
|
f9585d966a | ||
|
|
020e8cc600 | ||
|
|
b072bccc4c | ||
|
|
8795eee5ee | ||
|
|
34f64f6e2e | ||
|
|
1d54b9e660 | ||
|
|
031358f743 | ||
|
|
a0c05f7a4b | ||
|
|
a245e45ca5 | ||
|
|
e0c90aa7fb | ||
|
|
d67d8d8799 | ||
|
|
f1222b6286 | ||
|
|
87481d361e | ||
|
|
e33c0e699d | ||
|
|
c13a48983a | ||
|
|
6c80731937 | ||
|
|
03ba888eb8 | ||
|
|
aec1f01000 | ||
|
|
04ba326779 | ||
|
|
ccba80bb5a | ||
|
|
84c24326ac | ||
|
|
f5dbf72f96 | ||
|
|
91b911142e | ||
|
|
d4c53c2943 | ||
|
|
2ae596f3dd | ||
|
|
0784b0ec8f | ||
|
|
81b3f61ebf | ||
|
|
6002dbd987 | ||
|
|
a7c500273b | ||
|
|
935fe876b0 | ||
|
|
6af4a7ec08 | ||
|
|
746b247c1c | ||
|
|
54220dd92c | ||
|
|
5e0dfa5699 | ||
|
|
342005d412 | ||
|
|
04d574e831 | ||
|
|
08db198428 | ||
|
|
1ae3a21f70 | ||
|
|
5078b4b48b | ||
|
|
7ed1955546 | ||
|
|
9690d7b6f2 | ||
|
|
022692ba02 | ||
|
|
0564b8428f | ||
|
|
9f7e23e7ee | ||
|
|
10ea96defe | ||
|
|
f6369c112a | ||
|
|
e82f42c2cc | ||
|
|
cf373e45c9 | ||
|
|
ad037f48d0 | ||
|
|
e9c36b6964 | ||
|
|
c1f57e52f9 | ||
|
|
9d933dcd11 | ||
|
|
b4d99d774e | ||
|
|
42d5417623 | ||
|
|
3c24abeab2 |
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"presets": [
|
||||
["@babel/preset-env", { "targets": { "node": 10 } }],
|
||||
"@babel/preset-typescript"
|
||||
]
|
||||
}
|
||||
@@ -1,13 +1,14 @@
|
||||
{
|
||||
"$schema": "https://unpkg.com/@changesets/config@1.6.2/schema.json",
|
||||
"changelog": [
|
||||
"@changesets/changelog-github",
|
||||
{ "repo": "changesets/action" }
|
||||
],
|
||||
"$schema": "https://unpkg.com/@changesets/config@4.0.0-next.6/schema.json",
|
||||
"changelog": "@changesets/changelog-github",
|
||||
"commit": false,
|
||||
"linked": [],
|
||||
"access": "restricted",
|
||||
"baseBranch": "main",
|
||||
"updateInternalDependencies": "patch",
|
||||
"ignore": []
|
||||
"ignore": [],
|
||||
"privatePackages": {
|
||||
"version": true,
|
||||
"tag": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"mode": "pre",
|
||||
"tag": "next"
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Release commits and tags are now pushed using the GitHub API by default.
|
||||
|
||||
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
|
||||
|
||||
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Allow custom publish scripts to complete without a Changesets output file, warning that GitHub releases and git tags cannot be created when that file is missing.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
|
||||
|
||||
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": minor
|
||||
---
|
||||
|
||||
Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Removed compatibility support for old Changesets v1.
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Rename the root action inputs and outputs to better match the sub-actions' conventions.
|
||||
|
||||
Inputs:
|
||||
|
||||
- `version` -> `version-script`
|
||||
- `publish` -> `publish-script`
|
||||
- `commit` -> `commit-message`
|
||||
- `title` -> `pr-title`
|
||||
- `branch` -> `pr-base-branch`
|
||||
|
||||
Outputs:
|
||||
|
||||
- `pull-request-number` -> `pr-number`
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates when using GitHub API pushes.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fix support for prerelease exits using the new `.changeset/pre` layout.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Update to Changesets v3 packages
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": minor
|
||||
---
|
||||
|
||||
Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
|
||||
|
||||
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": patch
|
||||
---
|
||||
|
||||
Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@changesets/action": major
|
||||
---
|
||||
|
||||
Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
|
||||
@@ -0,0 +1,5 @@
|
||||
/.github/** @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,29 @@
|
||||
name: Setup CI
|
||||
description: Setup CI
|
||||
|
||||
inputs:
|
||||
skip-cache:
|
||||
description: "Whether to skip the cache"
|
||||
required: false
|
||||
default: "false"
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up pnpm
|
||||
uses: pnpm/action-setup@8912a9102ac27614460f54aedde9e1e7f9aec20d # v6.0.5
|
||||
|
||||
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||
with:
|
||||
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,44 @@
|
||||
name: Setup bot auth
|
||||
description: Create a GitHub App token and configure matching git identity
|
||||
|
||||
inputs:
|
||||
client-id:
|
||||
description: GitHub App client ID
|
||||
required: true
|
||||
private-key:
|
||||
description: GitHub App private key
|
||||
required: true
|
||||
permission-contents:
|
||||
description: Contents permission for the GitHub App token
|
||||
required: false
|
||||
default: write
|
||||
permission-pull-requests:
|
||||
description: Pull requests permission for the GitHub App token
|
||||
required: false
|
||||
|
||||
outputs:
|
||||
token:
|
||||
description: GitHub App installation access token
|
||||
value: ${{ steps.app-token.outputs.token }}
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
|
||||
id: app-token
|
||||
with:
|
||||
client-id: ${{ inputs.client-id }}
|
||||
private-key: ${{ inputs.private-key }}
|
||||
permission-contents: ${{ inputs.permission-contents }}
|
||||
permission-pull-requests: ${{ inputs.permission-pull-requests }}
|
||||
|
||||
- name: Setup Git user
|
||||
shell: bash
|
||||
run: |
|
||||
app_user="$APP_SLUG[bot]"
|
||||
app_id="$(gh api "/users/$app_user" --jq .id)"
|
||||
git config user.name "$app_user"
|
||||
git config user.email "$app_id+$app_user@users.noreply.github.com"
|
||||
env:
|
||||
APP_SLUG: ${{ steps.app-token.outputs.app-slug }}
|
||||
GH_TOKEN: ${{ steps.app-token.outputs.token }}
|
||||
+29
-8
@@ -1,11 +1,32 @@
|
||||
# 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
|
||||
- package-ecosystem: "npm"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
interval: "monthly"
|
||||
cooldown:
|
||||
default-days: 7
|
||||
open-pull-requests-limit: 10
|
||||
versioning-strategy: increase
|
||||
groups:
|
||||
production-dependencies:
|
||||
dependency-type: "production"
|
||||
update-types:
|
||||
- minor
|
||||
- patch
|
||||
development-dependencies:
|
||||
dependency-type: "development"
|
||||
update-types:
|
||||
- minor
|
||||
- patch
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "monthly"
|
||||
cooldown:
|
||||
default-days: 7
|
||||
open-pull-requests-limit: 5
|
||||
groups:
|
||||
github-actions:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
+70
-15
@@ -1,24 +1,79 @@
|
||||
name: Node CI
|
||||
name: CI
|
||||
|
||||
on: [pull_request]
|
||||
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
|
||||
- next
|
||||
# merge group rulesets don't allow wildcards so in settings each maintenance branch needs to be added separately
|
||||
- "maintenance/v*" # branch rulesets don't support v[0-9]+
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.sha }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build:
|
||||
timeout-minutes: 20
|
||||
|
||||
lint-workflows:
|
||||
name: Lint workflows
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
actions: read # only required in private repos
|
||||
security-events: write # allow writing security events
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js 20
|
||||
uses: actions/setup-node@v4
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
node-version: 20.x
|
||||
persist-credentials: false
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn --frozen-lockfile
|
||||
- name: Run zizmor
|
||||
uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2
|
||||
with:
|
||||
persona: pedantic
|
||||
annotations: true
|
||||
advanced-security: false
|
||||
|
||||
test:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
|
||||
- name: Test
|
||||
run: yarn test
|
||||
run: pnpm test
|
||||
|
||||
typecheck:
|
||||
name: Typecheck
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
|
||||
- name: Typecheck
|
||||
run: pnpm typecheck
|
||||
|
||||
lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
steps:
|
||||
- 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,98 @@
|
||||
name: Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- next
|
||||
- "maintenance/v*" # branch rulesets don't support v[0-9]+
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: false
|
||||
queue: max
|
||||
|
||||
permissions: {} # each job should define its own permission explicitly
|
||||
|
||||
jobs:
|
||||
select-mode:
|
||||
name: Select mode
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
outputs:
|
||||
mode: ${{ steps.select-mode.outputs.mode }}
|
||||
permissions:
|
||||
contents: read # to check out repo (actions/checkout)
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
with:
|
||||
skip-cache: true # avoid cache poisoning attacks
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- name: Select mode
|
||||
id: select-mode
|
||||
uses: ./select-mode
|
||||
|
||||
version:
|
||||
name: Version
|
||||
if: needs.select-mode.outputs.mode == 'version'
|
||||
needs: select-mode
|
||||
runs-on: ubuntu-latest
|
||||
environment: version
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
contents: read # to check out repo (actions/checkout)
|
||||
steps:
|
||||
- uses: $/.github/actions/ci-setup
|
||||
with:
|
||||
skip-cache: true # avoid cache poisoning attacks
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- uses: $/.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||
permission-contents: write # to create version commits (changesets/action)
|
||||
permission-pull-requests: write # to create pull request (changesets/action)
|
||||
|
||||
- name: Create or update release pull request
|
||||
id: changesets
|
||||
uses: ./version
|
||||
with:
|
||||
github-token: ${{ steps.bot-auth.outputs.token }}
|
||||
script: pnpm bump
|
||||
|
||||
publish:
|
||||
name: Publish
|
||||
if: needs.select-mode.outputs.mode == 'publish'
|
||||
needs: select-mode
|
||||
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: $/.github/actions/ci-setup
|
||||
with:
|
||||
skip-cache: true # avoid cache poisoning attacks
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- uses: $/.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||
permission-contents: write # to bypass branch and tag protection rules (release.ts)
|
||||
|
||||
- name: Publish to marketplace
|
||||
uses: ./publish
|
||||
with:
|
||||
github-token: ${{ steps.bot-auth.outputs.token }}
|
||||
script: pnpm release
|
||||
@@ -0,0 +1,241 @@
|
||||
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:
|
||||
- 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
|
||||
|
||||
- uses: $/.github/actions/setup-bot-auth
|
||||
id: bot-auth
|
||||
with:
|
||||
client-id: ${{ vars.APP_CLIENT_ID }}
|
||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||
permission-contents: write # to push the release snapshot branch (release-pr.ts)
|
||||
|
||||
- name: Release snapshot version
|
||||
run: pnpm release:pr
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ steps.bot-auth.outputs.token }}
|
||||
|
||||
- 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 }}
|
||||
@@ -1,35 +0,0 @@
|
||||
name: Version or Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
jobs:
|
||||
changesets:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js 20
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20.x
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: yarn build
|
||||
|
||||
- name: Create Release Pull Request or Publish
|
||||
id: changesets
|
||||
uses: ./
|
||||
with:
|
||||
version: yarn bump
|
||||
publish: yarn release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -2,5 +2,6 @@ node_modules
|
||||
.parcel-cache
|
||||
.cache
|
||||
*.log
|
||||
.env
|
||||
|
||||
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"
|
||||
}
|
||||
+165
@@ -1,5 +1,170 @@
|
||||
# @changesets/action
|
||||
|
||||
## 2.0.0-next.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#711](https://github.com/changesets/action/pull/711) [`5fa6767`](https://github.com/changesets/action/commit/5fa67671df41b7a8a9d8123e8e446b1a8ad423db) Thanks [@Andarist](https://github.com/Andarist)! - Fix support for prerelease exits using the new `.changeset/pre` layout.
|
||||
|
||||
## 2.0.0-next.4
|
||||
|
||||
### Major Changes
|
||||
|
||||
- [#692](https://github.com/changesets/action/pull/692) [`cb3f011`](https://github.com/changesets/action/commit/cb3f0110d7423cd340b1c5d63584c0ea6ee63959) Thanks [@Andarist](https://github.com/Andarist)! - Release commits and tags are now pushed using the GitHub API by default.
|
||||
|
||||
Replace the `commit-mode` input with the boolean `push-with-git-cli` input. Set `push-with-git-cli: true` to continue using the Git CLI.
|
||||
|
||||
Regardless of the push mode, custom GitHub tokens must be passed explicitly through the `github-token` input. The `GITHUB_TOKEN` environment variable and credentials configured by `actions/checkout` or embedded in remote URLs are not substitutes for this input. When the Git CLI is enabled, `github-token` takes precedence over those repository credentials.
|
||||
|
||||
- [#695](https://github.com/changesets/action/pull/695) [`469993c`](https://github.com/changesets/action/commit/469993ce5783c6a38e72541d4ba0d25588702b9a) Thanks [@bluwy](https://github.com/bluwy)! - Removed `.npmrc` handling when the `NPM_TOKEN` environment variable is set.
|
||||
|
||||
Authentication should be handled via Trusted Publishing instead. If a token is still needed, use `actions/setup-node` to set it up instead via the `registry-url` option. Check out the updated action README for more information of setting up npm authentication in GitHub Actions.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#699](https://github.com/changesets/action/pull/699) [`5b307d3`](https://github.com/changesets/action/commit/5b307d3df25daf51c41dff70d2f66df1579ae9fa) Thanks [@Andarist](https://github.com/Andarist)! - Validate that projects use Changesets CLI v3 and direct Changesets CLI v2 users to `changesets/action@v1`.
|
||||
|
||||
- [#697](https://github.com/changesets/action/pull/697) [`84d78c6`](https://github.com/changesets/action/commit/84d78c68f98f20e24dfff22b22193e7b4f326ad9) Thanks [@Andarist](https://github.com/Andarist)! - Allow custom publish scripts to complete without a Changesets output file, warning that GitHub releases and git tags cannot be created when that file is missing.
|
||||
|
||||
- [#705](https://github.com/changesets/action/pull/705) [`77be81b`](https://github.com/changesets/action/commit/77be81bcb9d2d1007c53c4f98bffe51da428d6a5) Thanks [@Andarist](https://github.com/Andarist)! - Fixed a regression making it impossible to sync new versions of versioning pull requests with base branch updates when using GitHub API pushes.
|
||||
|
||||
- [#688](https://github.com/changesets/action/pull/688) [`219ea82`](https://github.com/changesets/action/commit/219ea82e52caaff2a10a5e34d3455093cf958238) Thanks [@Andarist](https://github.com/Andarist)! - Remove the `setup-git-user` input. Complete custom Git identities are now preserved automatically, while `github-actions[bot]` is configured as a fallback before creating local release commits or tags.
|
||||
|
||||
## 2.0.0-next.3
|
||||
|
||||
### Major Changes
|
||||
|
||||
- [#680](https://github.com/changesets/action/pull/680) [`ca57073`](https://github.com/changesets/action/commit/ca57073900dc678254406a052a03c0c8824e319d) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `push-git-tags` option that complements `create-github-releases` to control specifically if git tags should be created but not GitHub releases.
|
||||
|
||||
If `create-github-releases` was previously set to `false`, which also indirectly disabled git tag creation, git tags will now be created instead by default. If this is not desired, set `push-git-tags` to `false` explicitly.
|
||||
|
||||
- [#681](https://github.com/changesets/action/pull/681) [`7359107`](https://github.com/changesets/action/commit/73591071e61c7f61cf322dd7a6341dc29a8e1d4e) Thanks [@bluwy](https://github.com/bluwy)! - Rename the root action inputs and outputs to better match the sub-actions' conventions.
|
||||
|
||||
Inputs:
|
||||
- `version` -> `version-script`
|
||||
- `publish` -> `publish-script`
|
||||
- `commit` -> `commit-message`
|
||||
- `title` -> `pr-title`
|
||||
- `branch` -> `pr-base-branch`
|
||||
|
||||
Outputs:
|
||||
- `pull-request-number` -> `pr-number`
|
||||
|
||||
- [#674](https://github.com/changesets/action/pull/674) [`164652b`](https://github.com/changesets/action/commit/164652bdd60525670d95291addb8c6f92833ac60) Thanks [@bluwy](https://github.com/bluwy)! - Remove support for passing custom GitHub token through the GITHUB_TOKEN environment variable. It should be passed to the `github-token` input instead.
|
||||
|
||||
- [#673](https://github.com/changesets/action/pull/673) [`823cf74`](https://github.com/changesets/action/commit/823cf741ca57c5e22652123d3a847dfafcd77ca0) Thanks [@bluwy](https://github.com/bluwy)! - Update to Changesets v3 packages
|
||||
|
||||
- [#668](https://github.com/changesets/action/pull/668) [`0eae789`](https://github.com/changesets/action/commit/0eae789230defbc4ad287e9b476aba7e842e34e0) Thanks [@bluwy](https://github.com/bluwy)! - Rename the input and output names to kebab-case instead of camelCase to match the official GitHub actions pattern
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- [#678](https://github.com/changesets/action/pull/678) [`f71ae04`](https://github.com/changesets/action/commit/f71ae043ed5deb17952900091e009a60edef9507) Thanks [@Andarist](https://github.com/Andarist)! - Published packages detection done through stdout parsing was replaced with one based on the shared output file using `CHANGESETS_OUTPUT` environment variable. When using custom scripts this environment variable should always be passed down to the Changesets CLI invocations.
|
||||
|
||||
## 2.0.0-next.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Authenticate git CLI pushes with the configured GitHub token using Git extra headers instead of writing to a global `.netrc` file.
|
||||
|
||||
- [#670](https://github.com/changesets/action/pull/670) [`5a8b9b7`](https://github.com/changesets/action/commit/5a8b9b721bf683e3bf9bd72ea92a685dc024147b) Thanks [@Andarist](https://github.com/Andarist)! - Derive the Git server URL from the GitHub Actions context when configuring git CLI authentication to support GitHub Enterprise Server setups.
|
||||
|
||||
## 2.0.0-next.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#663](https://github.com/changesets/action/pull/663) [`ccb3811`](https://github.com/changesets/action/commit/ccb38113eaaa4a13eb6aabe09520e49cc8519b84) Thanks [@Andarist](https://github.com/Andarist)! - Fix the computed publish plan path passed internally to `changeset pack` by the `/pack` subaction.
|
||||
|
||||
- [#662](https://github.com/changesets/action/pull/662) [`5c88881`](https://github.com/changesets/action/commit/5c88881fff1f0d8b055d4a2d3a74a8ce843db6f3) Thanks [@Andarist](https://github.com/Andarist)! - Fixed usage of `--from-publish-plan` flag used by the `/pack` subaction
|
||||
|
||||
- [#666](https://github.com/changesets/action/pull/666) [`dc29b73`](https://github.com/changesets/action/commit/dc29b738b532d9e95f46b9bf493e2e3fdf48a7ed) Thanks [@Andarist](https://github.com/Andarist)! - Fix the `/version` subaction to not crash on missing `pr-base-branch` input. This input is meant to be optional.
|
||||
|
||||
## 2.0.0-next.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- [#657](https://github.com/changesets/action/pull/657) [`4f718b5`](https://github.com/changesets/action/commit/4f718b5921490b1efeb015a81abb6a4633892851) Thanks [@Andarist](https://github.com/Andarist)! - Removed compatibility support for old Changesets v1.
|
||||
|
||||
- [#659](https://github.com/changesets/action/pull/659) [`5649ff4`](https://github.com/changesets/action/commit/5649ff41b8eb1b7a281011e45df781c6d4628fd0) Thanks [@bluwy](https://github.com/bluwy)! - Remove `cwd` option for `changesets/action`. Use the step `working-directory` option instead to change the directory.
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- [#656](https://github.com/changesets/action/pull/656) [`a12d90d`](https://github.com/changesets/action/commit/a12d90de8394e63c952622b2fd3f98c8729c48b0) Thanks [@bluwy](https://github.com/bluwy)! - Add new `/select-mode`, `/version`, and `/publish` sub-actions to better control version and publish steps
|
||||
|
||||
## 1.9.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- [#636](https://github.com/changesets/action/pull/636) [`b072bcc`](https://github.com/changesets/action/commit/b072bccc4c664a373c42168eed9139dce1e003b1) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-comment` sub-action to comment on PRs
|
||||
|
||||
- [#625](https://github.com/changesets/action/pull/625) [`8795eee`](https://github.com/changesets/action/commit/8795eee5eee884e887d352ac673a515ffe35aaa6) Thanks [@bluwy](https://github.com/bluwy)! - Add a new `@changesets/action/pr-status` sub-action to generate the changeset status comment for PRs as an alternative to the [Changesets Bot](https://github.com/apps/changeset-bot).
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- [#535](https://github.com/changesets/action/pull/535) [`34f64f6`](https://github.com/changesets/action/commit/34f64f6e2e1e47ddc183f174aa27c197aa47f520) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with GitHub releases not being created for successfully published packages when _some_ packages failed to be published to the registry.
|
||||
|
||||
- [#632](https://github.com/changesets/action/pull/632) [`1d54b9e`](https://github.com/changesets/action/commit/1d54b9e660e435237accbcae0b4581af3be641b4) Thanks [@bluwy](https://github.com/bluwy)! - Simplify internal implementation to get changelog entries for a package version
|
||||
|
||||
- [#629](https://github.com/changesets/action/pull/629) [`e0c90aa`](https://github.com/changesets/action/commit/e0c90aa7fbd0cc26931a679c5abe9bbc0deb0b50) Thanks [@bluwy](https://github.com/bluwy)! - Fix custom version and publish command argument parsing
|
||||
|
||||
- [#645](https://github.com/changesets/action/pull/645) [`f9585d9`](https://github.com/changesets/action/commit/f9585d966a9c7d2f668b97199990de6f885823cf) Thanks [@Andarist](https://github.com/Andarist)! - Improved force-push handling when using `commitMode: "github-api"` so updating an existing branch no longer temporarily resets the target branch to the base commit, avoiding cases where GitHub closes open pull requests during the update. This should remove a possibility of a GitHub state race that caused the force-pushed PRs not being reopened.
|
||||
|
||||
## 1.8.0
|
||||
|
||||
### 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
|
||||
|
||||
@@ -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,218 +1,76 @@
|
||||
# Changesets Release Action
|
||||
# Changesets GitHub Action
|
||||
|
||||
This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
|
||||
> [!IMPORTANT]
|
||||
> This is the development branch for `changesets/action` v2 compatible with Changesets v3. For the v1 code compatible with Changesets v2, check out the [`maintenance/v1`](https://github.com/changesets/action/tree/maintenance/v1) branch.
|
||||
|
||||
## Usage
|
||||
This repo contains a collection of GitHub Actions for [Changesets](https://changesets.dev). Check out the [Automating Changesets](https://changesets.dev/guide/automating) guide to learn how to use these actions to automate your workflow.
|
||||
|
||||
### Inputs
|
||||
- [changesets/action](./README.md): (This README. See below for details.)
|
||||
- [changesets/action/select-mode](./select-mode/README.md): Select the mode to run a Changesets workflow.
|
||||
- [changesets/action/version](./version/README.md): Version packages and create or update a pull request with the changes.
|
||||
- [changesets/action/pack](./pack/README.md): Pack publishable packages into tarballs.
|
||||
- [changesets/action/publish](./publish/README.md): Publish packages to npm.
|
||||
- [changesets/action/pr-status](./pr-status/README.md): Generate changeset status in PRs.
|
||||
- [changesets/action/pr-comment](./pr-comment/README.md): Create or update comments on PRs.
|
||||
|
||||
- publish - The command to use to build and publish packages
|
||||
- version - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
|
||||
- commit - The commit message to use. Default to `Version Packages`
|
||||
- title - The pull request title. Default to `Version Packages`
|
||||
- setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
|
||||
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
|
||||
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
|
||||
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
|
||||
## changesets/action
|
||||
|
||||
### Outputs
|
||||
This action handles versioning and publishing of packages. It's the equivalent of setting up the `changesets/action/select-mode`, `changesets/action/version`, and `changesets/action/publish` actions in a workflow, but with the required permissions combined.
|
||||
|
||||
- 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"}]`
|
||||
If using [trusted publishing](https://docs.npmjs.com/trusted-publishers), it's recommended to set up the individual sub-actions instead to tighten publish permissions.
|
||||
|
||||
### Example workflow:
|
||||
### Requirements
|
||||
|
||||
#### Without Publishing
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]:
|
||||
- `contents: write`: to commit version changes
|
||||
- `pull-requests: write`: to create pull request
|
||||
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
Create a file at `.github/workflows/release.yml` with the following content.
|
||||
> [!NOTE]
|
||||
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
### Usage
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
> [!IMPORTANT]
|
||||
> To use a custom GitHub token, pass it explicitly through the `github-token` input:
|
||||
>
|
||||
> ```yaml
|
||||
> with:
|
||||
> github-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
|
||||
> ```
|
||||
>
|
||||
> Setting the `GITHUB_TOKEN` environment variable does not configure the action. This applies whether release changes are pushed using the GitHub API or the Git CLI.
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v3
|
||||
### API
|
||||
|
||||
- name: Setup Node.js 20
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 20
|
||||
<!-- api-start -->
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
| Inputs | Description |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `publish-script` | The command to use to build and publish packages |
|
||||
| `version-script` | The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided |
|
||||
| `commit-message` | The commit message. Default to `Version Packages` |
|
||||
| `pr-title` | The pull request title. Default to `Version Packages` |
|
||||
| `pr-draft` | Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them. |
|
||||
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
|
||||
| `create-github-releases` | Whether to create Github releases after publish |
|
||||
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
|
||||
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits and tags. Defaults to `false`. When using the GitHub API, commits and tags are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
|
||||
|
||||
- name: Create Release Pull Request
|
||||
uses: changesets/action@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
| Outputs | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `published` | A "true" or "false" string value to indicate whether a publishing is happened or not |
|
||||
| `published-packages` | A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` |
|
||||
| `has-changesets` | A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality. |
|
||||
| `pr-number` | The pull request number that was created or updated |
|
||||
|
||||
#### With Publishing
|
||||
<!-- api-end -->
|
||||
|
||||
Before you can setup this action with publishing, you'll need to have an [npm token](https://docs.npmjs.com/creating-and-viewing-authentication-tokens) that can publish the packages in the repo you're setting up the action for and doesn't have 2FA on publish enabled ([2FA on auth can be enabled](https://docs.npmjs.com/about-two-factor-authentication)). You'll also need to [add it as a secret on your GitHub repo](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) with the name `NPM_TOKEN`. Once you've done that, you can create a file at `.github/workflows/release.yml` with the following content.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node.js 20.x
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 20.x
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Create Release Pull Request or Publish to npm
|
||||
id: changesets
|
||||
uses: changesets/action@v1
|
||||
with:
|
||||
# This expects you to have a script called release which does a build for your packages and calls changeset publish
|
||||
publish: yarn release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
- name: Send a Slack notification if a publish happens
|
||||
if: steps.changesets.outputs.published == 'true'
|
||||
# You can do something when a publish happens.
|
||||
run: my-slack-bot send-notification --message "A new version of ${GITHUB_REPOSITORY} was published!"
|
||||
```
|
||||
|
||||
By default the GitHub Action creates a `.npmrc` file with the following content:
|
||||
|
||||
```
|
||||
//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}
|
||||
```
|
||||
|
||||
However, if a `.npmrc` file is found, the GitHub Action does not recreate the file. This is useful if you need to configure the `.npmrc` file on your own.
|
||||
For example, you can add a step before running the Changesets GitHub Action:
|
||||
|
||||
```yml
|
||||
- name: Creating .npmrc
|
||||
run: |
|
||||
cat << EOF > "$HOME/.npmrc"
|
||||
//registry.npmjs.org/:_authToken=$NPM_TOKEN
|
||||
EOF
|
||||
env:
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
```
|
||||
|
||||
#### Custom Publishing
|
||||
|
||||
If you want to hook into when publishing should occur but have your own publishing functionality, you can utilize the `hasChangesets` output.
|
||||
|
||||
Note that you might need to account for things already being published in your script because a commit without any new changesets can always land on your base branch after a successful publish. In such a case you need to figure out on your own how to skip over the actual publishing logic or handle errors gracefully as most package registries won't allow you to publish over already published version.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node.js 20.x
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 20.x
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Create Release Pull Request or Publish to npm
|
||||
id: changesets
|
||||
uses: changesets/action@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Publish
|
||||
if: steps.changesets.outputs.hasChangesets == 'false'
|
||||
# You can do something when a publish should happen.
|
||||
run: yarn publish
|
||||
```
|
||||
|
||||
#### With version script
|
||||
|
||||
If you need to add additional logic to the version command, you can do so by using a version script.
|
||||
|
||||
If the version script is present, this action will run that script instead of `changeset version`, so please make sure that your script calls `changeset version` at some point. All the changes made by the script will be included in the PR.
|
||||
|
||||
```yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node.js 20.x
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 20.x
|
||||
|
||||
- name: Install Dependencies
|
||||
run: yarn
|
||||
|
||||
- name: Create Release Pull Request
|
||||
uses: changesets/action@v1
|
||||
with:
|
||||
# this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
|
||||
version: yarn version
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
|
||||
#### With Yarn 2 / Plug'n'Play
|
||||
|
||||
If you are using [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp), you should use a custom `version` command so that the action can resolve the `changeset` CLI:
|
||||
|
||||
```yaml
|
||||
- uses: changesets/action@v1
|
||||
with:
|
||||
version: yarn changeset version
|
||||
...
|
||||
```
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
+37
-29
@@ -1,53 +1,61 @@
|
||||
name: Changesets
|
||||
description: A GitHub action to automate releases with Changesets
|
||||
runs:
|
||||
using: "node20"
|
||||
using: "node24"
|
||||
main: "dist/index.js"
|
||||
inputs:
|
||||
publish:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
publish-script:
|
||||
description: "The command to use to build and publish packages"
|
||||
required: false
|
||||
version:
|
||||
version-script:
|
||||
description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
|
||||
required: false
|
||||
cwd:
|
||||
description: Sets the cwd for the node process. Default to `process.cwd()`
|
||||
commit-message:
|
||||
description: "The commit message. Default to `Version Packages`"
|
||||
required: false
|
||||
commit:
|
||||
description: |
|
||||
The commit message. Default to `Version Packages`
|
||||
default: "Version Packages"
|
||||
pr-title:
|
||||
description: "The pull request title. Default to `Version Packages`"
|
||||
required: false
|
||||
title:
|
||||
description: The pull request title. Default to `Version Packages`
|
||||
default: "Version Packages"
|
||||
pr-draft:
|
||||
description: "Controls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them."
|
||||
required: false
|
||||
setupGitUser:
|
||||
description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
|
||||
pr-base-branch:
|
||||
description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
|
||||
required: false
|
||||
create-github-releases:
|
||||
description: "Whether to create Github releases after publish"
|
||||
required: false
|
||||
default: true
|
||||
createGithubReleases:
|
||||
description: "A boolean value to indicate whether to create Github releases after `publish` or not"
|
||||
required: false
|
||||
default: true
|
||||
commitMode:
|
||||
push-git-tags:
|
||||
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.
|
||||
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
|
||||
this option will also always be `true`.
|
||||
required: false
|
||||
default: "git-cli"
|
||||
branch:
|
||||
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
|
||||
default: true
|
||||
push-with-git-cli:
|
||||
description: >
|
||||
Whether to use the Git CLI instead of the GitHub API to push release commits and tags.
|
||||
Defaults to `false`. When using the GitHub API, commits and tags are signed using
|
||||
GitHub's GPG key and attributed to the user or app that owns the `github-token`.
|
||||
required: false
|
||||
default: false
|
||||
outputs:
|
||||
published:
|
||||
description: A boolean value to indicate whether a publishing is happened or not
|
||||
publishedPackages:
|
||||
description: A "true" or "false" string value to indicate whether a publishing is happened or not
|
||||
published-packages:
|
||||
description: >
|
||||
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
||||
hasChangesets:
|
||||
description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
|
||||
pullRequestNumber:
|
||||
has-changesets:
|
||||
description: A "true" or "false" string value about whether there were changesets. Useful if you want to create your own publishing functionality.
|
||||
pr-number:
|
||||
description: The pull request number that was created or updated
|
||||
branding:
|
||||
icon: "package"
|
||||
|
||||
Vendored
+12
File diff suppressed because one or more lines are too long
Vendored
+1
-67
File diff suppressed because one or more lines are too long
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{A as e,j as t,m as n,n as r,o as i,t as a,y as o}from"./utils-C998F5Ty.js";import s from"node:fs/promises";import c from"node:path";import l from"node:os";try{await u()}catch(t){e(t.message)}async function u(){let e=process.cwd();await n(e);let r=i(`publish-plan-artifact-id`),a=process.env.RUNNER_TEMP??await s.realpath(l.tmpdir()),u=c.join(a,`changeset-pack-${Date.now()}`);await d(e,{outDir:u,publishPlanPath:r?await f(a,Number(r)):void 0});let m=await o.uploadArtifact(`changeset-pack-${Date.now()}`,await p(u),u,{retentionDays:30});if(m.id===void 0)throw Error(`Packed artifact upload did not return an artifact id`);t(`pack-dir-artifact-id`,String(m.id))}async function d(e,t){let n=[`pack`,`--out-dir`,t.outDir];t.publishPlanPath&&n.push(`--from-publish-plan`,t.publishPlanPath),await r(n,{cwd:e,env:process.env})}async function f(e,t){let n=await a(e,t,`changeset-publish-plan`);return c.join(n,`publish-plan.json`)}async function p(e){let t=await s.readdir(e,{withFileTypes:!0});return(await Promise.all(t.map(async t=>{let n=c.join(e,t.name);return t.isDirectory()?p(n):[n]}))).flat()}export{};
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{A as e,T as t,j as n,k as r,o as i,s as a,w as o}from"./utils-C998F5Ty.js";try{await s()}catch(t){e(t.message)}async function s(){let e=o.payload.pull_request;if(!e)throw Error("This action should only be run on `pull_request_target` or `pull_request` events");let s=a(`github-token`),l=a(`body`),u=i(`update-id`),d=u?c(u):null,f=d?`${d}\n\n${l}`:l,p={repo:e.base.repo.name,owner:e.base.repo.owner.login,issue_number:e.number,body:f},m=t(s),h;d&&(r(`Checking for existing comment...`),h=await m.rest.issues.listComments({repo:e.base.repo.name,owner:e.base.repo.owner.login,issue_number:e.number}).then(e=>e.data.find(e=>e.body?.includes(d))?.id)),h?(r(`Updating existing comment (id: ${h})...`),await m.rest.issues.updateComment({...p,comment_id:h}),n(`comment-id`,h)):(r(`Creating new comment...`),n(`comment-id`,(await m.rest.issues.createComment(p)).data.id)),r(`Done!`)}function c(e){let t=`changesets-action-pr-comment`;return t===e?`<!-- ${t} -->`:`<!-- ${t}:${e} -->`}export{};
|
||||
Vendored
+38
File diff suppressed because one or more lines are too long
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{A as e,D as t,j as n,m as r,o as i,s as a,t as o}from"./utils-C998F5Ty.js";import{r as s,t as c}from"./run-CrnFHRGT.js";import l from"node:fs/promises";import u from"node:os";try{await d()}catch(t){e(t.message)}async function d(){let e=process.cwd();await r(e);let d=a(`github-token`),f=i(`script`),p=i(`pack-dir-artifact-id`),m=t(`create-github-releases`),h=t(`push-git-tags`);if(m&&!h)throw Error(`The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true or set 'create-github-releases' to false.`);let g=await c({script:f,github:new s({cwd:e,githubToken:d}),createGithubReleases:m,pushGitTags:h,cwd:e,fromPackDir:p?await o(process.env.RUNNER_TEMP??await l.realpath(u.tmpdir()),Number(p),`changeset-pack`):void 0});if(g.published?(n(`published`,`true`),n(`published-packages`,JSON.stringify(g.publishedPackages))):n(`published`,`false`),g.exitCode!==0)throw Error(`Publish command exited with code ${g.exitCode}${g.published?`, but some packages were published: ${g.publishedPackages.map(e=>`${e.name}@${e.version}`).join(`, `)}`:``}`)}export{};
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{i as e,t}from"./dist-DlzQ-3f_.js";async function n(n=process.cwd()){let r=await e(n),i=await t(n);return r!==void 0&&r.mode===`pre`?{preState:r,changesets:i.filter(e=>!e.id.startsWith(`pre/`))}:{preState:void 0,changesets:i}}export{n as t};
|
||||
Vendored
+98
File diff suppressed because one or more lines are too long
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{A as e,j as t,m as n,n as r,y as i}from"./utils-C998F5Ty.js";import{t as a}from"./readChangesetState-DSLewpir.js";import o from"node:fs/promises";import s from"node:path";import c from"node:os";try{await l()}catch(t){e(t.message)}async function l(){let e=process.cwd();await n(e);let r=await u(e);if(t(`mode`,r.mode),r.mode===`publish`){let e=await i.uploadArtifact(s.basename(r.publishPlanPath,`.json`),[r.publishPlanPath],s.dirname(r.publishPlanPath),{skipArchive:!0,retentionDays:30});if(e.id===void 0)throw Error(`Publish plan artifact upload did not return an artifact id`);t(`publish-plan-artifact-id`,String(e.id))}}async function u(e){let{changesets:t}=await a(e);if(t.length>0)return t.some(e=>e.releases.length>0)?{mode:`version`}:{mode:`none`};let n=s.join(process.env.RUNNER_TEMP??await o.realpath(c.tmpdir()),`changeset-publish-plan-${Date.now()}`,`publish-plan.json`);return await r([`publish-plan`,`--output`,n],{cwd:e,env:process.env}),(await d(n)).length===0?{mode:`none`}:{mode:`publish`,publishPlanPath:n}}async function d(e){let t;try{t=await o.readFile(e,`utf8`)}catch(t){throw Error(`Failed to read publish plan at ${e}`,{cause:t})}let n;try{n=JSON.parse(t)}catch(t){throw Error(`Failed to parse publish plan at ${e}`,{cause:t})}if(typeof n!=`object`||!n||!(`version`in n)||typeof n.version!=`number`||!(`plan`in n)||!Array.isArray(n.plan))throw Error(`Invalid publish plan at ${e}: expected { version: number; plan: unknown[] }`);return n.plan}export{};
|
||||
Vendored
+224
File diff suppressed because one or more lines are too long
Vendored
+1
@@ -0,0 +1 @@
|
||||
import{A as e,D as t,f as n,j as r,m as i,o as a,s as o}from"./utils-C998F5Ty.js";import{n as s,r as c}from"./run-CrnFHRGT.js";try{await l()}catch(t){e(t.message)}async function l(){let e=process.cwd();await i(e),n();let l=o(`github-token`),u=a(`script`),d=o(`commit-message`),f=o(`pr-title`),p=a(`pr-draft`),m=a(`pr-base-branch`),h=t(`push-with-git-cli`);if(p!==void 0&&p!==`always`&&p!==`create`)throw Error(`Invalid pr-draft input: ${p}`);let{pullRequestNumber:g}=await s({script:u,github:new c({cwd:e,githubToken:l,pushWithGitCli:h}),cwd:e,prTitle:f,commitMessage:d,hasPublishScript:!0,prDraft:p,branch:m});r(`pr-number`,String(g))}export{};
|
||||
@@ -0,0 +1,31 @@
|
||||
# changesets/action/pack
|
||||
|
||||
This action packs publishable packages into tarballs, complements [changesets/action/publish](../publish/README.md) to publish them in a later step.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| -------------------------- | --------------------------------------------------------------------- |
|
||||
| `publish-plan-artifact-id` | Artifact id for a publish plan generated by the select-mode subaction |
|
||||
|
||||
| Outputs | Description |
|
||||
| ---------------------- | ------------------------------------------- |
|
||||
| `pack-dir-artifact-id` | Artifact id for the packed output directory |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
@@ -0,0 +1,15 @@
|
||||
name: Changesets - Pack
|
||||
description: Pack publishable packages into tarballs
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/pack.js
|
||||
inputs:
|
||||
publish-plan-artifact-id:
|
||||
description: "Artifact id for a publish plan generated by the select-mode subaction"
|
||||
required: false
|
||||
outputs:
|
||||
pack-dir-artifact-id:
|
||||
description: "Artifact id for the packed output directory"
|
||||
branding:
|
||||
icon: package
|
||||
color: blue
|
||||
+47
-52
@@ -1,63 +1,58 @@
|
||||
{
|
||||
"name": "@changesets/action",
|
||||
"version": "1.5.1",
|
||||
"main": "dist/index.js",
|
||||
"version": "2.0.0-next.5",
|
||||
"private": true,
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.13.10",
|
||||
"@babel/preset-env": "^7.13.10",
|
||||
"@babel/preset-typescript": "^7.13.0",
|
||||
"@changesets/changelog-github": "^0.4.2",
|
||||
"@changesets/cli": "^2.20.0",
|
||||
"@changesets/write": "^0.1.6",
|
||||
"@types/fs-extra": "^8.0.0",
|
||||
"@types/jest": "^29.5.1",
|
||||
"@types/node": "^20.11.17",
|
||||
"@types/semver": "^7.5.0",
|
||||
"@vercel/ncc": "^0.36.1",
|
||||
"babel-jest": "^29.5.0",
|
||||
"fixturez": "^1.1.0",
|
||||
"husky": "^3.0.3",
|
||||
"jest": "^29.5.0",
|
||||
"prettier": "^2.0.5",
|
||||
"typescript": "^5.0.4"
|
||||
},
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"build": "ncc build src/index.ts -o dist --transpile-only --minify",
|
||||
"test": "jest",
|
||||
"test:watch": "yarn test --watch",
|
||||
"build": "rolldown -c",
|
||||
"test": "vitest",
|
||||
"test:watch": "pnpm test --watch",
|
||||
"typecheck": "tsc",
|
||||
"format": "oxfmt --check",
|
||||
"format:fix": "oxfmt",
|
||||
"changeset": "changeset",
|
||||
"bump": "node ./scripts/bump.js",
|
||||
"release": "node ./scripts/release.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 20"
|
||||
"bump": "node ./scripts/bump.ts",
|
||||
"update-readme": "node ./scripts/update-readme.ts",
|
||||
"release": "node ./scripts/release.ts",
|
||||
"release:pr": "node ./scripts/release-pr.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.10.0",
|
||||
"@actions/exec": "^1.1.1",
|
||||
"@actions/github": "^5.1.1",
|
||||
"@changesets/ghcommit": "1.4.0",
|
||||
"@changesets/pre": "^1.0.9",
|
||||
"@changesets/read": "^0.5.3",
|
||||
"@manypkg/get-packages": "^1.1.3",
|
||||
"@octokit/plugin-throttling": "^5.2.1",
|
||||
"fs-extra": "^8.1.0",
|
||||
"mdast-util-to-string": "^1.0.6",
|
||||
"remark-parse": "^7.0.1",
|
||||
"remark-stringify": "^7.0.3",
|
||||
"resolve-from": "^5.0.0",
|
||||
"semver": "^7.5.3",
|
||||
"unified": "^8.3.2"
|
||||
"@actions/artifact": "^6.2.1",
|
||||
"@actions/core": "^3.0.1",
|
||||
"@actions/exec": "^3.0.0",
|
||||
"@actions/github": "^9.1.1",
|
||||
"@changesets/get-release-plan": "^5.0.0-next.11",
|
||||
"@changesets/ghcommit": "^3.0.0",
|
||||
"@changesets/git": "^4.0.0-next.9",
|
||||
"@changesets/pre": "^3.0.0-next.9",
|
||||
"@changesets/read": "^1.0.0-next.10",
|
||||
"@manypkg/get-packages": "^3.1.0",
|
||||
"@octokit/core": "^7.0.6",
|
||||
"@octokit/plugin-throttling": "^11.0.3",
|
||||
"human-id": "^4.1.3",
|
||||
"markdown-table": "^3.0.4",
|
||||
"semver": "^7.8.1",
|
||||
"tinyexec": "^1.2.4"
|
||||
},
|
||||
"husky": {
|
||||
"hooks": {}
|
||||
"devDependencies": {
|
||||
"@changesets/changelog-github": "^1.0.0-next.9",
|
||||
"@changesets/cli": "^3.0.0-next.12",
|
||||
"@changesets/types": "^7.0.0-next.9",
|
||||
"@changesets/write": "^1.0.0-next.9",
|
||||
"@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",
|
||||
"yaml": "^2.9.0"
|
||||
},
|
||||
"prettier": {},
|
||||
"resolutions": {
|
||||
"**/@octokit/core": "4.2.0",
|
||||
"trim": "^0.0.3",
|
||||
"y18n": "^4.0.1"
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
},
|
||||
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
|
||||
"packageManager": "pnpm@11.1.1+sha512.d1fdf5f73c617b64fa1a56a81c3c8dfe0e966e33a6010aa256b517ae77be21d93e05affc0de1a83b0e4f29d569f68b446ae8f068cd7247c0bb3df0fb4d7bdf9a"
|
||||
}
|
||||
|
||||
Generated
+2595
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,28 @@
|
||||
blockExoticSubdeps: true
|
||||
dedupePeers: true
|
||||
dedupePeerDependents: true
|
||||
minimumReleaseAge: 10080
|
||||
minimumReleaseAgeExclude:
|
||||
- "@changesets/apply-release-plan@8.0.0-next.11"
|
||||
- "@changesets/assemble-release-plan@7.0.0-next.11"
|
||||
- "@changesets/changelog-git@1.0.0-next.9"
|
||||
- "@changesets/changelog-github@1.0.0-next.9"
|
||||
- "@changesets/cli@3.0.0-next.12"
|
||||
- "@changesets/config@4.0.0-next.10"
|
||||
- "@changesets/get-dependents-graph@3.0.0-next.9"
|
||||
- "@changesets/get-github-info@1.0.0-next.4"
|
||||
- "@changesets/get-release-plan@5.0.0-next.11"
|
||||
- "@changesets/git@4.0.0-next.9"
|
||||
- "@changesets/parse@1.0.0-next.10"
|
||||
- "@changesets/pre@3.0.0-next.9"
|
||||
- "@changesets/read@1.0.0-next.10"
|
||||
- "@changesets/should-skip-package@1.0.0-next.9"
|
||||
- "@changesets/types@7.0.0-next.9"
|
||||
- "@changesets/write@1.0.0-next.9"
|
||||
|
||||
overrides:
|
||||
lightningcss: "-" # we do not bundle any css
|
||||
postcss: "-" # we do not bundle any css
|
||||
|
||||
shellEmulator: true
|
||||
trustPolicy: no-downgrade
|
||||
@@ -0,0 +1,89 @@
|
||||
# changesets/action/pr-comment
|
||||
|
||||
This action creates or updates comments on PRs, aimed to complement [changesets/action/pr-status](../pr-status/README.md).
|
||||
|
||||
Its features are kept intentionally simple. For advanced usecases, check out other actions such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Job permissions][job-permissions]:
|
||||
- `pull-requests: write`: to create and update comments on PRs
|
||||
- [Workflow triggers][workflow-triggers]:
|
||||
- [`pull_request`][trigger-pull-request]
|
||||
- [`pull_request_target`][trigger-pull-request-target]
|
||||
|
||||
> [!CAUTION]
|
||||
> **Do not run untrusted code** when using the `pull_request_target` event.
|
||||
>
|
||||
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
|
||||
|
||||
```yaml
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
pr-comment:
|
||||
runs-on: ubuntu-slim
|
||||
permissions:
|
||||
pull-requests: write # to create and update comments on PRs (changesets/action/pr-comment)
|
||||
steps:
|
||||
- name: Comment on PR
|
||||
uses: changesets/action/pr-comment@v2
|
||||
with:
|
||||
body: Hello world!
|
||||
```
|
||||
|
||||
If the action is called again for the same PR, for example, if called in another workflow run, it will update the comment it created by default.
|
||||
|
||||
If you use the action to create different types of comments, pass an `update-id` value to differentiate them.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
pr-comment:
|
||||
# ...
|
||||
steps:
|
||||
- name: Comment on PR
|
||||
uses: changesets/action/pr-comment@v2
|
||||
with:
|
||||
body: Hello world!
|
||||
update-id: my-tag
|
||||
```
|
||||
|
||||
If you want to always create new comments, pass an empty value to `update-id`.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
pr-comment:
|
||||
# ...
|
||||
steps:
|
||||
- uses: changesets/action/pr-comment@v2
|
||||
with:
|
||||
body: Hello world!
|
||||
update-id: ""
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `body` | **Required.** The comment body to post on the PR. |
|
||||
| `update-id` | By default, the action will create and update a comment with this id. Pass a different id to create and update a new comment, or pass an empty string to disable updating comments. |
|
||||
|
||||
| Outputs | Description |
|
||||
| ------------ | ---------------------------------------------------------- |
|
||||
| `comment-id` | The comment id of the comment that was created or updated. |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
|
||||
[trigger-pull-request-target]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
|
||||
@@ -0,0 +1,27 @@
|
||||
name: Changesets - PR Comment
|
||||
description: Create or update comments on PRs
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/pr-comment.js
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
body:
|
||||
description: "The comment body to post on the PR."
|
||||
required: true
|
||||
update-id:
|
||||
description: >
|
||||
By default, the action will create and update a comment with this id. Pass a different id to
|
||||
create and update a new comment, or pass an empty string to disable updating comments.
|
||||
required: false
|
||||
default: "changesets-action-pr-comment"
|
||||
outputs:
|
||||
comment-id:
|
||||
description: "The comment id of the comment that was created or updated."
|
||||
branding:
|
||||
icon: message-circle
|
||||
color: blue
|
||||
@@ -0,0 +1,40 @@
|
||||
# changesets/action/pr-status
|
||||
|
||||
This action generates the changesets status in PRs, for example, whether it has changeset files and which packages will be released if the PR is merged.
|
||||
|
||||
It requires the repo to be checked out, and will automatically fetch the PR head ref into a temporary detached worktree in order to infer the changed files and packages.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]:
|
||||
- [`pull_request`][trigger-pull-request]
|
||||
- [`pull_request_target`][trigger-pull-request-target]
|
||||
|
||||
> [!CAUTION]
|
||||
> **Do not run untrusted code** when using the `pull_request_target` event.
|
||||
>
|
||||
> `pull_request_target` can be useful to support PRs from forks, however it enables write permissions by default which can be a security risk if untrusted code is executed and the permissions aren't scoped down.
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
[trigger-pull-request]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
|
||||
[trigger-pull-request-target]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#non-blocking) to learn how to set up commenting changesets status on PRs.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
Inputs: _none_
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------- | ------------------------------------------------------------------- |
|
||||
| `comment-body` | The generated comment body to present the changesets status in PRs. |
|
||||
|
||||
<!-- api-end -->
|
||||
@@ -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,37 @@
|
||||
# changesets/action/publish
|
||||
|
||||
This action publishes packages to npm.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Needs repo checked out and `@changesets/cli` installed
|
||||
- [Job permissions][job-permissions]:
|
||||
- `id-token: write`: if using [trusted publishing](https://docs.npmjs.com/trusted-publishers)
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
| Inputs | Description |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. To use a custom token, pass it explicitly to this input. |
|
||||
| `script` | The command to use to publish packages |
|
||||
| `pack-dir-artifact-id` | Artifact id for packed publish output generated by the pack subaction |
|
||||
| `create-github-releases` | Whether to create Github releases after publish |
|
||||
| `push-git-tags` | Whether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. |
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `published` | A "true" or "false" string value to indicate whether a publishing has happened or not |
|
||||
| `published-packages` | A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]` |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
@@ -0,0 +1,37 @@
|
||||
name: Changesets - Publish
|
||||
description: Publish packages to npm
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/publish.js
|
||||
inputs:
|
||||
github-token:
|
||||
description: >
|
||||
The GitHub token to use for authentication. Defaults to the GitHub-provided token.
|
||||
To use a custom token, pass it explicitly to this input.
|
||||
required: false
|
||||
default: ${{ github.token }}
|
||||
script:
|
||||
description: "The command to use to publish packages"
|
||||
required: false
|
||||
pack-dir-artifact-id:
|
||||
description: "Artifact id for packed publish output generated by the pack subaction"
|
||||
required: false
|
||||
create-github-releases:
|
||||
description: "Whether to create Github releases after publish"
|
||||
required: false
|
||||
default: true
|
||||
push-git-tags:
|
||||
description: >
|
||||
Whether to create git tags after publish. If `create-github-releases` is set to `true`,
|
||||
this option will also always be `true`.
|
||||
required: false
|
||||
default: true
|
||||
outputs:
|
||||
published:
|
||||
description: A "true" or "false" string value to indicate whether a publishing has happened or not
|
||||
published-packages:
|
||||
description: >
|
||||
A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
|
||||
branding:
|
||||
icon: package
|
||||
color: blue
|
||||
@@ -0,0 +1,21 @@
|
||||
import { defineConfig } from "rolldown";
|
||||
|
||||
export default defineConfig({
|
||||
input: {
|
||||
index: "src/index.ts",
|
||||
pack: "src/pack/index.ts",
|
||||
"pr-status": "src/pr-status/index.ts",
|
||||
"pr-comment": "src/pr-comment/index.ts",
|
||||
"select-mode": "src/select-mode/index.ts",
|
||||
version: "src/version/index.ts",
|
||||
publish: "src/publish/index.ts",
|
||||
},
|
||||
output: {
|
||||
dir: "dist",
|
||||
format: "esm",
|
||||
cleanDir: true,
|
||||
minify: true,
|
||||
comments: false,
|
||||
},
|
||||
platform: "node",
|
||||
});
|
||||
@@ -1,19 +0,0 @@
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const { exec } = require("@actions/exec");
|
||||
|
||||
process.chdir(path.join(__dirname, ".."));
|
||||
|
||||
(async () => {
|
||||
await exec("changeset", ["version"]);
|
||||
|
||||
const releaseLine = `v${require("../package.json").version.split(".")[0]}`;
|
||||
|
||||
const readmePath = path.join(__dirname, "..", "README.md");
|
||||
const content = fs.readFileSync(readmePath, "utf8");
|
||||
const updatedContent = content.replace(
|
||||
/changesets\/action@[^\s]+/g,
|
||||
`changesets/action@${releaseLine}`
|
||||
);
|
||||
fs.writeFileSync(readmePath, updatedContent);
|
||||
})();
|
||||
@@ -0,0 +1,20 @@
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { exec } from "@actions/exec";
|
||||
|
||||
process.chdir(path.join(import.meta.dirname, ".."));
|
||||
|
||||
await exec("changeset", ["version"]);
|
||||
|
||||
// read after versioning to get the new version
|
||||
const pkgJson = (await import("../package.json", { with: { type: "json" } }))
|
||||
.default;
|
||||
const releaseLine = `v${pkgJson.version.split(".")[0]}`;
|
||||
|
||||
const 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,32 @@
|
||||
import { Buffer } from "node:buffer";
|
||||
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";
|
||||
const githubToken = process.env.GITHUB_TOKEN;
|
||||
if (!githubToken) {
|
||||
throw new Error("GITHUB_TOKEN is required");
|
||||
}
|
||||
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
|
||||
const gitEnv = {
|
||||
...process.env,
|
||||
GIT_CONFIG_COUNT: "1",
|
||||
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
|
||||
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
|
||||
};
|
||||
|
||||
process.chdir(path.join(import.meta.dirname, ".."));
|
||||
|
||||
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}`],
|
||||
{
|
||||
env: gitEnv,
|
||||
},
|
||||
);
|
||||
@@ -1,41 +0,0 @@
|
||||
const path = require("path");
|
||||
const { exec, getExecOutput } = require("@actions/exec");
|
||||
|
||||
const { version } = require("../package.json");
|
||||
const tag = `v${version}`;
|
||||
const releaseLine = `v${version.split(".")[0]}`;
|
||||
|
||||
process.chdir(path.join(__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}`,
|
||||
]);
|
||||
})();
|
||||
@@ -0,0 +1,47 @@
|
||||
import { Buffer } from "node:buffer";
|
||||
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 = `v${pkgJson.version.split(".")[0]}`;
|
||||
const isPrerelease = pkgJson.version.includes("-");
|
||||
const githubToken = process.env.GITHUB_TOKEN;
|
||||
if (!githubToken) {
|
||||
throw new Error("GITHUB_TOKEN is required");
|
||||
}
|
||||
const basic = Buffer.from(`x-access-token:${githubToken}`).toString("base64");
|
||||
const gitEnv = {
|
||||
...process.env,
|
||||
GIT_CONFIG_COUNT: "1",
|
||||
GIT_CONFIG_KEY_0: "http.https://github.com/.extraheader",
|
||||
GIT_CONFIG_VALUE_0: `AUTHORIZATION: basic ${basic}`,
|
||||
};
|
||||
|
||||
process.chdir(path.join(import.meta.dirname, ".."));
|
||||
|
||||
await exec("git", ["checkout", "--detach"]);
|
||||
await exec("git", ["add", "--force", "dist"]);
|
||||
await exec("git", ["commit", "-m", tag]);
|
||||
|
||||
await exec("changeset", ["git-tag"]);
|
||||
|
||||
if (isPrerelease) {
|
||||
await exec("git", ["push", "origin", `refs/tags/${tag}`], {
|
||||
env: gitEnv,
|
||||
});
|
||||
} else {
|
||||
await exec(
|
||||
"git",
|
||||
[
|
||||
"push",
|
||||
"--force",
|
||||
"--follow-tags",
|
||||
"origin",
|
||||
`HEAD:refs/heads/${releaseLine}`,
|
||||
],
|
||||
{
|
||||
env: gitEnv,
|
||||
},
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
import * as fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { markdownTable } from "markdown-table";
|
||||
import * as yaml from "yaml";
|
||||
|
||||
await main();
|
||||
|
||||
async function main() {
|
||||
for await (const readmePath of fs.glob("**/README.md", {
|
||||
exclude: ["**/node_modules/**"],
|
||||
})) {
|
||||
const actionPath = path.join(path.dirname(readmePath), "action.yml");
|
||||
const actionExists = await fs.stat(actionPath).catch(() => null);
|
||||
if (!actionExists) continue;
|
||||
|
||||
const action = yaml.parse(await fs.readFile(actionPath, "utf8"));
|
||||
const inputs = action.inputs ?? {};
|
||||
const outputs = action.outputs ?? {};
|
||||
|
||||
const content = [
|
||||
renderSection("Inputs", inputs),
|
||||
renderSection("Outputs", outputs),
|
||||
].join("\n\n");
|
||||
|
||||
const readme = await fs.readFile(readmePath, "utf8");
|
||||
const updated = readme.replace(
|
||||
/<!-- api-start -->[\s\S]*?<!-- api-end -->/,
|
||||
`<!-- api-start -->\n\n${content}\n\n<!-- api-end -->`,
|
||||
);
|
||||
await fs.writeFile(readmePath, updated);
|
||||
}
|
||||
}
|
||||
|
||||
function renderSection(title: string, entries: Record<string, any>) {
|
||||
const rows: string[][] = [];
|
||||
for (const [name, entry] of Object.entries(entries)) {
|
||||
let description = (entry.description ?? "").trim().replace(/\|/g, "\\|");
|
||||
if (entry.required) description = `**Required.** ${description}`;
|
||||
rows.push([`\`${name}\``, description]);
|
||||
}
|
||||
if (rows.length === 0) {
|
||||
return `${title}: _none_`;
|
||||
}
|
||||
rows.unshift([title, "Description"]);
|
||||
return markdownTable(rows);
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
# changesets/action/select-mode
|
||||
|
||||
This action selects the mode to run a Changesets workflow:
|
||||
|
||||
- `"version"`: Changesets are found. The workflow should version packages and create a pull request with the changes.
|
||||
- `"publish"`: No changesets are found and they are publishable packages. The workflow should publish them.
|
||||
- `"none"`: No changesets are found and there are no publishable packages. The workflow should do nothing.
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Job permissions][job-permissions]: _none_
|
||||
- [Workflow triggers][workflow-triggers]: _any_
|
||||
|
||||
## Usage
|
||||
|
||||
> [!TIP]
|
||||
> Check out [the docs](https://changesets.dev/guide/automating#how-do-i-run-the-version-and-publish-commands) to learn how to set up the version and publish workflow.
|
||||
|
||||
## API
|
||||
|
||||
<!-- api-start -->
|
||||
|
||||
Inputs: _none_
|
||||
|
||||
| Outputs | Description |
|
||||
| -------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `mode` | The mode to use for the current repo state: 'version', 'publish', or 'none'. |
|
||||
| `publish-plan-artifact-id` | Artifact id for the generated publish plan when mode is `publish` |
|
||||
|
||||
<!-- api-end -->
|
||||
|
||||
[job-permissions]: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions
|
||||
[workflow-triggers]: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||
@@ -0,0 +1,14 @@
|
||||
name: Changesets - Select Mode
|
||||
description: Whether to version or publish in the current repo state
|
||||
runs:
|
||||
using: node24
|
||||
main: ../dist/select-mode.js
|
||||
inputs: {}
|
||||
outputs:
|
||||
mode:
|
||||
description: "The mode to use for the current repo state: 'version', 'publish', or 'none'."
|
||||
publish-plan-artifact-id:
|
||||
description: "Artifact id for the generated publish plan when mode is `publish`"
|
||||
branding:
|
||||
icon: package
|
||||
color: blue
|
||||
@@ -1,6 +1,6 @@
|
||||
// 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`] = `
|
||||
[
|
||||
{
|
||||
"base": "some-branch",
|
||||
@@ -8,23 +8,12 @@ exports[`version creates simple PR 1`] = `
|
||||
|
||||
|
||||
# Releases
|
||||
## simple-project-pkg-a@1.1.0
|
||||
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies
|
||||
- simple-project-pkg-b@1.1.0
|
||||
|
||||
## simple-project-pkg-b@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature
|
||||
",
|
||||
- Awesome feature",
|
||||
"draft": true,
|
||||
"head": "changeset-release/some-branch",
|
||||
"owner": "changesets",
|
||||
"repo": "action",
|
||||
@@ -33,7 +22,39 @@ exports[`version creates simple PR 1`] = `
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version does not include any release information if a message with simplified release info exceeds size limit 1`] = `
|
||||
exports[`version > 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
|
||||
|
||||
- Updated dependencies
|
||||
- changesets-dev-simple-project-pkg-b@1.1.0
|
||||
## changesets-dev-simple-project-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 > does not include any release information if a message with simplified release info exceeds size limit 1`] = `
|
||||
[
|
||||
{
|
||||
"base": "some-branch",
|
||||
@@ -43,6 +64,7 @@ exports[`version does not include any release information if a message with simp
|
||||
# Releases
|
||||
|
||||
> All release information have been omitted from this message, as the content exceeds the size limit.",
|
||||
"draft": false,
|
||||
"head": "changeset-release/some-branch",
|
||||
"owner": "changesets",
|
||||
"repo": "action",
|
||||
@@ -51,7 +73,7 @@ exports[`version does not include any release information if a message with simp
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version does not include changelog entries if full message exceeds size limit 1`] = `
|
||||
exports[`version > does not include changelog entries if full message exceeds size limit 1`] = `
|
||||
[
|
||||
{
|
||||
"base": "some-branch",
|
||||
@@ -62,9 +84,10 @@ exports[`version does not include changelog entries if full message exceeds size
|
||||
|
||||
> The changelog information of each package has been omitted from this message, as the content exceeds the size limit.
|
||||
|
||||
## simple-project-pkg-a@1.1.0
|
||||
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||
|
||||
",
|
||||
"draft": false,
|
||||
"head": "changeset-release/some-branch",
|
||||
"owner": "changesets",
|
||||
"repo": "action",
|
||||
@@ -73,7 +96,7 @@ exports[`version does not include changelog entries if full message exceeds size
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version doesn't include ignored package that got a dependency update in the PR body 1`] = `
|
||||
exports[`version > doesn't include ignored package that got a dependency update in the PR body 1`] = `
|
||||
[
|
||||
{
|
||||
"base": "some-branch",
|
||||
@@ -81,12 +104,12 @@ exports[`version doesn't include ignored package that got a dependency update in
|
||||
|
||||
|
||||
# Releases
|
||||
## ignored-package-pkg-b@1.1.0
|
||||
## changesets-dev-ignored-package-pkg-b@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature
|
||||
",
|
||||
- Awesome feature",
|
||||
"draft": false,
|
||||
"head": "changeset-release/some-branch",
|
||||
"owner": "changesets",
|
||||
"repo": "action",
|
||||
@@ -95,7 +118,7 @@ exports[`version doesn't include ignored package that got a dependency update in
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version only includes bumped packages in the PR body 1`] = `
|
||||
exports[`version > only includes bumped packages in the PR body 1`] = `
|
||||
[
|
||||
{
|
||||
"base": "some-branch",
|
||||
@@ -103,12 +126,12 @@ exports[`version only includes bumped packages in the PR body 1`] = `
|
||||
|
||||
|
||||
# Releases
|
||||
## simple-project-pkg-a@1.1.0
|
||||
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature
|
||||
",
|
||||
- Awesome feature",
|
||||
"draft": false,
|
||||
"head": "changeset-release/some-branch",
|
||||
"owner": "changesets",
|
||||
"repo": "action",
|
||||
@@ -116,3 +139,92 @@ exports[`version only includes bumped packages in the PR body 1`] = `
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version > updates an existing PR via GraphQL and converts it to draft when prDraft is "always" 1`] = `
|
||||
[
|
||||
"
|
||||
mutation UpdatePullRequest(
|
||||
$pullRequestId: ID!
|
||||
$title: String!
|
||||
$body: String!
|
||||
) {
|
||||
|
||||
convertPullRequestToDraft(
|
||||
input: {
|
||||
pullRequestId: $pullRequestId
|
||||
}
|
||||
) {
|
||||
pullRequest {
|
||||
id
|
||||
}
|
||||
}
|
||||
|
||||
updatePullRequest(
|
||||
input: {
|
||||
pullRequestId: $pullRequestId
|
||||
title: $title
|
||||
body: $body
|
||||
state: OPEN
|
||||
}
|
||||
) {
|
||||
pullRequest {
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
",
|
||||
{
|
||||
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||
|
||||
|
||||
# Releases
|
||||
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature",
|
||||
"pullRequestId": "PR_kwDOA",
|
||||
"title": "Version Packages",
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`version > updates an existing PR via GraphQL without converting it to draft when prDraft is "create" 1`] = `
|
||||
[
|
||||
"
|
||||
mutation UpdatePullRequest(
|
||||
$pullRequestId: ID!
|
||||
$title: String!
|
||||
$body: String!
|
||||
) {
|
||||
|
||||
|
||||
updatePullRequest(
|
||||
input: {
|
||||
pullRequestId: $pullRequestId
|
||||
title: $title
|
||||
body: $body
|
||||
state: OPEN
|
||||
}
|
||||
) {
|
||||
pullRequest {
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
",
|
||||
{
|
||||
"body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
|
||||
|
||||
|
||||
# Releases
|
||||
## changesets-dev-simple-project-pkg-a@1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- Awesome feature",
|
||||
"pullRequestId": "PR_kwDOA",
|
||||
"title": "Version Packages",
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||
|
||||
exports[`it sorts the things right 1`] = `
|
||||
[
|
||||
@@ -31,8 +31,7 @@ exports[`it works 1`] = `
|
||||
|
||||
- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):
|
||||
|
||||
- Update dependencies
|
||||
"
|
||||
- Update dependencies"
|
||||
`;
|
||||
|
||||
exports[`it works 2`] = `
|
||||
@@ -40,6 +39,5 @@ exports[`it works 2`] = `
|
||||
|
||||
- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):
|
||||
|
||||
Move frontmatter in docs into comments
|
||||
"
|
||||
Move frontmatter in docs into comments"
|
||||
`;
|
||||
|
||||
-106
@@ -1,106 +0,0 @@
|
||||
import * as core from "@actions/core";
|
||||
import { exec, getExecOutput } from "@actions/exec";
|
||||
import * as github from "@actions/github";
|
||||
import { commitChangesFromRepo } from "@changesets/ghcommit/git";
|
||||
import { Octokit } from "./octokit";
|
||||
|
||||
const push = async (branch: string, { force }: { force?: boolean } = {}) => {
|
||||
await exec(
|
||||
"git",
|
||||
["push", "origin", `HEAD:${branch}`, force && "--force"].filter<string>(
|
||||
Boolean as any
|
||||
)
|
||||
);
|
||||
};
|
||||
|
||||
const switchToMaybeExistingBranch = async (branch: string) => {
|
||||
let { stderr } = await getExecOutput("git", ["checkout", branch], {
|
||||
ignoreReturnCode: true,
|
||||
});
|
||||
let isCreatingBranch = !stderr
|
||||
.toString()
|
||||
.includes(`Switched to a new branch '${branch}'`);
|
||||
if (isCreatingBranch) {
|
||||
await exec("git", ["checkout", "-b", branch]);
|
||||
}
|
||||
};
|
||||
|
||||
const reset = async (
|
||||
pathSpec: string,
|
||||
mode: "hard" | "soft" | "mixed" = "hard"
|
||||
) => {
|
||||
await exec("git", ["reset", `--${mode}`, pathSpec]);
|
||||
};
|
||||
|
||||
const commitAll = async (message: string) => {
|
||||
await exec("git", ["add", "."]);
|
||||
await exec("git", ["commit", "-m", message]);
|
||||
};
|
||||
|
||||
const checkIfClean = async (): Promise<boolean> => {
|
||||
const { stdout } = await getExecOutput("git", ["status", "--porcelain"]);
|
||||
return !stdout.length;
|
||||
};
|
||||
|
||||
export class Git {
|
||||
octokit;
|
||||
constructor(octokit?: Octokit) {
|
||||
this.octokit = octokit;
|
||||
}
|
||||
|
||||
async setupUser() {
|
||||
if (this.octokit) {
|
||||
return;
|
||||
}
|
||||
await exec("git", ["config", "user.name", `"github-actions[bot]"`]);
|
||||
await exec("git", [
|
||||
"config",
|
||||
"user.email",
|
||||
`"41898282+github-actions[bot]@users.noreply.github.com"`,
|
||||
]);
|
||||
}
|
||||
|
||||
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]);
|
||||
}
|
||||
|
||||
async prepareBranch(branch: string) {
|
||||
if (this.octokit) {
|
||||
// Preparing a new local branch is not necessary when using the API
|
||||
return;
|
||||
}
|
||||
await switchToMaybeExistingBranch(branch);
|
||||
await reset(github.context.sha);
|
||||
}
|
||||
|
||||
async pushChanges({ branch, message }: { branch: string; message: string }) {
|
||||
if (this.octokit) {
|
||||
return commitChangesFromRepo({
|
||||
octokit: this.octokit,
|
||||
...github.context.repo,
|
||||
branch,
|
||||
message,
|
||||
base: {
|
||||
commit: github.context.sha,
|
||||
},
|
||||
force: true,
|
||||
});
|
||||
}
|
||||
if (!(await checkIfClean())) {
|
||||
await commitAll(message);
|
||||
}
|
||||
await push(branch, { force: true });
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,227 @@
|
||||
import { Buffer } from "node:buffer";
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { exec } from "tinyexec";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { GitHub } from "./github.ts";
|
||||
import { createGitHttpRemote, shallowClone, testdir } from "./test-utils.ts";
|
||||
|
||||
const githubContext = vi.hoisted(() => ({
|
||||
repo: {
|
||||
owner: "changesets",
|
||||
repo: "action",
|
||||
},
|
||||
sha: "base-sha",
|
||||
}));
|
||||
|
||||
vi.mock("@actions/github", () => ({
|
||||
context: githubContext,
|
||||
getOctokit: () => ({}),
|
||||
}));
|
||||
|
||||
async function git(cwd: string, args: string[]) {
|
||||
const result = await exec("git", args, {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
return result.stdout.trim();
|
||||
}
|
||||
|
||||
function getAuthorization(token: string) {
|
||||
return `basic ${Buffer.from(`x-access-token:${token}`).toString("base64")}`;
|
||||
}
|
||||
|
||||
function createRemote() {
|
||||
return createGitHttpRemote({ "file.txt": "initial\n" });
|
||||
}
|
||||
|
||||
async function isolateGitConfig() {
|
||||
const fixture = await testdir({ "global.gitconfig": "" });
|
||||
vi.stubEnv("GIT_CONFIG_GLOBAL", path.join(fixture.path, "global.gitconfig"));
|
||||
return fixture;
|
||||
}
|
||||
|
||||
type GitHttpRemote = Awaited<ReturnType<typeof createGitHttpRemote>>;
|
||||
|
||||
async function pushChangedFile(
|
||||
repository: string,
|
||||
serverUrl: string,
|
||||
token: string,
|
||||
) {
|
||||
await fs.writeFile(path.join(repository, "file.txt"), "changed\n");
|
||||
const github = new GitHub({
|
||||
cwd: repository,
|
||||
githubToken: token,
|
||||
pushWithGitCli: true,
|
||||
serverUrl,
|
||||
});
|
||||
await github.pushChanges({
|
||||
branch: "changeset-release/main",
|
||||
message: "Version Packages",
|
||||
});
|
||||
return github;
|
||||
}
|
||||
|
||||
async function expectReleaseBranch(remote: GitHttpRemote, repository: string) {
|
||||
expect(
|
||||
await git(remote.path, ["rev-parse", "refs/heads/changeset-release/main"]),
|
||||
).toBe(await git(repository, ["rev-parse", "HEAD"]));
|
||||
}
|
||||
|
||||
function expectRequestsToUseToken(remote: GitHttpRemote, token: string) {
|
||||
expect(remote.requests.length).toBeGreaterThan(0);
|
||||
for (const request of remote.requests) {
|
||||
expect(request.headers.authorization).toEqual([getAuthorization(token)]);
|
||||
}
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.stubEnv("GIT_AUTHOR_DATE", "2000-01-01T00:00:00Z");
|
||||
vi.stubEnv("GIT_COMMITTER_DATE", "2000-01-01T00:00:00Z");
|
||||
vi.stubEnv("GIT_CONFIG_COUNT", "0");
|
||||
vi.stubEnv("GIT_CONFIG_NOSYSTEM", "1");
|
||||
vi.stubEnv("GIT_TERMINAL_PROMPT", "0");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
describe("GitHub", () => {
|
||||
it("defaults to GitHub API mode", () => {
|
||||
const github = new GitHub({
|
||||
cwd: "/repo",
|
||||
githubToken: "token",
|
||||
});
|
||||
|
||||
expect(github.pushWithGitCli).toBe(false);
|
||||
});
|
||||
|
||||
it("uses github-token instead of checkout's persisted header for branch and tag pushes", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
const checkoutToken = "checkout-token";
|
||||
await using remote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(remote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
const serverUrl = new URL(remote.url).origin;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", remote.url]);
|
||||
await git(repository, [
|
||||
"config",
|
||||
`http.${serverUrl}/.extraheader`,
|
||||
`AUTHORIZATION: ${getAuthorization(checkoutToken)}`,
|
||||
]);
|
||||
|
||||
const github = await pushChangedFile(repository, serverUrl, actionToken);
|
||||
await git(repository, ["tag", "v1.0.0"]);
|
||||
await github.pushTag("v1.0.0");
|
||||
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expect(await git(remote.path, ["rev-parse", "refs/tags/v1.0.0"])).toBe(
|
||||
await git(repository, ["rev-parse", "v1.0.0"]),
|
||||
);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses github-token instead of credentials embedded in the push URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using remote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(remote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
const remoteUrl = new URL(remote.url);
|
||||
remoteUrl.username = "x-access-token";
|
||||
remoteUrl.password = "checkout-token";
|
||||
await git(repository, ["remote", "set-url", "origin", remoteUrl.href]);
|
||||
|
||||
const persistedCredentialUrl = new URL(remoteUrl);
|
||||
persistedCredentialUrl.password = "";
|
||||
await git(repository, [
|
||||
"config",
|
||||
`http.${persistedCredentialUrl.href}.extraheader`,
|
||||
`AUTHORIZATION: ${getAuthorization("checkout-token")}`,
|
||||
]);
|
||||
|
||||
await pushChangedFile(repository, remoteUrl.origin, actionToken);
|
||||
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses the push URL when it differs from the fetch URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using fetchRemote = await createRemote();
|
||||
await using pushRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(fetchRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
|
||||
await git(repository, ["config", "remote.origin.pushurl", pushRemote.url]);
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(fetchRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
expect(fetchRemote.requests).toEqual([]);
|
||||
await expectReleaseBranch(pushRemote, repository);
|
||||
expectRequestsToUseToken(pushRemote, actionToken);
|
||||
}, 15_000);
|
||||
|
||||
it("uses github-token for every push URL", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using firstRemote = await createRemote();
|
||||
await using secondRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(firstRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
for (const remote of [firstRemote, secondRemote]) {
|
||||
await git(repository, [
|
||||
"config",
|
||||
"--add",
|
||||
"remote.origin.pushurl",
|
||||
remote.url,
|
||||
]);
|
||||
}
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(firstRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
for (const remote of [firstRemote, secondRemote]) {
|
||||
await expectReleaseBranch(remote, repository);
|
||||
expectRequestsToUseToken(remote, actionToken);
|
||||
}
|
||||
}, 15_000);
|
||||
|
||||
it("preserves existing command-scoped Git config entries", async () => {
|
||||
await using _gitConfig = await isolateGitConfig();
|
||||
const actionToken = "action-token";
|
||||
await using fetchRemote = await createRemote();
|
||||
await using pushRemote = await createRemote();
|
||||
await using repositoryFixture = await shallowClone(fetchRemote.path);
|
||||
const repository = repositoryFixture.path;
|
||||
|
||||
await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);
|
||||
vi.stubEnv("GIT_CONFIG_COUNT", "1");
|
||||
vi.stubEnv("GIT_CONFIG_KEY_0", "remote.origin.pushurl");
|
||||
vi.stubEnv("GIT_CONFIG_VALUE_0", pushRemote.url);
|
||||
|
||||
await pushChangedFile(
|
||||
repository,
|
||||
new URL(fetchRemote.url).origin,
|
||||
actionToken,
|
||||
);
|
||||
|
||||
expect(fetchRemote.requests).toEqual([]);
|
||||
await expectReleaseBranch(pushRemote, repository);
|
||||
expectRequestsToUseToken(pushRemote, actionToken);
|
||||
}, 15_000);
|
||||
});
|
||||
+273
@@ -0,0 +1,273 @@
|
||||
import { Buffer } from "node:buffer";
|
||||
import * as core from "@actions/core";
|
||||
import { exec, getExecOutput } from "@actions/exec";
|
||||
import { context } from "@actions/github";
|
||||
import { commitChangesSinceBase } from "@changesets/ghcommit";
|
||||
import { setupOctokit, type Octokit } from "./octokit.ts";
|
||||
|
||||
type GitOptions = {
|
||||
cwd: string;
|
||||
env?: Record<string, string>;
|
||||
};
|
||||
|
||||
const push = async (branch: string, options: GitOptions) => {
|
||||
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
|
||||
};
|
||||
|
||||
const switchToMaybeExistingBranch = async (
|
||||
branch: string,
|
||||
options: GitOptions,
|
||||
) => {
|
||||
let { stderr } = await getExecOutput("git", ["checkout", branch], {
|
||||
ignoreReturnCode: true,
|
||||
...options,
|
||||
});
|
||||
let isCreatingBranch = !stderr
|
||||
.toString()
|
||||
.includes(`Switched to a new branch '${branch}'`);
|
||||
if (isCreatingBranch) {
|
||||
await exec("git", ["checkout", "-b", branch], options);
|
||||
}
|
||||
};
|
||||
|
||||
const reset = async (pathSpec: string, options: GitOptions) => {
|
||||
await exec("git", ["reset", `--hard`, pathSpec], options);
|
||||
};
|
||||
|
||||
const commitAll = async (message: string, options: GitOptions) => {
|
||||
await exec("git", ["add", "."], options);
|
||||
await exec("git", ["commit", "-m", message], options);
|
||||
};
|
||||
|
||||
const checkIfClean = async (options: GitOptions): Promise<boolean> => {
|
||||
const { stdout } = await getExecOutput(
|
||||
"git",
|
||||
["status", "--porcelain"],
|
||||
options,
|
||||
);
|
||||
return !stdout.length;
|
||||
};
|
||||
|
||||
function getHttpUrl(remoteUrl: string): string | undefined {
|
||||
try {
|
||||
const url = new URL(remoteUrl);
|
||||
if (url.protocol !== "http:" && url.protocol !== "https:") {
|
||||
return;
|
||||
}
|
||||
|
||||
// Git includes the username when deciding which URL-specific config is
|
||||
// most specific, so retain it. Password, query, and fragment do not
|
||||
// participate in matching; strip them before copying the URL into the env.
|
||||
url.password = "";
|
||||
url.search = "";
|
||||
url.hash = "";
|
||||
return url.href;
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
export class GitHub {
|
||||
readonly #githubToken: string;
|
||||
readonly octokit: Octokit;
|
||||
readonly cwd: string;
|
||||
readonly pushWithGitCli: boolean;
|
||||
readonly serverUrl: string;
|
||||
|
||||
constructor(options: {
|
||||
githubToken: string;
|
||||
cwd: string;
|
||||
pushWithGitCli?: boolean;
|
||||
serverUrl?: string;
|
||||
}) {
|
||||
this.#githubToken = options.githubToken;
|
||||
this.cwd = options.cwd;
|
||||
this.pushWithGitCli = options.pushWithGitCli ?? false;
|
||||
this.serverUrl = (
|
||||
options.serverUrl ??
|
||||
context.serverUrl ??
|
||||
process.env.GITHUB_SERVER_URL ??
|
||||
"https://github.com"
|
||||
).replace(/\/+$/, "");
|
||||
this.octokit = setupOctokit(options.githubToken);
|
||||
}
|
||||
|
||||
getToken() {
|
||||
return this.#githubToken;
|
||||
}
|
||||
|
||||
async #getCliAuthEnv(): Promise<Record<string, string>> {
|
||||
// Make `github-token` authoritative for CLI pushes without changing the
|
||||
// repository config. Git may otherwise use checkout's persisted header or
|
||||
// credentials embedded in a remote URL, so we need to install command-scoped
|
||||
// `http.extraHeader` overrides for every push destination.
|
||||
//
|
||||
// Historical context: v1 put `github-token` in ~/.netrc, where checkout's
|
||||
// extraheader took precedence. This setup with reset + authHeader
|
||||
// deliberately makes `github-token` win for pushes.
|
||||
const basic = Buffer.from(`x-access-token:${this.#githubToken}`).toString(
|
||||
"base64",
|
||||
);
|
||||
|
||||
// The environment may already contain command-scoped Git config. Append
|
||||
// our KEY_n/VALUE_n entries so those existing settings stay active.
|
||||
const gitConfigCount = Number(process.env.GIT_CONFIG_COUNT ?? 0);
|
||||
if (!Number.isInteger(gitConfigCount) || gitConfigCount < 0) {
|
||||
throw new Error(
|
||||
`Invalid GIT_CONFIG_COUNT value: ${process.env.GIT_CONFIG_COUNT}`,
|
||||
);
|
||||
}
|
||||
|
||||
// `git push origin` prefers remote.origin.pushurl over the fetch URL and
|
||||
// supports more than one push URL, so inspect every effective destination.
|
||||
const { stdout } = await getExecOutput(
|
||||
"git",
|
||||
["remote", "get-url", "--push", "--all", "origin"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
// A user-configured remote can contain credentials.
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
|
||||
// Git reads `http.extraHeader` from the most specific matching URL section.
|
||||
// The host key replaces checkout's usual persisted header; an exact key for
|
||||
// each destination outranks path- or username-specific inherited config.
|
||||
// Git selects only one URL section, so these keys do not duplicate headers.
|
||||
const extraHeaderKeys = new Set([`http.${this.serverUrl}/.extraheader`]);
|
||||
for (const remoteUrl of stdout.split(/\r?\n/)) {
|
||||
const httpUrl = getHttpUrl(remoteUrl);
|
||||
if (httpUrl !== undefined) {
|
||||
extraHeaderKeys.add(`http.${httpUrl}.extraheader`);
|
||||
}
|
||||
}
|
||||
const authHeader = `AUTHORIZATION: basic ${basic}`;
|
||||
|
||||
// Each URL key needs two new command-scoped config entries: one to reset
|
||||
// the inherited header list and one to install our Authorization header.
|
||||
const env: Record<string, string> = {
|
||||
GIT_CONFIG_COUNT: String(gitConfigCount + extraHeaderKeys.size * 2),
|
||||
};
|
||||
|
||||
// `http.extraHeader` is multi-valued, so merely appending our header could
|
||||
// make Git send both tokens. An empty value resets inherited values; the
|
||||
// following value adds only ours.
|
||||
let index = 0;
|
||||
for (const extraHeaderKey of extraHeaderKeys) {
|
||||
const resetIndex = gitConfigCount + index * 2;
|
||||
const authIndex = resetIndex + 1;
|
||||
env[`GIT_CONFIG_KEY_${resetIndex}`] = extraHeaderKey;
|
||||
env[`GIT_CONFIG_VALUE_${resetIndex}`] = "";
|
||||
env[`GIT_CONFIG_KEY_${authIndex}`] = extraHeaderKey;
|
||||
env[`GIT_CONFIG_VALUE_${authIndex}`] = authHeader;
|
||||
index++;
|
||||
}
|
||||
|
||||
return env;
|
||||
}
|
||||
|
||||
async ensureGitUser() {
|
||||
// Check the exact identities that Git would use for commits without
|
||||
// allowing Git to fall back to auto-detected values like user@hostname.
|
||||
// This covers explicit GIT_AUTHOR_* / GIT_COMMITTER_* env vars, local
|
||||
// config, and global config. A partial identity, with only a name or only
|
||||
// an email, does not pass this check. If either identity is missing,
|
||||
// configure our default bot user as a fallback.
|
||||
const authorIdentity = await getExecOutput(
|
||||
"git",
|
||||
["-c", "user.useConfigOnly=true", "var", "GIT_AUTHOR_IDENT"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
const committerIdentity = await getExecOutput(
|
||||
"git",
|
||||
["-c", "user.useConfigOnly=true", "var", "GIT_COMMITTER_IDENT"],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
ignoreReturnCode: true,
|
||||
silent: true,
|
||||
},
|
||||
);
|
||||
if (authorIdentity.exitCode === 0 && committerIdentity.exitCode === 0) {
|
||||
return;
|
||||
}
|
||||
core.info("Setting Git user to github-actions[bot]");
|
||||
await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
|
||||
cwd: this.cwd,
|
||||
});
|
||||
await exec(
|
||||
"git",
|
||||
[
|
||||
"config",
|
||||
"user.email",
|
||||
`"41898282+github-actions[bot]@users.noreply.github.com"`,
|
||||
],
|
||||
{
|
||||
cwd: this.cwd,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
async pushTag(tag: string) {
|
||||
if (!this.pushWithGitCli) {
|
||||
return this.octokit.rest.git
|
||||
.createRef({
|
||||
...context.repo,
|
||||
ref: `refs/tags/${tag}`,
|
||||
sha: 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,
|
||||
env: {
|
||||
...process.env,
|
||||
...(await this.#getCliAuthEnv()),
|
||||
} as Record<string, string>,
|
||||
});
|
||||
}
|
||||
|
||||
async prepareBranch(branch: string) {
|
||||
if (!this.pushWithGitCli) {
|
||||
// Preparing a new local branch is not necessary when using the API
|
||||
return;
|
||||
}
|
||||
await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
|
||||
await reset(context.sha, { cwd: this.cwd });
|
||||
}
|
||||
|
||||
async pushChanges({ branch, message }: { branch: string; message: string }) {
|
||||
if (!this.pushWithGitCli) {
|
||||
await commitChangesSinceBase({
|
||||
octokit: this.octokit,
|
||||
...context.repo,
|
||||
branch,
|
||||
message,
|
||||
base: {
|
||||
commit: context.sha,
|
||||
},
|
||||
force: true,
|
||||
cwd: this.cwd,
|
||||
});
|
||||
return;
|
||||
}
|
||||
if (!(await checkIfClean({ cwd: this.cwd }))) {
|
||||
await this.ensureGitUser();
|
||||
await commitAll(message, { cwd: this.cwd });
|
||||
}
|
||||
await push(branch, {
|
||||
cwd: this.cwd,
|
||||
env: {
|
||||
...process.env,
|
||||
...(await this.#getCliAuthEnv()),
|
||||
} as Record<string, string>,
|
||||
});
|
||||
}
|
||||
}
|
||||
+84
-83
@@ -1,132 +1,133 @@
|
||||
import * as core from "@actions/core";
|
||||
import fs from "fs-extra";
|
||||
import { Git } from "./git";
|
||||
import { setupOctokit } from "./octokit";
|
||||
import readChangesetState from "./readChangesetState";
|
||||
import { runPublish, runVersion } from "./run";
|
||||
|
||||
const getOptionalInput = (name: string) => core.getInput(name) || undefined;
|
||||
import { GitHub } from "./github.ts";
|
||||
import readChangesetState from "./readChangesetState.ts";
|
||||
import { runPublish, runVersion } from "./run.ts";
|
||||
import {
|
||||
getOptionalInput,
|
||||
getRequiredInput,
|
||||
throwOnRemovedCommitModeInput,
|
||||
throwOnRenamedInputs,
|
||||
validateChangesetsCliVersion,
|
||||
} from "./utils.ts";
|
||||
|
||||
(async () => {
|
||||
let githubToken = process.env.GITHUB_TOKEN;
|
||||
// If the user needs to change the cwd, set `working-directory` in the step instead
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
if (!githubToken) {
|
||||
core.setFailed("Please add the GITHUB_TOKEN to the changesets action");
|
||||
return;
|
||||
}
|
||||
throwOnRenamedInputs({
|
||||
publish: "publish-script",
|
||||
version: "version-script",
|
||||
commit: "commit-mesage",
|
||||
title: "pr-title",
|
||||
branch: "pr-base-branch",
|
||||
prDraft: "pr-draft",
|
||||
createGithubReleases: "create-github-releases",
|
||||
});
|
||||
throwOnRemovedCommitModeInput();
|
||||
|
||||
const inputCwd = core.getInput("cwd");
|
||||
if (inputCwd) {
|
||||
core.info("changing directory to the one given as the input");
|
||||
process.chdir(inputCwd);
|
||||
}
|
||||
|
||||
const octokit = setupOctokit(githubToken);
|
||||
const commitMode = getOptionalInput("commitMode") ?? "git-cli";
|
||||
if (commitMode !== "git-cli" && commitMode !== "github-api") {
|
||||
core.setFailed(`Invalid commit mode: ${commitMode}`);
|
||||
return;
|
||||
}
|
||||
const git = new Git(commitMode === "github-api" ? octokit : undefined);
|
||||
|
||||
let setupGitUser = core.getBooleanInput("setupGitUser");
|
||||
|
||||
if (setupGitUser) {
|
||||
core.info("setting git user");
|
||||
await git.setupUser();
|
||||
}
|
||||
|
||||
core.info("setting GitHub credentials");
|
||||
await fs.writeFile(
|
||||
`${process.env.HOME}/.netrc`,
|
||||
`machine github.com\nlogin github-actions[bot]\npassword ${githubToken}`
|
||||
const githubToken = getRequiredInput("github-token");
|
||||
if (process.env.GITHUB_TOKEN && process.env.GITHUB_TOKEN !== githubToken) {
|
||||
throw new Error(
|
||||
'The GITHUB_TOKEN environment variable is set and does not match the "github-token" input. ' +
|
||||
'Please pass the custom GitHub token to the "github-token" input and ' +
|
||||
"remove the GITHUB_TOKEN environment variable to avoid conflicts.",
|
||||
);
|
||||
}
|
||||
|
||||
let { changesets } = await readChangesetState();
|
||||
const pushWithGitCli = core.getBooleanInput("push-with-git-cli");
|
||||
const prDraft = getOptionalInput("pr-draft");
|
||||
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
|
||||
core.setFailed(`Invalid pr-draft: ${prDraft}`);
|
||||
return;
|
||||
}
|
||||
const github = new GitHub({
|
||||
cwd,
|
||||
githubToken,
|
||||
pushWithGitCli,
|
||||
});
|
||||
|
||||
let publishScript = core.getInput("publish");
|
||||
let { changesets } = await readChangesetState(cwd);
|
||||
|
||||
let publishScript = core.getInput("publish-script");
|
||||
let hasChangesets = changesets.length !== 0;
|
||||
const hasNonEmptyChangesets = changesets.some(
|
||||
(changeset) => changeset.releases.length > 0
|
||||
(changeset) => changeset.releases.length > 0,
|
||||
);
|
||||
let hasPublishScript = !!publishScript;
|
||||
|
||||
core.setOutput("published", "false");
|
||||
core.setOutput("publishedPackages", "[]");
|
||||
core.setOutput("hasChangesets", String(hasChangesets));
|
||||
core.setOutput("published-packages", "[]");
|
||||
core.setOutput("has-changesets", String(hasChangesets));
|
||||
|
||||
switch (true) {
|
||||
case !hasChangesets && !hasPublishScript:
|
||||
core.info(
|
||||
"No changesets present or were removed by merging release PR. Not publishing because no publish script found."
|
||||
"No changesets present or were removed by merging release PR. Not publishing because no publish script found.",
|
||||
);
|
||||
return;
|
||||
case !hasChangesets && hasPublishScript: {
|
||||
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 (fs.existsSync(userNpmrcPath)) {
|
||||
core.info("Found existing user .npmrc file");
|
||||
const userNpmrcContent = await fs.readFile(userNpmrcPath, "utf8");
|
||||
const authLine = userNpmrcContent.split("\n").find((line) => {
|
||||
// check based on https://github.com/npm/cli/blob/8f8f71e4dd5ee66b3b17888faad5a7bf6c657eed/test/lib/adduser.js#L103-L105
|
||||
return /^\s*\/\/registry\.npmjs\.org\/:[_-]authToken=/i.test(line);
|
||||
});
|
||||
if (authLine) {
|
||||
core.info(
|
||||
"Found existing auth token for the npm registry in the user .npmrc file"
|
||||
const createGithubReleases = core.getBooleanInput(
|
||||
"create-github-releases",
|
||||
);
|
||||
} else {
|
||||
core.info(
|
||||
"Didn't find existing auth token for the npm registry in the user .npmrc file, creating one"
|
||||
);
|
||||
fs.appendFileSync(
|
||||
userNpmrcPath,
|
||||
`\n//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
|
||||
const pushGitTags = core.getBooleanInput("push-git-tags");
|
||||
if (createGithubReleases && !pushGitTags) {
|
||||
throw new Error(
|
||||
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " +
|
||||
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " +
|
||||
"or set 'create-github-releases' to false.",
|
||||
);
|
||||
}
|
||||
} else {
|
||||
core.info("No user .npmrc file found, creating one");
|
||||
fs.writeFileSync(
|
||||
userNpmrcPath,
|
||||
`//registry.npmjs.org/:_authToken=${process.env.NPM_TOKEN}\n`
|
||||
);
|
||||
}
|
||||
|
||||
const result = await runPublish({
|
||||
script: publishScript,
|
||||
git,
|
||||
octokit,
|
||||
createGithubReleases: core.getBooleanInput("createGithubReleases"),
|
||||
github,
|
||||
createGithubReleases,
|
||||
pushGitTags,
|
||||
cwd,
|
||||
});
|
||||
|
||||
if (result.published) {
|
||||
core.setOutput("published", "true");
|
||||
core.setOutput(
|
||||
"publishedPackages",
|
||||
JSON.stringify(result.publishedPackages)
|
||||
"published-packages",
|
||||
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;
|
||||
}
|
||||
case hasChangesets && !hasNonEmptyChangesets:
|
||||
core.info("All changesets are empty; not creating PR");
|
||||
return;
|
||||
case hasChangesets: {
|
||||
const octokit = setupOctokit(githubToken);
|
||||
const { pullRequestNumber } = await runVersion({
|
||||
script: getOptionalInput("version"),
|
||||
git,
|
||||
octokit,
|
||||
prTitle: getOptionalInput("title"),
|
||||
commitMessage: getOptionalInput("commit"),
|
||||
script: getOptionalInput("version-script"),
|
||||
github,
|
||||
cwd,
|
||||
prTitle: getOptionalInput("pr-title"),
|
||||
commitMessage: getOptionalInput("commit-message"),
|
||||
hasPublishScript,
|
||||
branch: getOptionalInput("branch"),
|
||||
prDraft,
|
||||
branch: getOptionalInput("pr-base-branch"),
|
||||
});
|
||||
|
||||
core.setOutput("pullRequestNumber", String(pullRequestNumber));
|
||||
core.setOutput("pr-number", String(pullRequestNumber));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
+9
-7
@@ -1,14 +1,15 @@
|
||||
import * as core from "@actions/core";
|
||||
import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
|
||||
import { getOctokit } from "@actions/github";
|
||||
import { throttling } from "@octokit/plugin-throttling";
|
||||
|
||||
export const setupOctokit = (githubToken: string) => {
|
||||
return new (GitHub.plugin(throttling))(
|
||||
getOctokitOptions(githubToken, {
|
||||
return getOctokit(
|
||||
githubToken,
|
||||
{
|
||||
throttle: {
|
||||
onRateLimit: (retryAfter, options: any, octokit, retryCount) => {
|
||||
core.warning(
|
||||
`Request quota exhausted for request ${options.method} ${options.url}`
|
||||
`Request quota exhausted for request ${options.method} ${options.url}`,
|
||||
);
|
||||
|
||||
if (retryCount <= 2) {
|
||||
@@ -20,10 +21,10 @@ export const setupOctokit = (githubToken: string) => {
|
||||
retryAfter,
|
||||
options: any,
|
||||
octokit,
|
||||
retryCount
|
||||
retryCount,
|
||||
) => {
|
||||
core.warning(
|
||||
`SecondaryRateLimit detected for request ${options.method} ${options.url}`
|
||||
`SecondaryRateLimit detected for request ${options.method} ${options.url}`,
|
||||
);
|
||||
|
||||
if (retryCount <= 2) {
|
||||
@@ -32,7 +33,8 @@ export const setupOctokit = (githubToken: string) => {
|
||||
}
|
||||
},
|
||||
},
|
||||
})
|
||||
},
|
||||
throttling,
|
||||
);
|
||||
};
|
||||
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import artifact from "@actions/artifact";
|
||||
import * as core from "@actions/core";
|
||||
import {
|
||||
downloadArtifact,
|
||||
execChangesetsCli,
|
||||
getOptionalInput,
|
||||
validateChangesetsCliVersion,
|
||||
} from "../utils.ts";
|
||||
|
||||
try {
|
||||
await main();
|
||||
} catch (err) {
|
||||
core.setFailed((err as Error).message);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
// If the user needs to change the cwd, set `working-directory` in the step instead
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
const publishPlanArtifactId = getOptionalInput("publish-plan-artifact-id");
|
||||
|
||||
const tmpDir = process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir()));
|
||||
const outDir = path.join(tmpDir, `changeset-pack-${Date.now()}`);
|
||||
|
||||
await pack(cwd, {
|
||||
outDir,
|
||||
publishPlanPath: publishPlanArtifactId
|
||||
? await downloadPublishPlanArtifact(tmpDir, Number(publishPlanArtifactId))
|
||||
: undefined,
|
||||
});
|
||||
|
||||
const packDirArtifact = await artifact.uploadArtifact(
|
||||
`changeset-pack-${Date.now()}`,
|
||||
await getFiles(outDir),
|
||||
outDir,
|
||||
{
|
||||
retentionDays: 30,
|
||||
},
|
||||
);
|
||||
if (packDirArtifact.id === undefined) {
|
||||
throw new Error("Packed artifact upload did not return an artifact id");
|
||||
}
|
||||
core.setOutput("pack-dir-artifact-id", String(packDirArtifact.id));
|
||||
}
|
||||
|
||||
async function pack(
|
||||
cwd: string,
|
||||
args: {
|
||||
outDir: string;
|
||||
publishPlanPath?: string;
|
||||
},
|
||||
) {
|
||||
const cliArgs = ["pack", "--out-dir", args.outDir];
|
||||
if (args.publishPlanPath) {
|
||||
cliArgs.push("--from-publish-plan", args.publishPlanPath);
|
||||
}
|
||||
|
||||
await execChangesetsCli(cliArgs, {
|
||||
cwd,
|
||||
env: process.env,
|
||||
});
|
||||
}
|
||||
|
||||
async function downloadPublishPlanArtifact(tmpDir: string, artifactId: number) {
|
||||
const downloadPath = await downloadArtifact(
|
||||
tmpDir,
|
||||
artifactId,
|
||||
"changeset-publish-plan",
|
||||
);
|
||||
return path.join(downloadPath, "publish-plan.json");
|
||||
}
|
||||
|
||||
async function getFiles(dir: string): Promise<string[]> {
|
||||
const entries = await fs.readdir(dir, { withFileTypes: true });
|
||||
const files = await Promise.all(
|
||||
entries.map(async (entry) => {
|
||||
const entryPath = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) {
|
||||
return getFiles(entryPath);
|
||||
}
|
||||
return [entryPath];
|
||||
}),
|
||||
);
|
||||
return files.flat();
|
||||
}
|
||||
@@ -0,0 +1,78 @@
|
||||
import * as core from "@actions/core";
|
||||
import * as github from "@actions/github";
|
||||
import { getOptionalInput, getRequiredInput } from "../utils.ts";
|
||||
|
||||
type Octokit = ReturnType<typeof github.getOctokit>;
|
||||
type CreateCommentParams = NonNullable<
|
||||
Parameters<Octokit["rest"]["issues"]["createComment"]>[0]
|
||||
>;
|
||||
type UpdateCommentParams = NonNullable<
|
||||
Parameters<Octokit["rest"]["issues"]["updateComment"]>[0]
|
||||
>;
|
||||
|
||||
try {
|
||||
await main();
|
||||
} catch (err) {
|
||||
core.setFailed((err as Error).message);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const context = github.context.payload.pull_request;
|
||||
if (!context) {
|
||||
throw new Error(
|
||||
"This action should only be run on `pull_request_target` or `pull_request` events",
|
||||
);
|
||||
}
|
||||
|
||||
const githubToken = getRequiredInput("github-token");
|
||||
const body = getRequiredInput("body");
|
||||
const updateId = getOptionalInput("update-id");
|
||||
|
||||
const commentMarker = updateId ? getCommentMarker(updateId) : null;
|
||||
const commentBody = commentMarker ? `${commentMarker}\n\n${body}` : body;
|
||||
const commentParam: CreateCommentParams | UpdateCommentParams = {
|
||||
repo: context.base.repo.name,
|
||||
owner: context.base.repo.owner.login,
|
||||
issue_number: context.number,
|
||||
body: commentBody,
|
||||
};
|
||||
|
||||
const octokit = github.getOctokit(githubToken);
|
||||
|
||||
let existingCommentId: number | undefined;
|
||||
if (commentMarker) {
|
||||
core.info("Checking for existing comment...");
|
||||
existingCommentId = await octokit.rest.issues
|
||||
.listComments({
|
||||
repo: context.base.repo.name,
|
||||
owner: context.base.repo.owner.login,
|
||||
issue_number: context.number,
|
||||
})
|
||||
.then((res) => {
|
||||
const comment = res.data.find((c) => c.body?.includes(commentMarker));
|
||||
return comment?.id;
|
||||
});
|
||||
}
|
||||
|
||||
if (existingCommentId) {
|
||||
core.info(`Updating existing comment (id: ${existingCommentId})...`);
|
||||
await octokit.rest.issues.updateComment({
|
||||
...commentParam,
|
||||
comment_id: existingCommentId,
|
||||
});
|
||||
core.setOutput("comment-id", existingCommentId);
|
||||
} else {
|
||||
core.info("Creating new comment...");
|
||||
const result = await octokit.rest.issues.createComment(commentParam);
|
||||
core.setOutput("comment-id", result.data.id);
|
||||
}
|
||||
|
||||
core.info("Done!");
|
||||
}
|
||||
|
||||
function getCommentMarker(updateId: string) {
|
||||
const prefix = "changesets-action-pr-comment";
|
||||
return prefix === updateId
|
||||
? `<!-- ${prefix} -->`
|
||||
: `<!-- ${prefix}:${updateId} -->`;
|
||||
}
|
||||
@@ -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,136 @@
|
||||
import { pathToFileURL } from "node:url";
|
||||
import type * as github from "@actions/github";
|
||||
import { getReleasePlan } from "@changesets/get-release-plan";
|
||||
import { exec } from "tinyexec";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { gitdir, shallowClone, testdir } from "../test-utils.ts";
|
||||
import { getPullRequestWorktree } from "./worktree.ts";
|
||||
|
||||
type PullRequestContext = NonNullable<
|
||||
typeof github.context.payload.pull_request
|
||||
>;
|
||||
|
||||
async function git(cwd: string, args: string[]) {
|
||||
const output = await exec("git", args, {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
return output.stdout.trim();
|
||||
}
|
||||
|
||||
describe("getPullRequestWorktree", () => {
|
||||
it("fetches a PR branch into a detached worktree and keeps the main checkout untouched", async () => {
|
||||
// Local source repo
|
||||
await using sourceRepoFixture = await gitdir({
|
||||
".changeset/config.json": JSON.stringify({}),
|
||||
"package.json": JSON.stringify({
|
||||
name: "repo",
|
||||
private: true,
|
||||
workspaces: ["packages/*"],
|
||||
}),
|
||||
"package-lock.json": "",
|
||||
"packages/pkg-a/package.json": JSON.stringify({
|
||||
name: "pkg-a",
|
||||
version: "1.0.0",
|
||||
}),
|
||||
});
|
||||
const sourceRepo = sourceRepoFixture.path;
|
||||
|
||||
// Simulate remote bare git server
|
||||
await using originBareFixture = await testdir();
|
||||
const originBare = originBareFixture.path;
|
||||
await git(originBare, [
|
||||
"clone",
|
||||
"--bare",
|
||||
pathToFileURL(sourceRepo).toString(),
|
||||
".",
|
||||
]);
|
||||
|
||||
// Simulate checkout PR in github action
|
||||
await using checkoutRepoFixture = await shallowClone(originBare);
|
||||
const checkoutRepo = checkoutRepoFixture.path;
|
||||
|
||||
// Simulate remote fork bare git server
|
||||
await using forkBareFixture = await testdir();
|
||||
const forkBare = forkBareFixture.path;
|
||||
await git(forkBare, [
|
||||
"clone",
|
||||
"--bare",
|
||||
pathToFileURL(originBare).toString(),
|
||||
".",
|
||||
]);
|
||||
|
||||
await using forkRepoFixture = await shallowClone(forkBare);
|
||||
const forkRepo = forkRepoFixture.path;
|
||||
await git(forkRepo, ["config", "user.name", "Test User"]);
|
||||
await git(forkRepo, ["config", "user.email", "test@example.com"]);
|
||||
await git(forkRepo, ["checkout", "-b", "feature"]);
|
||||
|
||||
await forkRepoFixture.mkdir("packages/pkg-a/src");
|
||||
await forkRepoFixture.writeFile(
|
||||
"packages/pkg-a/src/index.ts",
|
||||
"export const value = 1;\n",
|
||||
);
|
||||
await forkRepoFixture.writeFile(
|
||||
".changeset/add-pkg-a.md",
|
||||
`\
|
||||
---
|
||||
"pkg-a": patch
|
||||
---
|
||||
|
||||
Add pkg-a
|
||||
`,
|
||||
);
|
||||
|
||||
await git(forkRepo, ["add", "."]);
|
||||
await git(forkRepo, ["commit", "-m", "feature"]);
|
||||
await git(forkRepo, ["push", "origin", "feature"]);
|
||||
|
||||
// Run tests
|
||||
const originalHead = await git(checkoutRepo, ["rev-parse", "HEAD"]);
|
||||
const context = {
|
||||
number: 123,
|
||||
base: {
|
||||
ref: "main",
|
||||
repo: {
|
||||
clone_url: pathToFileURL(originBare).toString(),
|
||||
},
|
||||
},
|
||||
head: {
|
||||
ref: "feature",
|
||||
repo: {
|
||||
clone_url: pathToFileURL(forkBare).toString(),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await using worktree = await getPullRequestWorktree(
|
||||
context satisfies PullRequestContext as PullRequestContext,
|
||||
checkoutRepo,
|
||||
);
|
||||
|
||||
const releasePlan = await getReleasePlan(worktree.cwd, worktree.baseRef);
|
||||
|
||||
const currentHead = await git(worktree.cwd, ["rev-parse", "HEAD"]);
|
||||
expect(currentHead).not.toBe(originalHead);
|
||||
|
||||
const currentBranch = await git(worktree.cwd, ["branch", "--show-current"]);
|
||||
expect(currentBranch).toBe("");
|
||||
|
||||
const releases = releasePlan.releases.map((release) => ({
|
||||
name: release.name,
|
||||
type: release.type,
|
||||
newVersion: release.newVersion,
|
||||
}));
|
||||
expect(releases).toEqual([
|
||||
{
|
||||
name: "pkg-a",
|
||||
type: "patch",
|
||||
newVersion: "1.0.1",
|
||||
},
|
||||
]);
|
||||
|
||||
expect(await git(checkoutRepo, ["rev-parse", "HEAD"])).toBe(originalHead);
|
||||
expect(await git(checkoutRepo, ["branch", "--show-current"])).toBe("main");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,150 @@
|
||||
import { randomUUID } from "node:crypto";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import type * as github from "@actions/github";
|
||||
import { isRepoShallow } from "@changesets/git";
|
||||
import { exec } from "tinyexec";
|
||||
import { moveDisposable, type WithAsyncDispose } from "../utils.ts";
|
||||
|
||||
type PullRequestContext = NonNullable<
|
||||
typeof github.context.payload.pull_request
|
||||
>;
|
||||
|
||||
type WorktreeInfo = {
|
||||
baseRef: string;
|
||||
cwd: string;
|
||||
};
|
||||
|
||||
type TinyexecOptions = Parameters<typeof exec>[2];
|
||||
|
||||
function git(cwd: string, args: string[], opts: TinyexecOptions = {}) {
|
||||
return exec("git", args, {
|
||||
nodeOptions: { cwd, ...opts.nodeOptions },
|
||||
throwOnError: true,
|
||||
...opts,
|
||||
});
|
||||
}
|
||||
|
||||
interface Ref {
|
||||
fetchSource: string;
|
||||
local: string;
|
||||
remote: string;
|
||||
}
|
||||
|
||||
function getRefs(context: PullRequestContext): Record<"base" | "head", Ref> {
|
||||
const suffix = `${context.number}-${randomUUID()}`;
|
||||
return {
|
||||
base: {
|
||||
fetchSource: "origin",
|
||||
local: `refs/changesets-action-pr-status/base/${suffix}`,
|
||||
remote: `refs/heads/${context.base.ref}`,
|
||||
},
|
||||
head: {
|
||||
fetchSource: context.head.repo.clone_url,
|
||||
local: `refs/changesets-action-pr-status/head/${suffix}`,
|
||||
remote: `refs/heads/${context.head.ref}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async function deepenRef(cwd: string, ref: Ref, deepenBy: number) {
|
||||
await git(cwd, [
|
||||
"fetch",
|
||||
"--no-tags",
|
||||
`--deepen=${deepenBy}`,
|
||||
ref.fetchSource,
|
||||
`${ref.remote}:${ref.local}`,
|
||||
]);
|
||||
}
|
||||
|
||||
async function ensureMergeBase(args: {
|
||||
cwd: string;
|
||||
refs: ReturnType<typeof getRefs>;
|
||||
deepenBy?: number;
|
||||
}) {
|
||||
const { cwd, refs, deepenBy = 50 } = args;
|
||||
|
||||
while (true) {
|
||||
const mergeBase = await git(cwd, ["merge-base", refs.base.local, "HEAD"], {
|
||||
throwOnError: false,
|
||||
});
|
||||
|
||||
if (mergeBase.exitCode === 0) {
|
||||
return mergeBase.stdout.trim();
|
||||
}
|
||||
|
||||
if (!(await isRepoShallow({ cwd }))) {
|
||||
throw new Error(
|
||||
`Failed to find merge base between "${refs.base.local}" and HEAD, and the repository is no longer shallow.`,
|
||||
);
|
||||
}
|
||||
|
||||
await deepenRef(cwd, refs.base, deepenBy);
|
||||
await deepenRef(cwd, refs.head, deepenBy);
|
||||
}
|
||||
}
|
||||
|
||||
async function mkdtemp(prefix: string) {
|
||||
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
|
||||
|
||||
return {
|
||||
dir,
|
||||
async [Symbol.asyncDispose]() {
|
||||
await fs.rm(dir, { recursive: true, force: true });
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async function tempRef(cwd: string, ref: Ref) {
|
||||
await git(cwd, [
|
||||
"fetch",
|
||||
"--no-tags",
|
||||
"--depth=1",
|
||||
ref.fetchSource,
|
||||
`${ref.remote}:${ref.local}`,
|
||||
]);
|
||||
return {
|
||||
async [Symbol.asyncDispose]() {
|
||||
await git(cwd, ["update-ref", "-d", ref.local], { throwOnError: false });
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async function tempWorktree(cwd: string, dir: string, ref: Ref) {
|
||||
await git(cwd, ["worktree", "add", "--detach", dir, ref.local]);
|
||||
|
||||
return {
|
||||
async [Symbol.asyncDispose]() {
|
||||
await git(cwd, ["worktree", "remove", "--force", dir], {
|
||||
throwOnError: false,
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export async function getPullRequestWorktree(
|
||||
context: PullRequestContext,
|
||||
cwd: string = process.cwd(),
|
||||
): Promise<WithAsyncDispose<WorktreeInfo>> {
|
||||
await using stack = new AsyncDisposableStack();
|
||||
const worktreeDir = stack.use(
|
||||
await mkdtemp("changesets-action-pr-status-"),
|
||||
).dir;
|
||||
|
||||
const refs = getRefs(context);
|
||||
|
||||
stack.use(await tempRef(cwd, refs.base));
|
||||
stack.use(await tempRef(cwd, refs.head));
|
||||
stack.use(await tempWorktree(cwd, worktreeDir, refs.head));
|
||||
|
||||
await ensureMergeBase({
|
||||
cwd: worktreeDir,
|
||||
refs,
|
||||
});
|
||||
|
||||
return moveDisposable(stack, {
|
||||
baseRef: refs.base.local,
|
||||
cwd: worktreeDir,
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import * as core from "@actions/core";
|
||||
import { GitHub } from "../github.ts";
|
||||
import { runPublish } from "../run.ts";
|
||||
import {
|
||||
downloadArtifact,
|
||||
getOptionalInput,
|
||||
getRequiredInput,
|
||||
validateChangesetsCliVersion,
|
||||
} from "../utils.ts";
|
||||
|
||||
try {
|
||||
await main();
|
||||
} catch (err) {
|
||||
core.setFailed((err as Error).message);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
// If the user needs to change the cwd, set `working-directory` in the step instead
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
const githubToken = getRequiredInput("github-token");
|
||||
const script = getOptionalInput("script");
|
||||
const packDirArtifactId = getOptionalInput("pack-dir-artifact-id");
|
||||
const createGithubReleases = core.getBooleanInput("create-github-releases");
|
||||
const pushGitTags = core.getBooleanInput("push-git-tags");
|
||||
|
||||
if (createGithubReleases && !pushGitTags) {
|
||||
throw new Error(
|
||||
"The input 'create-github-releases' is set to true, but 'push-git-tags' is set to false. " +
|
||||
"Creating GitHub releases requires pushing git tags. Please set 'push-git-tags' to true " +
|
||||
"or set 'create-github-releases' to false.",
|
||||
);
|
||||
}
|
||||
|
||||
// The publish sub-action always uses the GitHub API for tag pushes.
|
||||
const github = new GitHub({ cwd, githubToken });
|
||||
|
||||
const fromPackDir = packDirArtifactId
|
||||
? await downloadArtifact(
|
||||
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
|
||||
Number(packDirArtifactId),
|
||||
"changeset-pack",
|
||||
)
|
||||
: undefined;
|
||||
|
||||
const result = await runPublish({
|
||||
script,
|
||||
github,
|
||||
createGithubReleases,
|
||||
pushGitTags,
|
||||
cwd,
|
||||
fromPackDir,
|
||||
});
|
||||
|
||||
if (result.published) {
|
||||
core.setOutput("published", "true");
|
||||
core.setOutput(
|
||||
"published-packages",
|
||||
JSON.stringify(result.publishedPackages),
|
||||
);
|
||||
} else {
|
||||
core.setOutput("published", "false");
|
||||
}
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
throw new Error(
|
||||
`Publish command exited with code ${result.exitCode}${
|
||||
result.published
|
||||
? `, but some packages were published: ${result.publishedPackages
|
||||
.map((p) => `${p.name}@${p.version}`)
|
||||
.join(", ")}`
|
||||
: ""
|
||||
}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import readChangesetState from "./readChangesetState.ts";
|
||||
|
||||
const changeset = `---
|
||||
"pkg-a": patch
|
||||
---
|
||||
|
||||
Fix a bug.
|
||||
`;
|
||||
|
||||
describe("readChangesetState", () => {
|
||||
it("filters versioned changesets in prerelease mode", async () => {
|
||||
await using fixture = await createFixture({
|
||||
".changeset/pre.json": JSON.stringify({ mode: "pre", tag: "next" }),
|
||||
".changeset/pre/versioned.md": changeset,
|
||||
".changeset/pending.md": changeset,
|
||||
});
|
||||
|
||||
const state = await readChangesetState(fixture.path);
|
||||
|
||||
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
|
||||
"pending",
|
||||
]);
|
||||
});
|
||||
|
||||
it("includes versioned changesets when exiting prerelease mode", async () => {
|
||||
await using fixture = await createFixture({
|
||||
".changeset/pre.json": JSON.stringify({ mode: "exit", tag: "next" }),
|
||||
".changeset/pre/versioned.md": changeset,
|
||||
});
|
||||
|
||||
const state = await readChangesetState(fixture.path);
|
||||
|
||||
expect(state.preState).toBeUndefined();
|
||||
expect(state.changesets.map((changeset) => changeset.id)).toEqual([
|
||||
"pre/versioned",
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -1,6 +1,6 @@
|
||||
import { PreState, NewChangeset } from "@changesets/types";
|
||||
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 = {
|
||||
preState: PreState | undefined;
|
||||
@@ -8,17 +8,17 @@ export type ChangesetState = {
|
||||
};
|
||||
|
||||
export default async function readChangesetState(
|
||||
cwd: string = process.cwd()
|
||||
cwd: string = process.cwd(),
|
||||
): Promise<ChangesetState> {
|
||||
let preState = await readPreState(cwd);
|
||||
let changesets = await readChangesets(cwd);
|
||||
|
||||
if (preState !== undefined && preState.mode === "pre") {
|
||||
let changesetsToFilter = new Set(preState.changesets);
|
||||
|
||||
return {
|
||||
preState,
|
||||
changesets: changesets.filter((x) => !changesetsToFilter.has(x.id)),
|
||||
changesets: changesets.filter(
|
||||
(changeset) => !changeset.id.startsWith("pre/"),
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
+270
-68
@@ -1,13 +1,14 @@
|
||||
import { Changeset } from "@changesets/types";
|
||||
import writeChangeset from "@changesets/write";
|
||||
import fixturez from "fixturez";
|
||||
import fs from "fs-extra";
|
||||
import path from "path";
|
||||
import { Git } from "./git";
|
||||
import { setupOctokit } from "./octokit";
|
||||
import { runVersion } from "./run";
|
||||
import path from "node:path";
|
||||
import * as core from "@actions/core";
|
||||
import type { Changeset } from "@changesets/types";
|
||||
import { writeChangeset } from "@changesets/write";
|
||||
import { createFixture } from "fs-fixture";
|
||||
import { exec } from "tinyexec";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { GitHub } from "./github.ts";
|
||||
import { runPublish, runVersion } from "./run.ts";
|
||||
|
||||
jest.mock("@actions/github", () => ({
|
||||
vi.mock("@actions/github", () => ({
|
||||
context: {
|
||||
repo: {
|
||||
owner: "changesets",
|
||||
@@ -16,53 +17,161 @@ jest.mock("@actions/github", () => ({
|
||||
ref: "refs/heads/some-branch",
|
||||
sha: "xeac7",
|
||||
},
|
||||
}));
|
||||
jest.mock("@actions/github/lib/utils", () => ({
|
||||
GitHub: {
|
||||
plugin: () => {
|
||||
// function necessary to be used as constructor
|
||||
return function () {
|
||||
return {
|
||||
getOctokit: () => ({
|
||||
rest: mockedGithubMethods,
|
||||
};
|
||||
};
|
||||
},
|
||||
},
|
||||
getOctokitOptions: jest.fn(),
|
||||
graphql: mockedGraphql,
|
||||
}),
|
||||
}));
|
||||
jest.mock("./git");
|
||||
jest.mock("@changesets/ghcommit/git");
|
||||
vi.mock("@actions/core", { spy: true });
|
||||
const mockedWarning = vi.mocked(core.warning);
|
||||
vi.mock("@changesets/ghcommit");
|
||||
|
||||
let mockedGithubMethods = {
|
||||
pulls: {
|
||||
create: jest.fn(),
|
||||
list: jest.fn(),
|
||||
create: vi.fn(),
|
||||
list: vi.fn(),
|
||||
},
|
||||
repos: {
|
||||
createRelease: jest.fn(),
|
||||
createRelease: vi.fn(),
|
||||
},
|
||||
};
|
||||
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/*"],
|
||||
}),
|
||||
"package-lock.json": "",
|
||||
});
|
||||
}
|
||||
|
||||
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/*"],
|
||||
}),
|
||||
"package-lock.json": "",
|
||||
});
|
||||
}
|
||||
|
||||
const linkNodeModules = async (cwd: string) => {
|
||||
await fs.symlink(
|
||||
path.join(__dirname, "..", "node_modules"),
|
||||
path.join(cwd, "node_modules")
|
||||
);
|
||||
};
|
||||
const writeChangesets = (changesets: Changeset[], cwd: string) => {
|
||||
return Promise.all(changesets.map((commit) => writeChangeset(commit, cwd)));
|
||||
};
|
||||
|
||||
const createGithub = (cwd: string) =>
|
||||
new GitHub({
|
||||
cwd,
|
||||
githubToken: "@@GITHUB_TOKEN",
|
||||
pushWithGitCli: false,
|
||||
});
|
||||
|
||||
async function initializeGitRepository(cwd: string) {
|
||||
await exec("git", ["init"], {
|
||||
nodeOptions: { cwd },
|
||||
throwOnError: true,
|
||||
});
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
describe("publish", () => {
|
||||
it("warns when a custom publish script does not create the output file", async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
await initializeGitRepository(cwd);
|
||||
vi.stubEnv("RUNNER_TEMP", cwd);
|
||||
|
||||
const result = await runPublish({
|
||||
script: 'node -e "void 0"',
|
||||
github: createGithub(cwd),
|
||||
createGithubReleases: true,
|
||||
pushGitTags: true,
|
||||
cwd,
|
||||
});
|
||||
|
||||
expect(result).toEqual({ published: false, exitCode: 0 });
|
||||
expect(mockedWarning).toHaveBeenCalledWith(
|
||||
expect.stringContaining(
|
||||
"GitHub releases and git tags cannot be created without this output",
|
||||
),
|
||||
);
|
||||
});
|
||||
|
||||
it("throws when the built-in publish command does not create the output file", async () => {
|
||||
await using fixture = await createFixture({
|
||||
"node_modules/@changesets/cli/package.json": JSON.stringify({
|
||||
name: "@changesets/cli",
|
||||
type: "module",
|
||||
}),
|
||||
"node_modules/@changesets/cli/bin.js": "",
|
||||
"package.json": JSON.stringify({
|
||||
name: "simple-project",
|
||||
version: "1.0.0",
|
||||
}),
|
||||
"package-lock.json": "",
|
||||
});
|
||||
const cwd = fixture.path;
|
||||
await initializeGitRepository(cwd);
|
||||
vi.stubEnv("RUNNER_TEMP", cwd);
|
||||
|
||||
await expect(
|
||||
runPublish({
|
||||
github: createGithub(cwd),
|
||||
createGithubReleases: true,
|
||||
pushGitTags: true,
|
||||
cwd,
|
||||
}),
|
||||
).rejects.toThrow("Failed to read changesets output at");
|
||||
});
|
||||
});
|
||||
|
||||
describe("version", () => {
|
||||
it("creates simple PR", async () => {
|
||||
let cwd = f.copy("simple-project");
|
||||
linkNodeModules(cwd);
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -75,32 +184,31 @@ describe("version", () => {
|
||||
{
|
||||
releases: [
|
||||
{
|
||||
name: "simple-project-pkg-a",
|
||||
name: "changesets-dev-simple-project-pkg-a",
|
||||
type: "minor",
|
||||
},
|
||||
{
|
||||
name: "simple-project-pkg-b",
|
||||
name: "changesets-dev-simple-project-pkg-b",
|
||||
type: "minor",
|
||||
},
|
||||
],
|
||||
summary: "Awesome feature",
|
||||
},
|
||||
],
|
||||
cwd
|
||||
cwd,
|
||||
);
|
||||
|
||||
await runVersion({
|
||||
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||
git: new Git(),
|
||||
github: createGithub(cwd),
|
||||
cwd,
|
||||
});
|
||||
|
||||
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("only includes bumped packages in the PR body", async () => {
|
||||
let cwd = f.copy("simple-project");
|
||||
linkNodeModules(cwd);
|
||||
it('creates a draft PR when prDraft is "create"', async () => {
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -113,19 +221,52 @@ describe("version", () => {
|
||||
{
|
||||
releases: [
|
||||
{
|
||||
name: "simple-project-pkg-a",
|
||||
name: "changesets-dev-simple-project-pkg-a",
|
||||
type: "minor",
|
||||
},
|
||||
],
|
||||
summary: "Awesome feature",
|
||||
},
|
||||
],
|
||||
cwd
|
||||
cwd,
|
||||
);
|
||||
|
||||
await runVersion({
|
||||
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||
git: new Git(),
|
||||
github: createGithub(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({
|
||||
github: createGithub(cwd),
|
||||
cwd,
|
||||
});
|
||||
|
||||
@@ -133,8 +274,8 @@ describe("version", () => {
|
||||
});
|
||||
|
||||
it("doesn't include ignored package that got a dependency update in the PR body", async () => {
|
||||
let cwd = f.copy("ignored-package");
|
||||
linkNodeModules(cwd);
|
||||
await using fixture = await createIgnoredPackageFixture();
|
||||
const cwd = fixture.path;
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -147,19 +288,18 @@ describe("version", () => {
|
||||
{
|
||||
releases: [
|
||||
{
|
||||
name: "ignored-package-pkg-b",
|
||||
name: "changesets-dev-ignored-package-pkg-b",
|
||||
type: "minor",
|
||||
},
|
||||
],
|
||||
summary: "Awesome feature",
|
||||
},
|
||||
],
|
||||
cwd
|
||||
cwd,
|
||||
);
|
||||
|
||||
await runVersion({
|
||||
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||
git: new Git(),
|
||||
github: createGithub(cwd),
|
||||
cwd,
|
||||
});
|
||||
|
||||
@@ -167,8 +307,8 @@ describe("version", () => {
|
||||
});
|
||||
|
||||
it("does not include changelog entries if full message exceeds size limit", async () => {
|
||||
let cwd = f.copy("simple-project");
|
||||
linkNodeModules(cwd);
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -181,7 +321,7 @@ describe("version", () => {
|
||||
{
|
||||
releases: [
|
||||
{
|
||||
name: "simple-project-pkg-a",
|
||||
name: "changesets-dev-simple-project-pkg-a",
|
||||
type: "minor",
|
||||
},
|
||||
],
|
||||
@@ -208,25 +348,24 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
`,
|
||||
},
|
||||
],
|
||||
cwd
|
||||
cwd,
|
||||
);
|
||||
|
||||
await runVersion({
|
||||
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||
git: new Git(),
|
||||
github: createGithub(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/
|
||||
/The changelog information of each package has been omitted from this message/,
|
||||
);
|
||||
});
|
||||
|
||||
it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
|
||||
let cwd = f.copy("simple-project");
|
||||
linkNodeModules(cwd);
|
||||
await using fixture = await createSimpleProjectFixture();
|
||||
const cwd = fixture.path;
|
||||
|
||||
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
|
||||
|
||||
@@ -239,7 +378,7 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
{
|
||||
releases: [
|
||||
{
|
||||
name: "simple-project-pkg-a",
|
||||
name: "changesets-dev-simple-project-pkg-a",
|
||||
type: "minor",
|
||||
},
|
||||
],
|
||||
@@ -266,19 +405,82 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
|
||||
`,
|
||||
},
|
||||
],
|
||||
cwd
|
||||
cwd,
|
||||
);
|
||||
|
||||
await runVersion({
|
||||
octokit: setupOctokit("@@GITHUB_TOKEN"),
|
||||
git: new Git(),
|
||||
github: createGithub(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/
|
||||
/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({
|
||||
github: createGithub(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({
|
||||
github: createGithub(cwd),
|
||||
cwd,
|
||||
prDraft: "always",
|
||||
});
|
||||
|
||||
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
||||
+247
-131
@@ -1,21 +1,29 @@
|
||||
import { randomUUID } from "node:crypto";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import * as core from "@actions/core";
|
||||
import { exec, getExecOutput } from "@actions/exec";
|
||||
import * as github from "@actions/github";
|
||||
import { PreState } from "@changesets/types";
|
||||
import { Package, getPackages } from "@manypkg/get-packages";
|
||||
import fs from "fs-extra";
|
||||
import path from "path";
|
||||
import resolveFrom from "resolve-from";
|
||||
import * as semver from "semver";
|
||||
import { Git } from "./git";
|
||||
import { Octokit } from "./octokit";
|
||||
import readChangesetState from "./readChangesetState";
|
||||
import {
|
||||
exec,
|
||||
getExecOutput,
|
||||
type ExecOptions,
|
||||
type ExecOutput,
|
||||
} from "@actions/exec";
|
||||
import { context } from "@actions/github";
|
||||
import type { PreState } from "@changesets/types";
|
||||
import { type Package, getPackages } from "@manypkg/get-packages";
|
||||
import type { GitHub } from "./github.ts";
|
||||
import type { Octokit } from "./octokit.ts";
|
||||
import readChangesetState from "./readChangesetState.ts";
|
||||
import {
|
||||
execChangesetsCli,
|
||||
getChangedPackages,
|
||||
getChangelogEntry,
|
||||
getExecOutputChangesetsCli,
|
||||
getVersionsByDirectory,
|
||||
isErrorWithCode,
|
||||
sortTheThings,
|
||||
} from "./utils";
|
||||
} from "./utils.ts";
|
||||
|
||||
// GitHub Issues/PRs messages have a max size limit on the
|
||||
// message body payload.
|
||||
@@ -25,19 +33,24 @@ const MAX_CHARACTERS_PER_MESSAGE = 60000;
|
||||
|
||||
const createRelease = async (
|
||||
octokit: Octokit,
|
||||
{ pkg, tagName }: { pkg: Package; tagName: string }
|
||||
{ pkg, tagName }: { pkg: Package; tagName: string },
|
||||
) => {
|
||||
let changelog;
|
||||
try {
|
||||
let changelogFileName = path.join(pkg.dir, "CHANGELOG.md");
|
||||
|
||||
let changelog = await fs.readFile(changelogFileName, "utf8");
|
||||
|
||||
changelog = await fs.readFile(path.join(pkg.dir, "CHANGELOG.md"), "utf8");
|
||||
} catch (err) {
|
||||
if (isErrorWithCode(err, "ENOENT")) {
|
||||
// if we can't find a changelog, the user has probably disabled changelogs
|
||||
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}`
|
||||
`Could not find changelog entry for ${pkg.packageJson.name}@${pkg.packageJson.version}`,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -46,143 +59,206 @@ const createRelease = async (
|
||||
tag_name: tagName,
|
||||
body: changelogEntry.content,
|
||||
prerelease: pkg.packageJson.version.includes("-"),
|
||||
...github.context.repo,
|
||||
...context.repo,
|
||||
});
|
||||
} catch (err) {
|
||||
// if we can't find a changelog, the user has probably disabled changelogs
|
||||
if (
|
||||
err &&
|
||||
typeof err === "object" &&
|
||||
"code" in err &&
|
||||
err.code !== "ENOENT"
|
||||
) {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
type PublishOptions = {
|
||||
script: string;
|
||||
octokit: Octokit;
|
||||
script?: string;
|
||||
fromPackDir?: string;
|
||||
createGithubReleases: boolean;
|
||||
git: Git;
|
||||
cwd?: string;
|
||||
pushGitTags: boolean;
|
||||
github: GitHub;
|
||||
cwd: string;
|
||||
};
|
||||
|
||||
type PublishedPackage = { name: string; version: string };
|
||||
type ChangesetsOutputEvent = {
|
||||
type: "git-tag";
|
||||
tag: string;
|
||||
packageName: string;
|
||||
};
|
||||
|
||||
class ChangesetsOutputReadError extends Error {}
|
||||
|
||||
type PublishResult =
|
||||
| {
|
||||
published: true;
|
||||
publishedPackages: PublishedPackage[];
|
||||
exitCode: number;
|
||||
}
|
||||
| {
|
||||
published: false;
|
||||
exitCode: number;
|
||||
};
|
||||
|
||||
function isObject(value: unknown) {
|
||||
return typeof value === "object" && value !== null;
|
||||
}
|
||||
|
||||
function isChangesetsOutputEvent(
|
||||
value: unknown,
|
||||
): value is ChangesetsOutputEvent {
|
||||
return (
|
||||
isObject(value) &&
|
||||
"type" in value &&
|
||||
value.type === "git-tag" &&
|
||||
"tag" in value &&
|
||||
typeof value.tag === "string" &&
|
||||
"packageName" in value &&
|
||||
typeof value.packageName === "string"
|
||||
);
|
||||
}
|
||||
|
||||
async function readChangesetsOutput(outputPath: string) {
|
||||
let rawOutput: string;
|
||||
try {
|
||||
rawOutput = await fs.readFile(outputPath, "utf8");
|
||||
} catch (err) {
|
||||
throw new ChangesetsOutputReadError(
|
||||
`Failed to read changesets output at ${outputPath}`,
|
||||
{ cause: err },
|
||||
);
|
||||
}
|
||||
|
||||
const events: ChangesetsOutputEvent[] = [];
|
||||
|
||||
let lineStart = 0;
|
||||
while (lineStart <= rawOutput.length) {
|
||||
let lineEnd = rawOutput.indexOf("\n", lineStart);
|
||||
if (lineEnd === -1) {
|
||||
lineEnd = rawOutput.length;
|
||||
}
|
||||
const line = rawOutput.slice(lineStart, lineEnd);
|
||||
lineStart = lineEnd + 1;
|
||||
|
||||
if (/^\s*$/.test(line)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
let event: unknown;
|
||||
try {
|
||||
event = JSON.parse(line);
|
||||
} catch (err) {
|
||||
throw new Error(`Failed to parse changesets output event: ${line}`, {
|
||||
cause: err,
|
||||
});
|
||||
}
|
||||
|
||||
if (!isChangesetsOutputEvent(event)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
events.push(event);
|
||||
}
|
||||
|
||||
return events;
|
||||
}
|
||||
|
||||
export async function runPublish({
|
||||
script,
|
||||
git,
|
||||
octokit,
|
||||
fromPackDir,
|
||||
github,
|
||||
createGithubReleases,
|
||||
cwd = process.cwd(),
|
||||
pushGitTags,
|
||||
cwd,
|
||||
}: PublishOptions): Promise<PublishResult> {
|
||||
let [publishCommand, ...publishArgs] = script.split(/\s+/);
|
||||
const { octokit } = github;
|
||||
// Changesets creates annotated tags locally, including when the action pushes those tags through the GitHub API.
|
||||
// It might also be important for custom publish scripts to have a valid git user configured.
|
||||
await github.ensureGitUser();
|
||||
|
||||
let changesetPublishOutput = await getExecOutput(
|
||||
publishCommand,
|
||||
publishArgs,
|
||||
{ cwd }
|
||||
let changesetPublishOutput: ExecOutput;
|
||||
const outputFile = path.join(
|
||||
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
|
||||
`changesets-output-${randomUUID()}.ndjson`,
|
||||
);
|
||||
const execOptions: ExecOptions = {
|
||||
cwd,
|
||||
ignoreReturnCode: true,
|
||||
env: {
|
||||
...process.env,
|
||||
GITHUB_TOKEN: github.getToken(),
|
||||
CHANGESETS_OUTPUT: outputFile,
|
||||
},
|
||||
};
|
||||
|
||||
if (script) {
|
||||
changesetPublishOutput = await getExecOutput(
|
||||
script,
|
||||
undefined,
|
||||
execOptions,
|
||||
);
|
||||
} else {
|
||||
const args = ["publish"];
|
||||
if (fromPackDir) {
|
||||
args.push("--from-pack-dir", fromPackDir);
|
||||
}
|
||||
changesetPublishOutput = await getExecOutputChangesetsCli(
|
||||
args,
|
||||
execOptions,
|
||||
);
|
||||
}
|
||||
|
||||
let { packages, tool } = await getPackages(cwd);
|
||||
let releasedPackages: Package[] = [];
|
||||
|
||||
if (tool !== "root") {
|
||||
let newTagRegex = /New tag:\s+(@[^/]+\/[^@]+|[^/]+)@([^\s]+)/;
|
||||
let packagesByName = new Map(packages.map((x) => [x.packageJson.name, x]));
|
||||
|
||||
for (let line of changesetPublishOutput.stdout.split("\n")) {
|
||||
let match = line.match(newTagRegex);
|
||||
if (match === null) {
|
||||
continue;
|
||||
let output: ChangesetsOutputEvent[];
|
||||
try {
|
||||
output = await readChangesetsOutput(outputFile);
|
||||
} catch (err) {
|
||||
if (!script || !(err instanceof ChangesetsOutputReadError)) {
|
||||
throw err;
|
||||
}
|
||||
let pkgName = match[1];
|
||||
let pkg = packagesByName.get(pkgName);
|
||||
core.warning(
|
||||
`${err.message}. GitHub releases and git tags cannot be created without this output. Ensure the custom publish script passes CHANGESETS_OUTPUT to the Changesets CLI.`,
|
||||
);
|
||||
output = [];
|
||||
}
|
||||
let releases = output.map((event) => {
|
||||
let pkg = packagesByName.get(event.packageName);
|
||||
if (pkg === undefined) {
|
||||
throw new Error(
|
||||
`Package "${pkgName}" not found.` +
|
||||
"This is probably a bug in the action, please open an issue"
|
||||
`Package "${event.packageName}" not found.` +
|
||||
"This is probably a bug in the action, please open an issue",
|
||||
);
|
||||
}
|
||||
releasedPackages.push(pkg);
|
||||
}
|
||||
return { pkg, tag: event.tag };
|
||||
});
|
||||
|
||||
if (createGithubReleases) {
|
||||
await Promise.all(
|
||||
releasedPackages.map(async (pkg) => {
|
||||
const tagName = `${pkg.packageJson.name}@${pkg.packageJson.version}`;
|
||||
await git.pushTag(tagName);
|
||||
await createRelease(octokit, { pkg, tagName });
|
||||
})
|
||||
);
|
||||
}
|
||||
} else {
|
||||
if (packages.length === 0) {
|
||||
if (tool.type === "root" && packages.length === 0) {
|
||||
throw new Error(
|
||||
`No package found.` +
|
||||
"This is probably a bug in the action, please open an issue"
|
||||
"This is probably a bug in the action, please open an issue",
|
||||
);
|
||||
}
|
||||
let pkg = packages[0];
|
||||
let newTagRegex = /New tag:/;
|
||||
|
||||
for (let line of changesetPublishOutput.stdout.split("\n")) {
|
||||
let match = line.match(newTagRegex);
|
||||
|
||||
if (match) {
|
||||
releasedPackages.push(pkg);
|
||||
if (createGithubReleases || pushGitTags) {
|
||||
await Promise.all(
|
||||
releases.map(async ({ pkg, tag }) => {
|
||||
if (pushGitTags) {
|
||||
await github.pushTag(tag);
|
||||
}
|
||||
if (createGithubReleases) {
|
||||
const tagName = `v${pkg.packageJson.version}`;
|
||||
await git.pushTag(tagName);
|
||||
await createRelease(octokit, { pkg, tagName });
|
||||
}
|
||||
break;
|
||||
}
|
||||
await createRelease(octokit, { pkg, tagName: tag });
|
||||
}
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
if (releasedPackages.length) {
|
||||
if (releases.length) {
|
||||
return {
|
||||
published: true,
|
||||
publishedPackages: releasedPackages.map((pkg) => ({
|
||||
publishedPackages: releases.map(({ pkg }) => ({
|
||||
name: pkg.packageJson.name,
|
||||
version: pkg.packageJson.version,
|
||||
})),
|
||||
exitCode: changesetPublishOutput.exitCode,
|
||||
};
|
||||
}
|
||||
|
||||
return { published: false };
|
||||
return { published: false, exitCode: changesetPublishOutput.exitCode };
|
||||
}
|
||||
|
||||
const requireChangesetsCliPkgJson = (cwd: string) => {
|
||||
try {
|
||||
return require(resolveFrom(cwd, "@changesets/cli/package.json"));
|
||||
} catch (err) {
|
||||
if (
|
||||
err &&
|
||||
typeof err === "object" &&
|
||||
"code" in err &&
|
||||
err.code === "MODULE_NOT_FOUND"
|
||||
) {
|
||||
throw new Error(
|
||||
`Have you forgotten to install \`@changesets/cli\` in "${cwd}"?`
|
||||
);
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
};
|
||||
|
||||
type GetMessageOptions = {
|
||||
hasPublishScript: boolean;
|
||||
branch: string;
|
||||
@@ -254,13 +330,13 @@ export async function getVersionPrBody({
|
||||
|
||||
type VersionOptions = {
|
||||
script?: string;
|
||||
git: Git;
|
||||
octokit: Octokit;
|
||||
github: GitHub;
|
||||
cwd?: string;
|
||||
prTitle?: string;
|
||||
commitMessage?: string;
|
||||
hasPublishScript?: boolean;
|
||||
prBodyMaxCharacters?: number;
|
||||
prDraft?: "always" | "create";
|
||||
branch?: string;
|
||||
};
|
||||
|
||||
@@ -270,34 +346,30 @@ type RunVersionResult = {
|
||||
|
||||
export async function runVersion({
|
||||
script,
|
||||
git,
|
||||
octokit,
|
||||
github,
|
||||
cwd = process.cwd(),
|
||||
prTitle = "Version Packages",
|
||||
commitMessage = "Version Packages",
|
||||
hasPublishScript = false,
|
||||
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
|
||||
branch = github.context.ref.replace("refs/heads/", ""),
|
||||
branch = context.ref.replace("refs/heads/", ""),
|
||||
prDraft,
|
||||
}: VersionOptions): Promise<RunVersionResult> {
|
||||
const { octokit } = github;
|
||||
let versionBranch = `changeset-release/${branch}`;
|
||||
|
||||
let { preState } = await readChangesetState(cwd);
|
||||
|
||||
await git.prepareBranch(versionBranch);
|
||||
await github.prepareBranch(versionBranch);
|
||||
|
||||
let versionsByDirectory = await getVersionsByDirectory(cwd);
|
||||
|
||||
const env = { ...process.env, GITHUB_TOKEN: github.getToken() };
|
||||
|
||||
if (script) {
|
||||
let [versionCommand, ...versionArgs] = script.split(/\s+/);
|
||||
await exec(versionCommand, versionArgs, { cwd });
|
||||
await exec(script, undefined, { cwd, env });
|
||||
} 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,
|
||||
});
|
||||
await execChangesetsCli(["version"], { cwd, env });
|
||||
}
|
||||
|
||||
let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
|
||||
@@ -305,7 +377,7 @@ export async function runVersion({
|
||||
changedPackages.map(async (pkg) => {
|
||||
let changelogContents = await fs.readFile(
|
||||
path.join(pkg.dir, "CHANGELOG.md"),
|
||||
"utf8"
|
||||
"utf8",
|
||||
);
|
||||
|
||||
let entry = getChangelogEntry(changelogContents, pkg.packageJson.version);
|
||||
@@ -315,7 +387,7 @@ export async function runVersion({
|
||||
content: entry.content,
|
||||
header: `## ${pkg.packageJson.name}@${pkg.packageJson.version}`,
|
||||
};
|
||||
})
|
||||
}),
|
||||
);
|
||||
|
||||
const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;
|
||||
@@ -323,15 +395,24 @@ export async function runVersion({
|
||||
!!preState ? ` (${preState.tag})` : ""
|
||||
}`;
|
||||
|
||||
await git.pushChanges({ branch: versionBranch, message: finalCommitMessage });
|
||||
|
||||
let existingPullRequests = await octokit.rest.pulls.list({
|
||||
...github.context.repo,
|
||||
const existingPullRequests = await octokit.rest.pulls.list({
|
||||
...context.repo,
|
||||
state: "open",
|
||||
head: `${github.context.repo.owner}:${versionBranch}`,
|
||||
head: `${context.repo.owner}:${versionBranch}`,
|
||||
base: branch,
|
||||
});
|
||||
core.info(JSON.stringify(existingPullRequests.data, null, 2));
|
||||
core.info(
|
||||
`Existing pull requests: ${JSON.stringify(
|
||||
existingPullRequests.data,
|
||||
null,
|
||||
2,
|
||||
)}`,
|
||||
);
|
||||
|
||||
await github.pushChanges({
|
||||
branch: versionBranch,
|
||||
message: finalCommitMessage,
|
||||
});
|
||||
|
||||
const changedPackagesInfo = (await changedPackagesInfoPromises)
|
||||
.filter((x) => x)
|
||||
@@ -352,7 +433,8 @@ export async function runVersion({
|
||||
head: versionBranch,
|
||||
title: finalPrTitle,
|
||||
body: prBody,
|
||||
...github.context.repo,
|
||||
draft: prDraft !== undefined,
|
||||
...context.repo,
|
||||
});
|
||||
|
||||
return {
|
||||
@@ -362,12 +444,46 @@ export async function runVersion({
|
||||
const [pullRequest] = existingPullRequests.data;
|
||||
|
||||
core.info(`updating found pull request #${pullRequest.number}`);
|
||||
await octokit.rest.pulls.update({
|
||||
pull_number: 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,
|
||||
body: prBody,
|
||||
...github.context.repo,
|
||||
state: "open",
|
||||
});
|
||||
|
||||
return {
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import artifact from "@actions/artifact";
|
||||
import * as core from "@actions/core";
|
||||
import readChangesetState from "../readChangesetState.ts";
|
||||
import { execChangesetsCli, validateChangesetsCliVersion } from "../utils.ts";
|
||||
|
||||
type ModeResult =
|
||||
| {
|
||||
mode: "none";
|
||||
}
|
||||
| {
|
||||
mode: "version";
|
||||
}
|
||||
| {
|
||||
mode: "publish";
|
||||
publishPlanPath: string;
|
||||
};
|
||||
|
||||
type PublishPlan = unknown[];
|
||||
|
||||
try {
|
||||
await main();
|
||||
} catch (err) {
|
||||
core.setFailed((err as Error).message);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const cwd = process.cwd();
|
||||
await validateChangesetsCliVersion(cwd);
|
||||
|
||||
const result = await getMode(cwd);
|
||||
core.setOutput("mode", result.mode);
|
||||
if (result.mode === "publish") {
|
||||
const publishPlanArtifact = await artifact.uploadArtifact(
|
||||
path.basename(result.publishPlanPath, ".json"),
|
||||
[result.publishPlanPath],
|
||||
path.dirname(result.publishPlanPath),
|
||||
{
|
||||
skipArchive: true,
|
||||
retentionDays: 30,
|
||||
},
|
||||
);
|
||||
if (publishPlanArtifact.id === undefined) {
|
||||
throw new Error(
|
||||
"Publish plan artifact upload did not return an artifact id",
|
||||
);
|
||||
}
|
||||
core.setOutput("publish-plan-artifact-id", String(publishPlanArtifact.id));
|
||||
}
|
||||
}
|
||||
|
||||
async function getMode(cwd: string): Promise<ModeResult> {
|
||||
const { changesets } = await readChangesetState(cwd);
|
||||
|
||||
if (changesets.length > 0) {
|
||||
const hasNonEmptyChangesets = changesets.some(
|
||||
(changeset) => changeset.releases.length > 0,
|
||||
);
|
||||
if (hasNonEmptyChangesets) {
|
||||
return { mode: "version" };
|
||||
}
|
||||
return { mode: "none" };
|
||||
}
|
||||
|
||||
const publishPlanPath = path.join(
|
||||
process.env.RUNNER_TEMP ?? (await fs.realpath(os.tmpdir())),
|
||||
`changeset-publish-plan-${Date.now()}`,
|
||||
// we need a stable filename here (in a unique dirname) so the artifact download can find this cleanly
|
||||
"publish-plan.json",
|
||||
);
|
||||
await execChangesetsCli(["publish-plan", "--output", publishPlanPath], {
|
||||
cwd,
|
||||
env: process.env,
|
||||
});
|
||||
|
||||
const publishPlan = await readPublishPlan(publishPlanPath);
|
||||
if (publishPlan.length === 0) {
|
||||
return { mode: "none" };
|
||||
}
|
||||
|
||||
return {
|
||||
mode: "publish",
|
||||
publishPlanPath,
|
||||
};
|
||||
}
|
||||
|
||||
async function readPublishPlan(publishPlanPath: string): Promise<PublishPlan> {
|
||||
let rawPlan: string;
|
||||
try {
|
||||
rawPlan = await fs.readFile(publishPlanPath, "utf8");
|
||||
} catch (err) {
|
||||
throw new Error(`Failed to read publish plan at ${publishPlanPath}`, {
|
||||
cause: err,
|
||||
});
|
||||
}
|
||||
|
||||
let plan: unknown;
|
||||
try {
|
||||
plan = JSON.parse(rawPlan);
|
||||
} catch (err) {
|
||||
throw new Error(`Failed to parse publish plan at ${publishPlanPath}`, {
|
||||
cause: err,
|
||||
});
|
||||
}
|
||||
|
||||
if (
|
||||
typeof plan !== "object" ||
|
||||
plan === null ||
|
||||
!("version" in plan) ||
|
||||
typeof plan.version !== "number" ||
|
||||
!("plan" in plan) ||
|
||||
!Array.isArray(plan.plan)
|
||||
) {
|
||||
throw new Error(
|
||||
`Invalid publish plan at ${publishPlanPath}: expected { version: number; plan: unknown[] }`,
|
||||
);
|
||||
}
|
||||
return plan.plan;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user