Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.04 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.04 KB

deploy stars forks HitCount Maintainability Rating Technical Debt Bugs

Commit Comment GitHub Action

This GitHub Action allows you to automatically create a commit comment on a pull request.

Usage

  1. Add a step in your workflow YAML file to use this action:

    - name: Commit Comment
      uses: dext7r/commit-comment@main
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        body: 'This is a test comment.'
  2. Configure the token input with a secret GitHub API token with the necessary permissions.

  3. Specify the body input with the content of the comment you want to create.

Inputs

  • token (required): Secret GitHub API token to use for making API requests.
  • body (required): Comment content.

Outputs

  • comment_id: The ID of the comment that was created.

Example

name: Create Comment
on:
  pull_request:
    types: [opened]

jobs:
  comment:
    runs-on: ubuntu-latest

    steps:
      - name: Commit Comment
        uses: dext7r/commit-comment@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          body: 'Hello from GitHub Action!'

Versioning

This action follows semantic versioning. See releases for more information about each version.

License

This project is licensed under the MIT License - see the LICENSE file for details.