Documentation

Everything you need to adopt and customize CloudBurn's AWS tools and GitHub Actions.


Welcome

Use this site as your handbook for setting up and using CloudBurn's AWS tools—from initial setup to production workflows and long-term maintenance.

Choose where to begin

CloudBurn App

  • Install CloudBurn — Set up the CloudBurn app from GitHub Marketplace to visualize infrastructure costs directly in Pull Requests

GitHub Actions

How the docs are organized

  • Install covers prerequisites, installation, initial setup, best practices, and troubleshooting for each tool.
  • Usage Examples provides practical examples and advanced patterns for common scenarios and workflows.
  • Configuration explains available inputs, outputs, permissions, and validation rules.

Getting Started

New to CloudBurn? Start with the CloudBurn App installation guide to get cost analysis in your Pull Requests. You'll need to install either the CDK diff or Terraform plan GitHub Action first, depending on your infrastructure tool.

Already have the GitHub Actions? You can install the CloudBurn app directly from the install page to add cost analysis to your existing workflows.

Prefer a quick start? Jump directly to the Install page for the tool you need, then explore Usage Examples for practical patterns and Configuration for detailed reference.