Skip to content
edit-3

GitHub Action

github-comment-pr

v1 Latest version

github-comment-pr

edit-3

github-comment-pr

Comment on PR with custom text message

Installation

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

              

- name: github-comment-pr

uses: meysam81/comment-pr@v1

Learn more about this action in meysam81/comment-pr

Choose a version

Comment PR

There are other GitHub Actions doing the same thing, yet their usage seemed so complicated to me and I wanted something simple and consistent.

The objective of this GitHub Action is as follows:

  • Have a unique identifier for the comment to avoid duplicates.
  • On subsequent runs, remove the old comment and add another of the exact same one just to get notified by email from the GitHub notification system.

Usage

jobs:
  comment-pr:
    permissions:
      pull-requests: write # this is necessary
    runs-on: ubuntu-latest
    steps:
      - name: Comment PR
        uses: meysam81/comment-pr@v1
        with:
          # `title` and `content` support markdown
          title: "# Custom title" # ensures idempotency through a unique identifier
          content: |
            My content goes here
          token: ${{ secrets.GITHUB_TOKEN }} # this is required