Skip to content
message-square

GitHub Action

Update Issue Body

v1.1.0 Latest version

Update Issue Body

message-square

Update Issue Body

Update an issue body

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Update Issue Body

              
  uses: julien-deramond/[email protected]
Learn more about this action in julien-deramond/update-issue-body

Choose a version

Update issue body

CI GitHub Marketplace

A GitHub action to update issue's body.

This is heavily based on peter-evans/create-or-update-comment.

Usage

Replace issue body

- 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

Append content to issue body

- 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

Prepend content to issue body

- 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

Action inputs

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

Accessing issues in other repositories

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.

Sponsors

License

MIT