Skip to content

Commit 9e28b00

Browse files
authored
Rename file_path to file_name in automation docs (#763)
1 parent 3783951 commit 9e28b00

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/automation-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ This is a managed action, when PR updates, the existing comments added by gitStr
7575
| Args | Usage | Type | Description |
7676
| -----------|------|-----|------------------------------------------------ |
7777
| `comment` | Required | String | Sets the comment, markdown is supported, including suggestion syntax (```suggestion … ```) |
78-
| `file_path` | Required | String | The relative path to the file that necessitates the comment |
78+
| `file_name` | Required | String | The relative path to the file that necessitates the comment |
7979
| `start_line` | Optional | Integer | The line (or the first line in multi-line comment)of the blob in the pull request diff that the comment applies to. If start_line is empty, the code comment should be on the file provided |
8080
| `end_line` | Optional | Integer | For a multi-line comment, the last line of the range that your comment applies to. Must be equal to or larger than start_line |
8181

@@ -89,7 +89,7 @@ automations:
8989
run:
9090
- action: add-code-comment@v1
9191
args:
92-
file_path: <FILE>
92+
file_name: <FILE>
9393
start_line: 20
9494
comment: |
9595
Magic! Move it to a constant variable.

0 commit comments

Comments
 (0)