Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sachasmart committed Oct 21, 2023
1 parent a0feec4 commit b428118
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/terrafir.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:
terraform show -json tfplan.binary > input.json
- name: Run Terrafir
uses: sachasmart/terrafir-github-action@v1
uses: sachasmart/terrafir-github-action@v0.0.1
with:
path: input.json
email: ${{ secrets.TERRAFIR_EMAIL }}
Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# Terrafir Github Action
## 👋 Overview

## 👋 Overview

This Github Action is used to assess Terraform plans using [Terrafir](https://www.terrafir.com). It is intended to be used in a CI/CD pipeline to assess Terraform plans before they are applied. You can see the output of the plan in the Terrafir dashboard or the Github Action output.

## 🚀 Usage

### Inputs
| Name | Description | Required |
| --- | --- | --- |
| apiKey | The API key used to authenticate with Terrafir | true |
| email | The email address of the user who owns the API key | true |
| __WIP: verbose__ | Whether or not to print the assessment to the Github Action output | false |

| Name | Description | Required |
| ---------------- | ------------------------------------------------------------------ | -------- |
| apiKey | The API key used to authenticate with Terrafir | true |
| email | The email address of the user who owns the API key | true |
| **WIP: verbose** | Whether or not to print the assessment to the Github Action output | false |

### Flow

Expand All @@ -33,6 +36,7 @@ flowchart TD
```

### Sample CI/CD Pipeline Using Terrafir Github Action

```yaml
name: Terrafir Test Action

Expand Down Expand Up @@ -113,4 +117,4 @@ jobs:
with:
email: ${{ secrets.TERRAFIR_EMAIL }}
apiKey: ${{ secrets.TERRAFIR_API_KEY }}
```
```
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func getEnv(key, defaultValue string) string {
return defaultValue
}
return value
}+
}

func main() {
preRequestCheck()
Expand Down

0 comments on commit b428118

Please sign in to comment.