You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit cb3f011
Browse filesBrowse the repository at this point in the historyBrowse files
Release commits and tags are now pushed using the GitHub API by default.
6
+
7
+
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.
8
+
9
+
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.
Copy file name to clipboardExpand all lines: README.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,22 +36,32 @@ If using [trusted publishing](https://docs.npmjs.com/trusted-publishers), it's r
36
36
> [!TIP]
37
37
> 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.
38
38
39
+
> [!IMPORTANT]
40
+
> To use a custom GitHub token, pass it explicitly through the `github-token` input:
> 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.
|`github-token`| The GitHub token to use for authentication. Defaults to the GitHub-provided token. |
46
-
|`publish-script`| The command to use to build and publish packages |
47
-
|`version-script`| The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided |
48
-
|`commit-message`| The commit message. Default to `Version Packages`|
49
-
|`pr-title`| The pull request title. Default to `Version Packages`|
50
-
|`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. |
51
-
|`pr-base-branch`| Sets the base branch of the PR. Defaults to `github.ref_name`. |
52
-
|`create-github-releases`| Whether to create Github releases after publish |
53
-
|`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`. |
54
-
|`commit-mode`| 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. |
| `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. |
56
+
| `publish-script` | The command to use to build and publish packages |
57
+
| `version-script` | The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided |
58
+
| `commit-message` | The commit message. Default to `Version Packages` |
59
+
| `pr-title` | The pull request title. Default to `Version Packages` |
60
+
| `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. |
61
+
| `pr-base-branch` | Sets the base branch of the PR. Defaults to `github.ref_name`. |
62
+
| `create-github-releases` | Whether to create Github releases after publish |
63
+
| `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`. |
64
+
| `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`. |
| `github-token` | The GitHub token to use for authentication. Defaults to the GitHub-provided token. |
76
+
| `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. |
77
77
| `body` | **Required.** The comment body to post on the PR. |
78
78
| `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. |
|`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.|
24
+
|`script`| The command to use to publish packages |
25
+
|`pack-dir-artifact-id`| Artifact id for packed publish output generated by the pack subaction |
26
+
|`create-github-releases`| Whether to create Github releases after publish |
27
+
|`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`. |
0 commit comments