Compare commits

...
7 Commits
Author SHA1 Message Date
github-actions[bot] 63a615b9cd v1.8.0 2026-05-07 09:48:08 +00:00
github-actions[bot]andMateusz Burzyński 84c24326ac Version Packages (#598)
* Version Packages

* add missing PR reference

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-07 09:43:16 +00:00
f5dbf72f96 Add draft mode support (#258)
* Add draft mode support

* Add doc

* fmt

* add it to action.yml

* fix bad merge?

* tweak changeset

* refactor

---------

Co-authored-by: Emma Hamilton <mitchell@hamil.town>
Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2026-05-07 11:35:24 +02:00
Mateusz Burzyński 91b911142e Protect publishes with env gate (#610)
* Protect publishes with env gate

* tweak CODEOWNERS and release-pr

* remove redundant permission

* fix syntax

* Use app with protection bypass for publishing

* handle forks better

* remove redundant permission
2026-05-07 09:16:30 +00:00
Mateusz Burzyński d4c53c2943 Fix CODEOWNERS pattern 2026-04-03 10:49:07 +02:00
Mateusz Burzyński 2ae596f3dd Tweak CI setup (#599) 2026-04-01 09:17:56 +02:00
Mateusz Burzyński 0784b0ec8f Add CODEOWNERS 2026-04-01 09:00:07 +02:00
17 changed files with 536 additions and 60 deletions
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Fixed initial `.changeset` state being picked up, when `cwd` parameter is provided
-5
View File
@@ -1,5 +0,0 @@
---
"@changesets/action": patch
---
Fixed `.changeset` state being picked for the version command when `cwd` parameter is provided
+5
View File
@@ -0,0 +1,5 @@
/.github/workflows/** @Andarist @emmatown
/action.yml @Andarist @emmatown
/scripts/bump.ts @Andarist @emmatown
/scripts/release.ts @Andarist @emmatown
/scripts/release-pr.ts @Andarist @emmatown
+1 -1
View File
@@ -4,7 +4,7 @@ runs:
using: composite using: composite
steps: steps:
- name: Setup Node.js - name: Setup Node.js
uses: actions/setup-node@v6 uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
with: with:
node-version-file: ".node-version" node-version-file: ".node-version"
cache: yarn cache: yarn
+31 -11
View File
@@ -1,26 +1,46 @@
name: Node CI name: CI
on: on:
push:
branches:
- main
pull_request: pull_request:
push:
branches: [main]
merge_group:
branches: [main]
permissions:
contents: read
jobs: jobs:
build: test:
name: Test
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with: - uses: ./.github/actions/ci-setup
ref: ${{ github.event.pull_request.head.sha }}
- name: Test
run: yarn test
typecheck:
name: Typecheck
timeout-minutes: 20
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
- name: Typecheck - name: Typecheck
run: yarn typecheck run: yarn typecheck
- name: Test ci-ok:
run: yarn test name: CI OK
runs-on: ubuntu-latest
if: always()
needs: [test, typecheck]
steps:
- name: Exit with error if some jobs are not successful
run: exit 1
if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'skipped') || contains(needs.*.result, 'cancelled')) }}
+62
View File
@@ -0,0 +1,62 @@
name: Publish
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
permissions: {} # each job should define its own permission explicitly
jobs:
version:
name: Version
runs-on: ubuntu-latest
timeout-minutes: 20
outputs:
hasChangesets: ${{ steps.changesets.outputs.hasChangesets }}
permissions:
contents: write # to create release (changesets/action)
issues: write # to post issue comments (changesets/action)
pull-requests: write # to create pull request (changesets/action)
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./.github/actions/ci-setup
- name: Build
run: yarn build
- name: Create or update release pull request
id: changesets
uses: ./
with:
version: yarn bump
publish:
name: Publish
if: needs.version.outputs.hasChangesets == 'false'
needs: version
runs-on: ubuntu-latest
environment: marketplace
timeout-minutes: 20
steps:
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
token: ${{ steps.app-token.outputs.token }}
- uses: ./.github/actions/ci-setup
- name: Build
run: yarn build
- name: Publish to marketplace
uses: ./
with:
publish: yarn release
+87 -6
View File
@@ -4,10 +4,16 @@ on:
issue_comment: issue_comment:
types: [created] types: [created]
permissions: {}
jobs: jobs:
release_check: release_check:
if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr') if: github.repository == 'changesets/action' && github.event.issue.pull_request && startsWith(github.event.comment.body, '/release-pr')
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: read
issues: write
pull-requests: read
steps: steps:
- id: report_in_progress - id: report_in_progress
run: | run: |
@@ -15,6 +21,18 @@ jobs:
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- 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 - id: check_authorization
run: | run: |
if [[ $AUTHOR_ASSOCIATION == 'MEMBER' || $AUTHOR_ASSOCIATION == 'OWNER' || $AUTHOR_ASSOCIATION == 'COLLABORATOR' ]] if [[ $AUTHOR_ASSOCIATION == 'MEMBER' || $AUTHOR_ASSOCIATION == 'OWNER' || $AUTHOR_ASSOCIATION == 'COLLABORATOR' ]]
@@ -27,22 +45,80 @@ jobs:
env: env:
AUTHOR_ASSOCIATION: ${{ github.event.comment.author_association }} 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/${{ github.repository }}/pulls/${{ github.event.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 ${{ github.event.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 }}
REQUESTED_SHA: ${{ steps.parse_command.outputs.requested_sha }}
- id: get_pr_head_repository
run: |
echo "head_repository=$(gh pr view ${{ github.event.issue.number }} --json headRepositoryOwner,headRepository --jq '.headRepositoryOwner.login + "/" + .headRepository.name')" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
outputs: outputs:
in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }} in_progress_reaction_id: ${{ steps.report_in_progress.outputs.in_progress_reaction_id }}
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: release:
if: github.repository == 'changesets/action' if: github.repository == 'changesets/action'
timeout-minutes: 20 timeout-minutes: 20
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: release_check needs: release_check
permissions:
contents: write
issues: write
pull-requests: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./.github/actions/ci-setup - uses: ./.github/actions/ci-setup
- name: Checkout pull request - name: Fetch validated commit from pull request head repository
run: gh pr checkout ${{ github.event.issue.number }} run: |
git remote add pr-head https://github.com/$HEAD_REPOSITORY.git
git fetch --no-tags pr-head $RESOLVED_SHA
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 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 - name: Check if Version Packages PR
id: check_version_packages id: check_version_packages
@@ -78,7 +154,8 @@ jobs:
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh pr comment ${{ github.event.issue.number }} --body "The [${{ github.repository }}@$(git rev-parse HEAD)](https://github.com/${{ github.repository }}/commit/$(git rev-parse HEAD)) release triggered by [this comment](${{ github.event.comment.url }}) has [succeeded](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})." - run: |
gh pr comment ${{ github.event.issue.number }} --body "The release for \`${{ needs.release_check.outputs.resolved_sha }}\` triggered by [this comment](${{ github.event.comment.url }}) has [succeeded](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}). Published commit: [${{ github.repository }}@$(git rev-parse HEAD)](https://github.com/${{ github.repository }}/commit/$(git rev-parse HEAD))."
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -87,6 +164,9 @@ jobs:
timeout-minutes: 2 timeout-minutes: 2
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure') if: failure() && github.repository == 'changesets/action' && (needs.release_check.result == 'failure' || needs.release.result == 'failure')
permissions:
issues: write
pull-requests: write
steps: steps:
- run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='-1' - run: gh api /repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions -f content='-1'
env: env:
@@ -96,7 +176,8 @@ jobs:
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: gh pr comment ${{ github.event.issue.number }} --body "The release triggered by [this comment](${{ github.event.comment.url }}) has [failed](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})." - run: |
gh pr comment ${{ github.event.issue.number }} --body "The release for \`${{ needs.release_check.outputs.requested_sha }}\` triggered by [this comment](${{ github.event.comment.url }}) has [failed](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})."
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_REPO: ${{ github.repository }} GH_REPO: ${{ github.repository }}
-27
View File
@@ -1,27 +0,0 @@
name: Version or Publish
on:
push:
branches:
- main
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
changesets:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/ci-setup
- 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 }}
+12
View File
@@ -1,5 +1,17 @@
# @changesets/action # @changesets/action
## 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 ## 1.7.0
### Minor Changes ### Minor Changes
+1
View File
@@ -14,6 +14,7 @@ This action for [Changesets](https://github.com/changesets/changesets) creates a
- createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true` - createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`. - commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
- cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()` - cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
- prDraft - Controls draft PR behavior. Use `create` to create new version PRs as draft, or `always` to also convert existing version PRs back to draft when updating them. By default, version PRs are not forced into draft mode.
### Outputs ### Outputs
+3
View File
@@ -43,6 +43,9 @@ inputs:
branch: branch:
description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
required: false required: false
prDraft:
description: 'Controls draft PR behavior. Use "create" to create new version PRs as draft, or "always" to also convert existing version PRs back to draft when updating them.'
required: false
outputs: outputs:
published: published:
description: A boolean value to indicate whether a publishing is happened or not description: A boolean value to indicate whether a publishing is happened or not
+61
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "1.7.0", "version": "1.8.0",
"main": "dist/index.js", "main": "dist/index.js",
"type": "module", "type": "module",
"license": "MIT", "license": "MIT",
+119
View File
@@ -1,5 +1,28 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`version > creates a draft PR when prDraft is "create" 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
## simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature
",
"draft": true,
"head": "changeset-release/some-branch",
"owner": "changesets",
"repo": "action",
"title": "Version Packages",
},
]
`;
exports[`version > creates simple PR 1`] = ` exports[`version > creates simple PR 1`] = `
[ [
{ {
@@ -25,6 +48,7 @@ exports[`version > creates simple PR 1`] = `
- Awesome feature - Awesome feature
", ",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -43,6 +67,7 @@ exports[`version > does not include any release information if a message with si
# Releases # Releases
> All release information have been omitted from this message, as the content exceeds the size limit.", > All release information have been omitted from this message, as the content exceeds the size limit.",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -65,6 +90,7 @@ exports[`version > does not include changelog entries if full message exceeds si
## simple-project-pkg-a@1.1.0 ## simple-project-pkg-a@1.1.0
", ",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -87,6 +113,7 @@ exports[`version > doesn't include ignored package that got a dependency update
- Awesome feature - Awesome feature
", ",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -109,6 +136,7 @@ exports[`version > only includes bumped packages in the PR body 1`] = `
- Awesome feature - Awesome feature
", ",
"draft": false,
"head": "changeset-release/some-branch", "head": "changeset-release/some-branch",
"owner": "changesets", "owner": "changesets",
"repo": "action", "repo": "action",
@@ -116,3 +144,94 @@ 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
## 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
## simple-project-pkg-a@1.1.0
### Minor Changes
- Awesome feature
",
"pullRequestId": "PR_kwDOA",
"title": "Version Packages",
},
]
`;
+6
View File
@@ -24,10 +24,15 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
const octokit = setupOctokit(githubToken); const octokit = setupOctokit(githubToken);
const commitMode = getOptionalInput("commitMode") ?? "git-cli"; const commitMode = getOptionalInput("commitMode") ?? "git-cli";
const prDraft = getOptionalInput("prDraft");
if (commitMode !== "git-cli" && commitMode !== "github-api") { if (commitMode !== "git-cli" && commitMode !== "github-api") {
core.setFailed(`Invalid commit mode: ${commitMode}`); core.setFailed(`Invalid commit mode: ${commitMode}`);
return; return;
} }
if (prDraft !== undefined && prDraft !== "always" && prDraft !== "create") {
core.setFailed(`Invalid prDraft: ${prDraft}`);
return;
}
const git = new Git({ const git = new Git({
octokit: commitMode === "github-api" ? octokit : undefined, octokit: commitMode === "github-api" ? octokit : undefined,
cwd, cwd,
@@ -147,6 +152,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
prTitle: getOptionalInput("title"), prTitle: getOptionalInput("title"),
commitMessage: getOptionalInput("commit"), commitMessage: getOptionalInput("commit"),
hasPublishScript, hasPublishScript,
prDraft,
branch: getOptionalInput("branch"), branch: getOptionalInput("branch"),
}); });
+106
View File
@@ -19,6 +19,7 @@ vi.mock("@actions/github", () => ({
}, },
getOctokit: () => ({ getOctokit: () => ({
rest: mockedGithubMethods, rest: mockedGithubMethods,
graphql: mockedGraphql,
}), }),
})); }));
vi.mock("./git.ts"); vi.mock("./git.ts");
@@ -33,6 +34,7 @@ let mockedGithubMethods = {
createRelease: vi.fn(), createRelease: vi.fn(),
}, },
}; };
let mockedGraphql = vi.fn();
let f = fixturez(import.meta.dirname); let f = fixturez(import.meta.dirname);
@@ -90,6 +92,42 @@ describe("version", () => {
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot(); expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
}); });
it('creates a draft PR when prDraft is "create"', async () => {
let cwd = f.copy("simple-project");
await linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({ data: [] }));
mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
data: { number: 123 },
}));
await writeChangesets(
[
{
releases: [
{
name: "simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "create",
});
expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
});
it("only includes bumped packages in the PR body", async () => { it("only includes bumped packages in the PR body", async () => {
let cwd = f.copy("simple-project"); let cwd = f.copy("simple-project");
await linkNodeModules(cwd); await linkNodeModules(cwd);
@@ -277,4 +315,72 @@ fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
/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 () => {
let cwd = f.copy("simple-project");
await linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "create",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
it('updates an existing PR via GraphQL and converts it to draft when prDraft is "always"', async () => {
let cwd = f.copy("simple-project");
await linkNodeModules(cwd);
mockedGithubMethods.pulls.list.mockImplementationOnce(() => ({
data: [{ number: 123, node_id: "PR_kwDOA" }],
}));
await writeChangesets(
[
{
releases: [
{
name: "simple-project-pkg-a",
type: "minor",
},
],
summary: "Awesome feature",
},
],
cwd
);
await runVersion({
octokit: setupOctokit("@@GITHUB_TOKEN"),
githubToken: "@@GITHUB_TOKEN",
git: new Git({ cwd }),
cwd,
prDraft: "always",
});
expect(mockedGraphql.mock.calls[0]).toMatchSnapshot();
});
}); });
+41 -4
View File
@@ -259,6 +259,7 @@ type VersionOptions = {
commitMessage?: string; commitMessage?: string;
hasPublishScript?: boolean; hasPublishScript?: boolean;
prBodyMaxCharacters?: number; prBodyMaxCharacters?: number;
prDraft?: "always" | "create";
branch?: string; branch?: string;
}; };
@@ -277,6 +278,7 @@ export async function runVersion({
hasPublishScript = false, hasPublishScript = false,
prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE, prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
branch = github.context.ref.replace("refs/heads/", ""), branch = github.context.ref.replace("refs/heads/", ""),
prDraft,
}: VersionOptions): Promise<RunVersionResult> { }: VersionOptions): Promise<RunVersionResult> {
let versionBranch = `changeset-release/${branch}`; let versionBranch = `changeset-release/${branch}`;
@@ -376,6 +378,7 @@ export async function runVersion({
head: versionBranch, head: versionBranch,
title: finalPrTitle, title: finalPrTitle,
body: prBody, body: prBody,
draft: prDraft !== undefined,
...github.context.repo, ...github.context.repo,
}); });
@@ -386,12 +389,46 @@ export async function runVersion({
const [pullRequest] = existingPullRequests.data; const [pullRequest] = existingPullRequests.data;
core.info(`updating found pull request #${pullRequest.number}`); core.info(`updating found pull request #${pullRequest.number}`);
await octokit.rest.pulls.update({ const convertPullRequestToDraftMutation =
pull_number: pullRequest.number, prDraft === "always"
? `
convertPullRequestToDraft(
input: {
pullRequestId: $pullRequestId
}
) {
pullRequest {
id
}
}`
: "";
const updatePullRequestMutation = `
mutation UpdatePullRequest(
$pullRequestId: ID!
$title: String!
$body: String!
) {
${convertPullRequestToDraftMutation}
updatePullRequest(
input: {
pullRequestId: $pullRequestId
title: $title
body: $body
state: OPEN
}
) {
pullRequest {
id
}
}
}
`;
await octokit.graphql(updatePullRequestMutation, {
pullRequestId: pullRequest.node_id,
title: finalPrTitle, title: finalPrTitle,
body: prBody, body: prBody,
...github.context.repo,
state: "open",
}); });
return { return {