ApproveOps - Approvals in IssueOps
ActionsIssueOps (ChatOps) workflows that require Approvals from someone in a designated GitHub team
v1.0.4
Tags
(2)Approvals in IssueOps
See the following guide on this action: https://josh-ops.com/posts/github-approveops/
- name: ApproveOps - Approvals in IssueOps
uses: joshjohanning/approveops@v1
id: check-approval
with:
app-id: 170284 # The GitHub App ID; ie: 170284
app-private-key: ${{ secrets.PRIVATE_KEY }} # Private key for the GitHub App that is installed on the repo; e.g.: ${{ secrets.PRIVATE_KEY }}
team-name: approver-team # The name of the team in GitHub to check for the approval command; e.g.: approver-team
fail-if-approval-not-found: false # Fail the action (show the action run as red) if the command is not found in the comments from someone in the approver team"
post-successful-approval-comment: true # Boolean whether to post successful approval comment
successful-approval-comment: ':tada: You were able to run the workflow because someone left an approval in the comments!! :tada:' # Comment to post if there is an approval is found- Create a GitHub team and add at least one member
- You will need a Github App with the following permissions:
- read-only on
Organization / Membersto list the members of the team - read & write on
Repository / Issuesto create the comment
- read-only on
- Generate a
PRIVATE_KEYfor the GitHub app and store it as a repo or organizational secret - Capture the
APP IDto use as an input for this action
See the following guide on creating a GitHub app: https://josh-ops.com/posts/github-apps/
Notes:
- A Personal Access Token (PAT) is not used since we want the comment to show as from a bot
- The
github.tokenis not used since the token can't provide hyperlinks for @ mentions since it doesn't have the scope for org teams, only repository data
ApproveOps - Approvals in IssueOps is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
v1.0.4
Tags
(2)ApproveOps - Approvals in IssueOps is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.