diff --git a/README.md b/README.md index 990e1a3..dcba7ca 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ See the following guide on this action: https://josh-ops.com/posts/github-approv uses: joshjohanning/approveops@v1 id: check-approval with: - app-id: 170284 - app-private-key: ${{ secrets.PRIVATE_KEY }} - team-name: approver-team - fail-if-approval-not-found: false + 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" ``` ## Prerequisites @@ -28,6 +28,10 @@ See the following guide on this action: https://josh-ops.com/posts/github-approv 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.token` is not used since the token can't provide hyperlinks for @ mentions since it doesn't have the scope for org teams, only repository data + ## Screenshots ![approveops](https://user-images.githubusercontent.com/19912012/154545687-8d64a775-eec2-4ec7-90dc-901b2d6d39a5.png) diff --git a/action.yml b/action.yml index ca9e729..e4d99a4 100644 --- a/action.yml +++ b/action.yml @@ -7,16 +7,16 @@ branding: inputs: team-name: - description: "The name of the team in GitHub to check for the approval command; ie: approver-team" + description: "The name of the team in GitHub to check for the approval command; e.g.: approver-team" required: true app-private-key: - description: "Private key for the GitHub App that is installed on the repo; ie: secrets.PRIVATE_KEY" + description: "Private key for the GitHub App that is installed on the repo; e.g.: ${{ secrets.PRIVATE_KEY }}" required: true app-id: description: "The GitHub App ID; ie: 170284" required: true fail-if-approval-not-found: - description: "Fail the action if the command is not found in the comments from someone in the approver team" + description: "Fail the action (i.e. show the action run as red) if the command is not found in the comments from someone in the approver team" required: true default: 'false'