Skip to content

Commit 7ebb69e

Browse files
committed
chore: update README.md
1 parent 1c97277 commit 7ebb69e

File tree

1 file changed

+5
-32
lines changed

1 file changed

+5
-32
lines changed

README.md

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22

33
<!-- markdownlint-disable -->
44
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/github-action-atmos-terraform-plan/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5-
<p align="right">
6-
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/github-action-atmos-terraform-plan.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a>
8+
9+
</p>
710
<!-- markdownlint-restore -->
811

912
<!--
@@ -405,36 +408,6 @@ Which would produce the same behavior as in `v1`, doing this:
405408

406409

407410

408-
<!-- markdownlint-disable -->
409-
410-
## Inputs
411-
412-
| Name | Description | Default | Required |
413-
|------|-------------|---------|----------|
414-
| atmos-config-path | The path to the atmos.yaml file | N/A | true |
415-
| atmos-version | The version of atmos to install | >= 1.158.0 | false |
416-
| branding-logo-image | Branding logo image url | https://cloudposse.com/logo-300x69.svg | false |
417-
| branding-logo-url | Branding logo url | https://cloudposse.com/ | false |
418-
| component | The name of the component to plan. | N/A | true |
419-
| debug | Enable action debug mode. Default: 'false' | false | false |
420-
| drift-detection-mode-enabled | Indicate whether this action is used in drift detection workflow. | false | true |
421-
| infracost-api-key | Infracost API key | N/A | false |
422-
| metadata-retention-days | Infracost API key | 1 | false |
423-
| pr-comment | Set to 'true' to create a PR comment with the summary of the plan | false | false |
424-
| sha | Commit SHA to plan. Default: github.sha | ${{ github.event.pull\_request.head.sha }} | true |
425-
| skip-checkout | Disable actions/checkout. Useful for when the checkout happens in a previous step and file are modified outside of git through other actions | false | false |
426-
| stack | The stack name for the given component. | N/A | true |
427-
| token | Used to pull node distributions for Atmos from Cloud Posse's GitHub repository. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ${{ github.server\_url == 'https://github.com' && github.token \|\| '' }} | false |
428-
429-
430-
## Outputs
431-
432-
| Name | Description |
433-
|------|-------------|
434-
| plan\_file | Path to the terraform plan file |
435-
| plan\_json | Path to the terraform plan in JSON format |
436-
| summary | Summary |
437-
<!-- markdownlint-restore -->
438411

439412

440413
## Related Projects

0 commit comments

Comments
 (0)