diff --git a/README.md b/README.md index 52e3716..0e68cec 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,23 @@ A GitHub action to comment on the relevant open PR when a commit is pushed. ## Usage - Requires the `GITHUB_TOKEN` secret. -- Requires the comment's message in the `args`. +- Requires the comment's message in the `msg` parameter. + ### Sample workflow ``` -workflow "comment-on-pr example" { - on = "push" - resolves = ["unsplash/comment-on-pr@master"] -} - -action "unsplash/comment-on-pr@master" { - uses = "unsplash/comment-on-pr@master" - args = ["Check out this message!"] - secrets = ["GITHUB_TOKEN"] -} +name: comment-on-pr example +on: pull_request +jobs: + example: + name: sample comment + runs-on: ubuntu-latest + steps: + - name: comment PR + uses: unsplash/comment-on-pr@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + msg: "Check out this message!" ``` diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..6ddd907 --- /dev/null +++ b/action.yml @@ -0,0 +1,15 @@ +name: Comment on PR +author: Aaron Klaassen +description: Leaves a comment on an open PR matching a push event. +branding: + icon: 'message-square' + color: 'blue' +inputs: + msg: + description: Comment's message + required: true +runs: + using: 'docker' + image: 'Dockerfile' + args: + - ${{ inputs.msg }} \ No newline at end of file