A GitHub action to update issue's body.
This is heavily based on peter-evans/create-or-update-comment.
- name: Update Issue Body
uses: julien-deramond/update-issue-body@v1
with:
issue-number: ${{ github.event.issue.number }}
body: |
**Edit**: Some new content
edit-mode: replace
- name: Append Issue Body
uses: julien-deramond/update-issue-body@v1
with:
issue-number: ${{ github.event.issue.number }}
body: |
**Edit**: Append some new content separated by a space
edit-mode: append
append-separator: space
- name: Prepend Issue Body
uses: julien-deramond/update-issue-body@v1
with:
issue-number: ${{ github.event.issue.number }}
body: |
**Edit**: Prepend some new content separated by a space
edit-mode: prepend
prepend-separator: space
Name | Description | Default |
---|---|---|
token |
GITHUB_TOKEN (issues: write ) or a repo scoped PAT. |
GITHUB_TOKEN |
repository |
The full name of the repository in which to update the issue body. | Current repository |
issue-number |
The number of the issue to be updated. | |
body |
The issue body. | |
edit-mode |
The mode when updating the issue body, replace , append or prepend . |
append |
append-separator |
The separator to use when appending to an existing issue body. (newline , space , none ) |
newline |
prepend-separator |
The separator to use when prepending to an existing issue body. (newline , space , none ) |
newline |
You can update issue body in another repository by using a PAT instead of GITHUB_TOKEN
.
The user associated with the PAT must have write access to the repository.