pr-comment-action

A GitHub Action which can create a comment on pull request with given owner, repo, pr_number and filepath.

sample.mp4

Input

This action supports following inputs.

owner

The repository owner on pull request.

Required: yes
Type: string
Example: shellingford330

repo

The repository name on pull request. Either open or closed. Default: open

Required: yes
Type: string
Example: pr-comment-action

pr_number

The number of pull request.

Required: yes
Type: number
Example: 1

filepath

The filepath containing the content of the comment.

Required: yes
Type: string
Example: content.txt

template

The template of pull request comment. The contents of the file are assigned to {{ . }}.

Required: no
Type: string
Example: The contents of the file is {{ . }}.

Output

url

The url of created pull request comment.

Example

name: PR Comment
on:
  issue_comment:
    types: [created]

jobs:
  create:
    if: ${{ github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Create output file
        run: echo "Create PR comment successfully!" > output.txt
      - name: Comment PR
        uses: shellingford330/[email protected]
        with:
          owner: ${{ github.event.repository.owner.login }}
          repo: ${{ github.event.repository.name }}
          pr_number: ${{ github.event.issue.number }}
          filepath: output.txt
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Advanced usage

The file content can be embedded using template.

name: PR Comment
on:
  issue_comment:
    types: [created]

jobs:
  create:
    if: ${{ github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Create output file
        run: echo "Create PR comment successfully!" > output.txt
      - name: Comment PR
        uses: shellingford330/[email protected]
        with:
          owner: ${{ github.event.repository.owner.login }}
          repo: ${{ github.event.repository.name }}
          pr_number: ${{ github.event.issue.number }}
          filepath: output.txt
          template: |
            <details>
            <summary>Show Output</summary>

            ```
            {{ . }}
            ```

            </details>
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

shellingford330 / pr-comment-action Goto Github PK