This folder contains detailed documentation for configuration, object storage, installation, usage, and development.
| Topic | Description |
|---|---|
| Getting started (Terramate) | Set up Neptune with GitHub Actions and neptbot using Terramate stacks |
| Getting started (Local stacks) | Set up Neptune with GitHub Actions and neptbot using local stack discovery or config |
| Topic | Description |
|---|---|
| Workflow comparison | Comparison of normal Terraform + GitHub Actions, Neptune, and Atlantis workflows; apply-before-merge and where runs execute |
| Configuration | .neptune.yaml schema, plan/apply requirements, and Terramate |
| Object storage | GCS, S3, and MinIO setup and environment variables |
| Installation | Install Neptune binary and triggering via GitHub App |
| Usage | GitHub Actions/PR flow and CLI reference |
| GitHub App and Lambda | Trigger Neptune via GitHub App webhooks and AWS Lambda (repository_dispatch) |
| Development | Building, testing, and contributing |
| Examples | Sample configs and backends (S3, GCS, automerge, Terramate, Terragrunt) in examples/ |