diff --git a/docs/integrations/github_app.md b/docs/integrations/github_app.md index 56c7eabf..22874701 100644 --- a/docs/integrations/github_app.md +++ b/docs/integrations/github_app.md @@ -104,3 +104,26 @@ From the Org Settings > Integrations > GitHub App page, you can disable pull req 1. Follow the [usage](#usage) docs to install the app. You can do this from the same Infracost organization you use already, and going into the Org Settings > Integrations page. 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 + +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. + +Any GitHub pull request comment will contain information on how to dismiss the policy failure. + +pr comment + +Engineers can can comment `@infracost help` to get more information on how to dismiss the policy failure. + +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 `. +- 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. + 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. + passing +- Any blocking status checks will be updated to succeeded, enabling the engineer to merge the pull request. + 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 table diff --git a/static/img/github/checks.png b/static/img/github/checks.png new file mode 100644 index 00000000..16fbca34 Binary files /dev/null and b/static/img/github/checks.png differ diff --git a/static/img/github/desc.png b/static/img/github/desc.png new file mode 100644 index 00000000..1d6b4a0a Binary files /dev/null and b/static/img/github/desc.png differ diff --git a/static/img/github/dismissed-table.png b/static/img/github/dismissed-table.png new file mode 100644 index 00000000..4b281b7e Binary files /dev/null and b/static/img/github/dismissed-table.png differ diff --git a/static/img/github/help.png b/static/img/github/help.png new file mode 100644 index 00000000..969842fe Binary files /dev/null and b/static/img/github/help.png differ diff --git a/static/img/github/passing.png b/static/img/github/passing.png new file mode 100644 index 00000000..655e83c7 Binary files /dev/null and b/static/img/github/passing.png differ diff --git a/static/img/github/reaction.png b/static/img/github/reaction.png new file mode 100644 index 00000000..88d88fcb Binary files /dev/null and b/static/img/github/reaction.png differ