https://github.com/meysam81/comment-pr

A simple, consistent GitHub Action for managing PR comments with built-in deduplication
https://github.com/meysam81/comment-pr

automation bot ci-cd code-quality code-review collaboration comments continuous-integration developer-tools devops github-actions github-api github-workflow markdown notifications pr-management productivity pull-request pull-request-automation workflow-automation

Last synced: about 1 month ago
JSON representation

A simple, consistent GitHub Action for managing PR comments with built-in deduplication

• Host: GitHub
• URL: https://github.com/meysam81/comment-pr
• Owner: meysam81
• License: apache-2.0
• Created: 2024-03-31T12:09:14.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-18T19:40:14.000Z (about 1 month ago)
• Last Synced: 2024-11-18T20:42:08.612Z (about 1 month ago)
• Topics: automation, bot, ci-cd, code-quality, code-review, collaboration, comments, continuous-integration, developer-tools, devops, github-actions, github-api, github-workflow, markdown, notifications, pr-management, productivity, pull-request, pull-request-automation, workflow-automation
• Language: Just
• Homepage:
• Size: 27.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Comment PR

Tired of complex PR comment actions?

Comment PR provides a straightforward solution for adding and updating

comments on Pull Requests.

## Features

- [x] ✨ **Unique Identifiers**: Automatically prevents duplicate comments

- [x] 🔄 **Smart Updates**: Removes old comments and adds new ones to trigger notifications

- [x] 📝 **Markdown Support**: Full markdown capabilities for both title and content

- [x] 🎯 **Minimal Configuration**: Simple YAML setup with just three required fields

## Why Choose Comment PR?

- [x] **Simplicity First**: Designed for developers who want a no-nonsense solution

- [x] **Consistent Behavior**: Predictable outcomes across all your workflows

- [x] **Notification Friendly**: Updates trigger GitHub notifications to keep your team informed

Perfect for CI/CD pipelines, automated reviews, and status updates on your Pull Requests.

## Yet Another GH Action?

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

```yaml

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

```