Skip to content

Add message-body, update test workflows. #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asford wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add message-body, update test workflows. #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 73 additions & 34 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ jobs:
uses: actions/checkout@v2

- name: normal mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: normal-mode-comment
message: 'normal mode - create comment'
Expand All @@ -31,14 +31,53 @@ jobs:
run: echo "this step just prints this"

- name: normal mode - update comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: normal-mode-comment
message: 'normal mode - update comment'

message-path:
runs-on: ubuntu-20.04
name: Use message-path to load message from file
steps:
- name: Checkout
uses: actions/checkout@v2

- name: Create MESSAGE.md
run: echo "body from message-path" > MESSAGE.md
- name: message path - create comment
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: message-path-comment
message-path: ./MESSAGE.md

- name: message path - missing input
uses: ./
continue-on-error: true
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: message-path-comment
message-path: ./MISSING_INPUT.md

- name: message path - both inputs provided, should fail
uses: ./
continue-on-error: true
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: message-path-comment
message-path: ./MISSING_INPUT.md
message: BOTH

issue-append-mode:
runs-on: ubuntu-20.04
name: Append mode progress for issue comments
Expand All @@ -47,22 +86,22 @@ jobs:
uses: actions/checkout@v2

- name: append mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: append-mode-comment
message: 'append mode - create comment'
message: "append mode - create comment"

- name: Do some work
run: echo "this step just prints this"

- name: append mode - append comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: append-mode-comment
append: true
Expand All @@ -76,10 +115,10 @@ jobs:
uses: actions/checkout@v2

- name: recreate mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: recreate-mode-comment
message: 'recreate mode - create comment'
Expand All @@ -88,10 +127,10 @@ jobs:
run: echo "this step just prints this"

- name: recreate mode - append comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: recreate-mode-comment
recreate: true
Expand All @@ -105,22 +144,22 @@ jobs:
uses: actions/checkout@v2

- name: normal mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: normal-mode-comment
message: 'normal mode - create comment'
message: "normal mode - create comment"

- name: Do some work
run: echo "this step just prints this"

- name: normal mode - update comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: normal-mode-comment
message: 'normal mode - update comment'
Expand All @@ -133,10 +172,10 @@ jobs:
uses: actions/checkout@v2

- name: append mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: append-mode-comment
message: 'append mode - create comment'
Expand All @@ -145,10 +184,10 @@ jobs:
run: echo "this step just prints this"

- name: append mode - append comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: append-mode-comment
append: true
Expand All @@ -162,10 +201,10 @@ jobs:
uses: actions/checkout@v2

- name: recreate mode - create comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: recreate-mode-comment
message: 'recreate mode - create comment'
Expand All @@ -174,10 +213,10 @@ jobs:
run: echo "this step just prints this"

- name: recreate mode - append comment
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
commit-sha: ${{ github.event.inputs.sha }}
id: recreate-mode-comment
recreate: true
Expand All @@ -192,10 +231,10 @@ jobs:
uses: actions/checkout@v2

- name: Should error out and not comment anything
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: fail-mode-comment
recreate: true
Expand All @@ -211,10 +250,10 @@ jobs:
uses: actions/checkout@v2

- name: Error out
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
commit-sha: ${{ github.event.inputs.sha }}
id: fail-mode-issue-commit-both
Expand All @@ -229,10 +268,10 @@ jobs:
uses: actions/checkout@v2

- name: Error out
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
id: fail-mode-issue-commit-none
message: 'should error out as both number and sha fields are not given'

Expand All @@ -245,10 +284,10 @@ jobs:
uses: actions/checkout@v2

- name: Should comment and fail this job
uses: hasura/comment-progress@test
uses: ./
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: 'hasura/comment-progress'
repository: ${{ github.repository }}
number: ${{ github.event.inputs.number }}
id: fail-comment
fail: true
Expand Down
33 changes: 18 additions & 15 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,44 @@
name: 'Comment Progress'
description: 'Notify progress by commenting on GitHub issues, pull requests, and commits'
name: "Comment Progress"
description: "Notify progress by commenting on GitHub issues, pull requests, and commits"
branding:
icon: message-square
color: white
inputs:
github-token:
description: 'Github token'
description: "Github token"
required: true
repository:
description: 'Github repository'
description: "Github repository"
required: true
number:
description: 'Github issue or pull request number'
description: "Github issue or pull request number"
required: false
commit-sha:
description: 'Commit SHA'
description: "Commit SHA"
require: false
id:
description: 'Unique identifier for the comment'
description: "Unique identifier for the comment"
required: true
message:
description: 'Message to be commented'
required: true
description: "Message to be commented"
required: false
message-path:
description: "Read message from path"
required: false
fail:
description: 'If true, the step will be marked as failure'
description: "If true, the step will be marked as failure"
append:
description: 'If true, message will be appended to existing comment'
description: "If true, message will be appended to existing comment"
required: false
default: false
recreate:
description: 'If true, message will be commented after deleting existing comment'
description: "If true, message will be commented after deleting existing comment"
required: false
default: false
delete:
description: 'If true, the comment will be deleted'
description: "If true, the comment will be deleted"
required: false
default: false
runs:
using: 'node12'
main: 'dist/index.js'
using: "node12"
main: "dist/index.js"
Loading