mirror of
https://github.com/changesets/action
synced 2026-10-26 16:39:56 +08:00
44 lines
3.7 KiB
Markdown
44 lines
3.7 KiB
Markdown
# changesets/action/version
|
|
|
|
This action versions packages and creates or updates a pull request with the changes.
|
|
|
|
## Requirements
|
|
|
|
- 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
|
|
- [Workflow triggers][workflow-triggers]: _any_
|
|
|
|
> [!NOTE]
|
|
> In your repository settings, in `Actions > General`, also ensure the `Allow GitHub Actions to create and approve pull requests` option is enabled
|
|
|
|
## 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 version packages |
|
|
| `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`. |
|
|
| `push-with-git-cli` | Whether to use the Git CLI instead of the GitHub API to push release commits. Defaults to `false`. When using the GitHub API, commits are signed using GitHub's GPG key and attributed to the user or app that owns the `github-token`. |
|
|
| `cwd` | The working directory to execute Changesets in. Defaults to the root of the repository. |
|
|
|
|
| Outputs | Description |
|
|
| ----------- | --------------------------------------------------- |
|
|
| `pr-number` | The pull request number 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
|