From ca40bfa3cc989a529a9101bbd69d46e511ea3524 Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Sun, 27 Jul 2025 18:59:57 +0300 Subject: [PATCH] Rename `file_path` to `file_name` in automation docs --- docs/automation-actions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/automation-actions.md b/docs/automation-actions.md index 405edc5a..1ad614d0 100644 --- a/docs/automation-actions.md +++ b/docs/automation-actions.md @@ -75,7 +75,7 @@ This is a managed action, when PR updates, the existing comments added by gitStr | Args | Usage | Type | Description | | -----------|------|-----|------------------------------------------------ | | `comment` | Required | String | Sets the comment, markdown is supported, including suggestion syntax (```suggestion … ```) | -| `file_path` | Required | String | The relative path to the file that necessitates the comment | +| `file_name` | Required | String | The relative path to the file that necessitates the comment | | `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 | | `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 | @@ -89,7 +89,7 @@ automations: run: - action: add-code-comment@v1 args: - file_path: + file_name: start_line: 20 comment: | Magic! Move it to a constant variable.