Skip to content
message-square

GitHub Action

Commit Comment

v3.0.0 Latest version

Commit Comment

message-square

Commit Comment

Create a comment for a commit on GitHub

Installation

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

 
              
- name: Commit Comment

              
  uses: peter-evans/commit-comment@v3.0.0
Learn more about this action in peter-evans/commit-comment

Choose a version

Commit Comment

CI GitHub Marketplace

A GitHub action to create a comment for a commit on GitHub.

Commit Comment Example

Usage

Add a comment to the current context's commit SHA

The SHA defaults to github.sha OR, for pull_request events github.event.pull_request.head.sha.

      - name: Create commit comment
        uses: peter-evans/commit-comment@v3
        with:
          body: |
            This is a multi-line test comment
            - With GitHub **Markdown** :sparkles:
            - Created by [commit-comment][1]

            [1]: https://github.com/peter-evans/commit-comment
          reactions: '+1'

Update a commit comment

      - name: Update commit comment
        uses: peter-evans/commit-comment@v3
        with:
          comment-id: 557858210
          body: |
            **Edit:** Some additional info
          reactions: eyes

Add commit comment reactions

      - name: Add reactions
        uses: peter-evans/commit-comment@v3
        with:
          comment-id: 557858210
          reactions: |
            heart
            hooray
            laugh

Action inputs

Name Description Default
token GITHUB_TOKEN or a repo scoped PAT. GITHUB_TOKEN
repository The full name of the target repository. github.repository (current repository)
sha The commit SHA. github.sha OR, for pull_request events github.event.pull_request.head.sha
path Relative path of the file to comment on.
position Line index in the diff to comment on.
comment-id The id of the comment to update.
body The comment body. Cannot be used in conjunction with body-path.
body-path The path to a file containing the comment body. Cannot be used in conjunction with body.
edit-mode The mode when updating a comment, replace or append. append
append-separator The separator to use when appending to an existing comment. (newline, space, none) newline
reactions A comma or newline separated list of reactions to add to the comment. (+1, -1, laugh, confused, heart, hooray, rocket, eyes)
reactions-edit-mode The mode when updating comment reactions, replace or append. append

Note: In public repositories this action does not work in pull_request workflows when triggered by forks. Any attempt will be met with the error, Resource not accessible by integration. This is due to token restrictions put in place by GitHub Actions. Private repositories can be configured to enable workflows from forks to run without restriction. See here for further explanation. Alternatively, use the pull_request_target event to comment on pull request commits.

Outputs

The ID of the created comment will be output for use in later steps. Note that in order to read the step output the action step must have an id.

      - name: Create commit comment
        uses: peter-evans/commit-comment@v3
        id: cc
        with:
          body: |
            My comment
      - name: Check outputs
        run: |
          echo "Comment ID - ${{ steps.cc.outputs.comment-id }}"

Setting the comment body from a file

      - name: Create commit comment
        uses: peter-evans/commit-comment@v3
        with:
          body-path: 'comment-body.md'

Using a markdown template

In this example, a markdown template file is added to the repository at .github/comment-template.md with the following content.

This is a test comment template
Render template variables such as {{ .foo }} and {{ .bar }}.

The template is rendered using the render-template action and the result is used to create the comment.

      - name: Render template
        id: template
        uses: chuhlomin/render-template@v1.4
        with:
          template: .github/comment-template.md
          vars: |
            foo: this
            bar: that

      - name: Create commit comment
        uses: peter-evans/commit-comment@v3
        with:
          body: ${{ steps.template.outputs.result }}

Accessing commits and comments in other repositories

You can create and update commit comments in another repository by using a PAT instead of GITHUB_TOKEN. The user associated with the PAT must have write access to the repository.

License

MIT