chore: updates descriptions on actions inputs to be more precise (#184)

Signed-off-by: Jennifer Power <[email protected]>
RedHatProductSecurity · Mar 7, 2024 · 6d42bb4 · 6d42bb4
1 parent c83754f
commit 6d42bb4
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 22 deletions.
diff --git a/actions/autosync/README.md b/actions/autosync/README.md
@@ -29,18 +29,18 @@ name: Example Workflow
 | github_token | GitHub token used to make authenticated API requests | None | False |
 | skip_assemble | Skip assembly task. Defaults to false | false | False |
 | skip_regenerate | Skip regenerate task. Defaults to false. | false | False |
-| skip_items | Comma-separated glob patterns list of content by Trestle name to skip during task execution. For example `profile_x,profile_y*,`. | None | False |
+| skip_items | Comma-separated glob patterns list of content by trestle name to skip during task execution. For example `profile_x,profile_y*,`. | None | False |
 | ssp_index_path | Path relative to the repository path where the ssp index is located. See action README.md for information about the ssp index. | ssp-index.json | False |
-| commit_message | Commit message | Sync automatic updates | False |
+| commit_message | Custom commit message | Sync automatic updates | False |
 | pull_request_title | Custom pull request title | Automatic updates from trestlebot | False |
 | branch | Name of the Git branch to which modifications should be pushed. Required if Action is used on the `pull_request` event. | ${{ github.ref_name }} | False |
 | target_branch | Target branch (or base branch) to create a pull request against. If unset, no pull request will be created. If set, a pull request will be created using the `branch` field as the head branch. | None | False |
 | file_pattern | Comma separated file pattern list used for `git add`. For example `component-definitions/*,*json`. Defaults to (`.`) | . | False |
-| repository | Local file path to the git repository. Defaults to the current directory (`.`) | . | False |
-| commit_user_name | Name used for the commit user | github-actions[bot] | False |
+| repository | Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. | . | False |
+| commit_user_name | Name used for the commit user. | github-actions[bot] | False |
 | commit_user_email | Email address used for the commit user | 41898282+github-actions[bot]@users.noreply.github.com | False |
 | commit_author_name | Name used for the commit author. Defaults to the username of whoever triggered this workflow run. | ${{ github.actor }} | False |
-| commit_author_email | Email address used for the commit author. Defaults to the email of whoever triggered this workflow run. | ${{ github.actor }}@users.noreply.github.com | False |
+| commit_author_email | Email address used for the commit author. | ${{ github.actor }}@users.noreply.github.com | False |
 | verbose | Enable verbose logging | false | False |
 
 <!-- END_ACTION_INPUTS -->

diff --git a/actions/autosync/action.yml b/actions/autosync/action.yml
@@ -25,14 +25,14 @@ inputs:
     required: false
     default: "false"
   skip_items:
-    description: "Comma-separated glob patterns list of content by Trestle name to skip during task execution. For example `profile_x,profile_y*,`."
+    description: "Comma-separated glob patterns list of content by trestle name to skip during task execution. For example `profile_x,profile_y*,`."
     required: false
   ssp_index_path:
     description: Path relative to the repository path where the ssp index is located. See action README.md for information about the ssp index.
     required: false
     default: "ssp-index.json"
   commit_message:
-    description: Commit message
+    description: Custom commit message
     required: false
     default: "Sync automatic updates"
   pull_request_title:
@@ -51,11 +51,11 @@ inputs:
     required: false
     default: '.'
   repository:
-    description: Local file path to the git repository. Defaults to the current directory (`.`)
+    description: Local file path to the git repository with a valid trestle project root relative to the GitHub workspace.
     required: false
     default: '.'
   commit_user_name:
-    description: Name used for the commit user
+    description: Name used for the commit user.
     required: false
     default: github-actions[bot]
   commit_user_email:
@@ -67,7 +67,7 @@ inputs:
     required: false
     default: ${{ github.actor }}
   commit_author_email:
-    description: Email address used for the commit author. Defaults to the email of whoever triggered this workflow run.
+    description: Email address used for the commit author.
     required: false
     default: ${{ github.actor }}@users.noreply.github.com
   verbose:

diff --git a/actions/create-cd/README.md b/actions/create-cd/README.md
@@ -38,11 +38,11 @@ name: Example Workflow
 | branch | Name of the Git branch to which modifications should be pushed. Required if Action is used on the `pull_request` event. | ${{ github.ref_name }} | False |
 | target_branch | Target branch (or base branch) to create a pull request against. If unset, no pull request will be created. If set, a pull request will be created using the `branch` field as the head branch. | None | False |
 | file_pattern | Comma separated file pattern list used for `git add`. For example `component-definitions/*,*json`. Defaults to (`.`) | . | False |
-| repository | Local file path to the git repository. Defaults to the current directory (`.`) | . | False |
+| repository | Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`) | . | False |
 | commit_user_name | Name used for the commit user | github-actions[bot] | False |
 | commit_user_email | Email address used for the commit user | 41898282+github-actions[bot]@users.noreply.github.com | False |
 | commit_author_name | Name used for the commit author. Defaults to the username of whoever triggered this workflow run. | ${{ github.actor }} | False |
-| commit_author_email | Email address used for the commit author. Defaults to the email of whoever triggered this workflow run. | ${{ github.actor }}@users.noreply.github.com | False |
+| commit_author_email | Email address used for the commit author. | ${{ github.actor }}@users.noreply.github.com | False |
 | verbose | Enable verbose logging | false | False |
 
 <!-- END_ACTION_INPUTS -->

diff --git a/actions/create-cd/action.yml b/actions/create-cd/action.yml
@@ -48,7 +48,7 @@ inputs:
     required: false
     default: '.'
   repository:
-    description: Local file path to the git repository. Defaults to the current directory (`.`)
+    description: Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`)
     required: false
     default: '.'
   commit_user_name:
@@ -64,7 +64,7 @@ inputs:
     required: false
     default: ${{ github.actor }}
   commit_author_email:
-    description: Email address used for the commit author. Defaults to the email of whoever triggered this workflow run.
+    description: Email address used for the commit author.
     required: false
     default: ${{ github.actor }}@users.noreply.github.com
   verbose:

diff --git a/actions/rules-transform/README.md b/actions/rules-transform/README.md
@@ -40,11 +40,11 @@ With custom rules directory:
 | branch | Name of the Git branch to which modifications should be pushed. Required if Action is used on the `pull_request` event. | ${{ github.ref_name }} | False |
 | target_branch | Target branch (or base branch) to create a pull request against. If unset, no pull request will be created. If set, a pull request will be created using the `branch` field as the head branch. | None | False |
 | file_pattern | Comma separated file pattern list used for `git add`. For example `component-definitions/*,*json`. Defaults to (`.`) | . | False |
-| repository | Local file path to the git repository. Defaults to the current directory (`.`) | . | False |
+| repository | Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`) | . | False |
 | commit_user_name | Name used for the commit user | github-actions[bot] | False |
 | commit_user_email | Email address used for the commit user | 41898282+github-actions[bot]@users.noreply.github.com | False |
 | commit_author_name | Name used for the commit author. Defaults to the username of whoever triggered this workflow run. | ${{ github.actor }} | False |
-| commit_author_email | Email address used for the commit author. Defaults to the email of whoever triggered this workflow run. | ${{ github.actor }}@users.noreply.github.com | False |
+| commit_author_email | Email address used for the commit author. | ${{ github.actor }}@users.noreply.github.com | False |
 | verbose | Enable verbose logging | false | False |
 
 <!-- END_ACTION_INPUTS -->

diff --git a/actions/rules-transform/action.yml b/actions/rules-transform/action.yml
@@ -33,7 +33,7 @@ inputs:
     required: false
     default: '.'
   repository:
-    description: Local file path to the git repository. Defaults to the current directory (`.`)
+    description: Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`)
     required: false
     default: '.'
   commit_user_name:
@@ -49,7 +49,7 @@ inputs:
     required: false
     default: ${{ github.actor }}
   commit_author_email:
-    description: Email address used for the commit author. Defaults to the email of whoever triggered this workflow run.
+    description: Email address used for the commit author.
     required: false
     default: ${{ github.actor }}@users.noreply.github.com
   verbose:

diff --git a/actions/sync-upstreams/README.md b/actions/sync-upstreams/README.md
@@ -32,11 +32,11 @@ name: Example Workflow
 | branch | Name of the Git branch to which modifications should be pushed. Required if Action is used on the `pull_request` event. | ${{ github.ref_name }} | False |
 | target_branch | Target branch (or base branch) to create a pull request against. If unset, no pull request will be created. If set, a pull request will be created using the `branch` field as the head branch. | None | False |
 | file_pattern | Comma-separated file pattern list used for `git add`. For example `component-definitions/*,*json`. Defaults to (`.`) | . | False |
-| repository | Local file path to the git repository. Defaults to the current directory (`.`) | . | False |
+| repository | Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`) | . | False |
 | commit_user_name | Name used for the commit user | github-actions[bot] | False |
 | commit_user_email | Email address used for the commit user | 41898282+github-actions[bot]@users.noreply.github.com | False |
 | commit_author_name | Name used for the commit author. Defaults to the username of whoever triggered this workflow run. | ${{ github.actor }} | False |
-| commit_author_email | Email address used for the commit author. Defaults to the email of whoever triggered this workflow run. | ${{ github.actor }}@users.noreply.github.com | False |
+| commit_author_email | Email address used for the commit author. | ${{ github.actor }}@users.noreply.github.com | False |
 | verbose | Enable verbose logging | false | False |
 
 <!-- END_ACTION_INPUTS -->

diff --git a/actions/sync-upstreams/action.yml b/actions/sync-upstreams/action.yml
@@ -39,7 +39,7 @@ inputs:
     required: false
     default: '.'
   repository:
-    description: Local file path to the git repository. Defaults to the current directory (`.`)
+    description: Local file path to the git repository with a valid trestle project root relative to the GitHub workspace. Defaults to the current directory (`.`)
     required: false
     default: '.'
   commit_user_name:
@@ -55,7 +55,7 @@ inputs:
     required: false
     default: ${{ github.actor }}
   commit_author_email:
-    description: Email address used for the commit author. Defaults to the email of whoever triggered this workflow run.
+    description: Email address used for the commit author.
     required: false
     default: ${{ github.actor }}@users.noreply.github.com
   verbose: