Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updated readme #70

Closed
wants to merge 1 commit into from
Closed

chore: updated readme #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,15 @@ Implementing this Action is _super_ simple and the comments are consise and easy
- Logs all the changed resources found in the plan to the action output.

## Example usage

Single plan file:
```yaml
uses: liatrio/[email protected]
with:
json-file: my-tfplan.json
expand-comment: 'true'
```

Multiple plan files:
```yaml
uses: liatrio/[email protected]
Expand All @@ -102,6 +104,7 @@ with:
core-infra-tfplan.json
shared-infra-tfplan.json
```

Include plan output to the Actions workflow job summary:
```yaml
uses: liatrio/[email protected]
Expand All @@ -110,8 +113,10 @@ with:
expand-comment: 'true'
include-plan-job-summary: 'true'
```

**Note:**
- When `include-plan-job-summary = true`, if the action is executed in non-Pull Request workflows, the plan output will also be posted to the job summary of that run. If you do not wish to have this behavior, apply conditional logic to your workflow file.

#### Example Job Summary Output
![Plan output job summary](assets/plan-output-job-summary.png)

Expand Down