Skip to main content

GitHub App

The Infracost GitHub App is an automated integration meaning that Infracost runs on our infrastructure and we keep it up to date.

1. Install the Infracost GitHub App2. Get pull request comments
Install the GitHub App into any GitHub organizationInfracost automatically leaves a comment on every pull request

Benefits​

There are two key benefits of using the GitHub App over manual CI/CD integrations:

  1. You can add Infracost to multiple repos with one click, no need to install or update CLI versions in your CI/CD pipeline.
  2. Infracost runs significantly faster as only changed folders are run based on the GitHub App events.

Furthermore, if you use Infracost Cloud (our SaaS product):

  • the pull request status (e.g. open, closed, merged) and metadata such as labels, merged by, and approved by are included in the dashboard filters and reports.
  • Guardrails and centralized cost policies work without you needing to make changes in your CI/CD pipelines.

We are SOC 2 Type II certified, see our security page for more details. If you prefer a manual integration where you maintain Infracost, see GitHub Actions integration.

Usage​

  1. Go to Infracost Cloud to sign up or log in to start your free trial (no credit card is needed).

  2. Every Infracost user has a default organization for personal use. Create a new organization for your company using the organization dropdown at the top of the page.

    Create new organization

  3. Click on Org Settings > Integrations > GitHub and follow the wizard to select the repos you want to give Infracost access to. If you use private modules:

    • For private git modules, add your private SSH key (RSA format is recommended) and/or Git HTTPS credentials so Infracost can clone the repos in the same way that Terraform does.

    • For private registry modules, see this page and set the required Terraform registry token and host in the integration settings page in Infracost Cloud.

  4. If you need to customize how Infracost runs, add an infracost.yml config file to the root of your repo. The GitHub App will automatically use that file if it's present. The app will also apply any usage values defined in the infracost-usage-yml usage file at the root of the repo.

  5. Open a test pull request and wait for Infracost to leave a pull request comment. The Infracost Cloud dashboard should also show the cost estimate too.

    Each time a new commit is pushed to an open pull request, the Infracost GitHub App shows the cost difference between the most recent commit of the pull request branch, and the merge base of the base branch. The merge base is the latest common commit of the pull request base and target branch. This mirrors GitHub's pull request diff logic and shows only the cost of 'what a pull request introduces'.

  6. When the pull request is merged the Infracost Cloud dashboard will show you the time it was merged, who approved it, and who merged it.

Pull request status​

The Infracost GitHub App enables the dashboard to show you the status of pull requests so you can filter on them. You can also filter on the date range that the pull request was last updated, and the base branch that pull requests are being merged into (e.g. main, stage, production).

Create new organization
tip

If you don't use the GitHub App integration, use our API to set pull request statuses from your CI/CD system.

The pull request status can be:

  • open: the pull request is currently open, thus if you want to review the most expensive pull requests that are in-flight, only focus on these.
  • closed: the pull request was closed without being merged. These pull requests can probably be ignored altogether as most of the time they're just noise.
  • merged: the pull request was merged into the base branch, these can be checked when auditing actual cloud costs to see what happened.

GitHub Enterprise​

Our automated GitHub App integration works with both GitHub Enterprise Cloud and GitHub Enterprise Server. Directly integrating Infracost Cloud to GitHub Enterprise means you'll get the latest features, the fastest cost estimates and the most robust solution.

GitHub Enterprise Cloud​

Follow the same usage steps as the regular GitHub App above.

If you use the GitHub Enterprise "Enable IP allow list", you need to allow incoming traffic from 3.133.40.66 to your GitHub instance port 443 (or whatever port you use); this is the IP address used by Infracost Cloud services to call the integration.

If you have restricted out-going traffic from your instance, you need to allow traffic to be sent to dashboard.api.infracost.io:443 too. If you can only do that by IP address (and not domains), you should whitelist 13.58.92.216, 3.142.138.46 and 13.58.157.166 but we recommend you whitelist the domain as these IP addresses are likely to change.

GitHub Enterprise Server​

Email us at hello@infracost.io to enable GitHub Enterprise Server in your Infracost Cloud account. This requires a meeting with your server admin so we can install the Infracost GitHub App in your GitHub organization.

Migrating from GitHub Actions to GitHub App​

We recommend enabling the GitHub App first, testing to ensure you're happy with it, then removing the Infracost GitHub Actions yaml configs from your repo.