https://github.com/igorbrites/neptune

CLI to post Terraform Plans on GitHub's Pull Requests
https://github.com/igorbrites/neptune

Last synced: 10 months ago
JSON representation

CLI to post Terraform Plans on GitHub's Pull Requests

• Host: GitHub
• URL: https://github.com/igorbrites/neptune
• Owner: igorbrites
• Created: 2020-06-26T02:03:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T19:10:07.000Z (almost 5 years ago)
• Last Synced: 2025-04-10T18:12:25.050Z (about 1 year ago)
• Language: Go
• Size: 16.6 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Neptune

![GoBuild](https://github.com/igorbrites/neptune/workflows/GoBuild/badge.svg) ![GoReleaser](https://github.com/igorbrites/neptune/workflows/GoReleaser/badge.svg)

Neptune runs plans with Terraform and posts its results on Pull Requests on GitHub (very specific, huh?).

## Installing

Go check the [releases](https://github.com/igorbrites/neptune/releases) to get the latest version for your OS.

## Using

Neptune accepts all the flags of the [`terraform plan`](https://www.terraform.io/docs/commands/plan.html) command, plus the following:

- `-owner`: Name of the owner of the repo;

- `-path`: Path to the "terraform" binnary. Be sure that it is on your $PATH. (default "terraform");

- `-pr-number`: Pull Request number;

- `-repo`: Repo name.

So, you can simply change the `terraform plan` by `neptune`, adding the flags to post on the Pull Request:

```sh

# From:

terraform plan -out=terraform.tfplan -var-file=terraform.tfvars -input=false

# To:

neptune -out=terraform.tfplan -var-file=terraform.tfvars -input=false -owner=igorbrites -repo=neptune -pr-number=1

```