Skip to content

Commit

Permalink
docs: tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
alikhajeh1 committed Nov 29, 2024
1 parent 9cd53e6 commit 884534e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/integrations/github_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,25 +105,25 @@ From the Org Settings > Integrations > GitHub App page, you can disable pull req
2. Test it by [sending a pull request](/docs/infracost_cloud/get_started/#4-send-a-pull-request).
3. Remove all Infracost steps from your GitHub Actions.

### Dismissing Policy failures
### Dismissing policy issues

Infracost finops and tagging policy failures can be dismissed directly from the GitHub pull request UI. This allows engineers to ship critical changes without having to fix all policy failures.
Infracost FinOps and Tagging issues can be dismissed directly from the GitHub pull request UI, even if the policy is set to block pull requests. This allows engineers to ship critical changes without having to fix all issues. During non-emergency circumstances, we recommend engineers fix the issues they can, and dismiss any that they cannot fix.

Any GitHub pull request comment will contain information on how to dismiss the policy failure.
Any GitHub pull request comment will contain information on how to dismiss the issues.

<img src={useBaseUrl("img/github/desc.png")} alt="pr comment" />

Engineers can can comment `@infracost help` to get more information on how to dismiss the policy failure.
Engineers can add a pull request comment `@infracost help` to get more information on how to dismiss the issues.

<img src={useBaseUrl("img/github/help.png")} alt="help" />

Dismissing a policy failure works as follows:
- The engineer adds a comment to the pull request to dismiss the policy failure using the command `@infracost dismiss <optional reason>`.
- The Infracost GitHub App will then read the comment and react to the comment to let the engineer know the policy failure is queued for dismissal.
Dismissing a policy issue works as follows:
- The engineer adds a comment to the pull request to dismiss the issue using the command `@infracost dismiss <optional reason>`.
- The Infracost GitHub App will then read the comment and react to the comment to let the engineer know the issue is queued for dismissal.
<img src={useBaseUrl("img/github/reaction.png")} alt="reaction" />
- Infracost will then run another status check on the pull request on the PR once the policy failure is dismissed. This will update the Infracost comment to remove all the policy failures.
- Infracost will then run another status check on the pull request once the issue is dismissed. This will update the Infracost comment to remove all the issues.
<img src={useBaseUrl("img/github/passing.png")} alt="passing" />
- Any blocking status checks will be updated to succeeded, enabling the engineer to merge the pull request.
<img src={useBaseUrl("img/github/checks.png")} alt="checks" />
- Dismissed policy failures are shown in Infracost Cloud in the policies pages. You can filter by dismissed policy failures to see all the issues your engineers have dismissed.
- Dismissed issues are shown in Infracost Cloud in the policies pages. You can filter by dismissed issues to see all the issues your engineers have dismissed and their reasons.
<img src={useBaseUrl("img/github/dismissed-table.png")} alt="dismissed table" />

0 comments on commit 884534e

Please sign in to comment.