Skip to content
message-square

GitHub Action

PR Comment from File

1.0.0 Latest version

PR Comment from File

message-square

PR Comment from File

Leaves a comment on an open PR based on the contents of a file

Installation

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

              

- name: PR Comment from File

uses: machine-learning-apps/pr-comment@1.0.0

Learn more about this action in machine-learning-apps/pr-comment

Choose a version

PR Comment Action

A GitHub action that will comment on the relevant open PR with a file contents when a commit is pushed.

Usage

  • Requires the GITHUB_TOKEN secret.
  • Requires the comment's artifact in the msg parameter.
  • Supports push and pull_request event types.

Sample workflow

  
name: example
on: pull_request
jobs:
  example:
    name: example
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - run: mkdir -p output/
      - run: echo "This is fancy a comment" > output/results.txt
      - uses: actions/upload-artifact@v1
        with:
          name: results
          path: output
      - uses: actions/download-artifact@v1
        with:
          name: results
      - name: comment PR
        uses: machine-learning-apps/pr-comment@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          path: results/results.txt