Skip to content

Commit d191643

Browse files
authored
docs: Fix formatting in README (#4)
1 parent ca0d899 commit d191643

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# terraform-plan-comment
22

3-
GitHub Action to post the output of `terraform plan` to a PR comment.
3+
GitHub Action to post the output of `terraform plan` to a pull request comment.
44

55
## Features
66

@@ -65,7 +65,9 @@ unless `terraform` cannot be found in the `PATH`.
6565
The directory where the Terraform binary ought to be called. Defaults to `$GITHUB_WORKSPACE` and _must_ be specified if
6666
`terraform init` has been run in a different directory. Should be specified relative to `$GITHUB_WORKSPACE`.
6767

68-
> [!IMPORTANT] > `planfile` must be specified relative to the working directory.
68+
<!-- prettier-ignore -->
69+
> [!IMPORTANT]
70+
> `planfile` must be specified relative to the working directory.
6971

7072
### `id`
7173

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Terraform Plan Comment
2-
description: Post the output of `terraform plan` to a PR comment.
2+
description: Post the output of `terraform plan` to a pull request comment.
33
author: Oliver Borchert
44
branding:
5-
icon: type
5+
icon: git-pull-request
66
color: purple
77
inputs:
88
token:

0 commit comments

Comments
 (0)