mirror-helper/changesets-action
1
0
Fork 0
mirror of https://github.com/changesets/action synced 2026-10-26 16:39:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update all the docs (#703)

Browse Source 
* Update all the docs

* Fix heading
This commit is contained in:
Bjorn Lu
2026-07-31 14:33:09 +00:00
committed by GitHub
parent 219ea82e52
commit 64b747d5f5
14 changed files with 306 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pr-comment/README.md
+49 -12
View File
@@ -1,16 +1,28 @@
# @changesets/action/pr-comment
# changesets/action/pr-comment
A simple GitHub Action to comment on PRs aimed to complement [`@changesets/action/pr-status`](../pr-status/README.md).
This action creates or updates comments on PRs, aimed to complement [changesets/action/pr-status](../pr-status/README.md).
This action is intentionally simple without advanced features. Check out other actions if so, such as [mshick/add-pr-comment](https://github.com/marketplace/actions/add-pr-comment) and [peter-evans/create-or-update-comment](https://github.com/marketplace/actions/create-or-update-comment).
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).
See the [action metadata](action.yml) for details on the inputs and outputs.
## Requirements
## Example setup
- [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
name: PR Comment
on:
pull_request:
@@ -18,21 +30,25 @@ jobs:
pr-comment:
runs-on: ubuntu-slim
permissions:
pull-requests: write # to create and update comments on PRs
pull-requests: write # to create and update comments on PRs (changesets/action/pr-comment)
steps:
- uses: changesets/action/pr-comment@v1
- name: Comment on PR
uses: changesets/action/pr-comment@v2
with:
body: Hello world!
```
When called repeatedly, the action will update the comment it created by default. If you use this action to create different types of comments, pass an `update-id` value to differentiate them.
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:
- uses: changesets/action/pr-comment@v1
- name: Comment on PR
uses: changesets/action/pr-comment@v2
with:
body: Hello world!
update-id: my-tag
@@ -45,8 +61,29 @@ jobs:
pr-comment:
# ...
steps:
- uses: changesets/action/pr-comment@v1
- 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. |
| `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