Rename skip-checkout to checkout

grafana · May 2, 2024 · dfa05b6 · dfa05b6
1 parent 812dbef
commit dfa05b6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/.github/workflows/publish-techdocs.yaml b/.github/workflows/publish-techdocs.yaml
@@ -64,7 +64,7 @@ jobs:
           repo-url: "https://github.com/${{ github.repository }}"
           default-branch: "${{ github.event.repository.default_branch }}"
           dry-run: "${{ inputs.rewrite-relative-links-dry-run }}"
-          skip-checkout: true
+          checkout: false
           checkout-path: _shared-workflows
 
       - id: auth

diff --git a/actions/techdocs-rewrite-relative-links/README.md b/actions/techdocs-rewrite-relative-links/README.md
@@ -56,5 +56,5 @@ Follow that up with the actions that should publish the docs to EngHub. See [the
 | `repo-url` (required) | string | Full URL to the GitHub repository |
 | `working-directory` (required) | string | Directory containing the `mkdocs.yml` file |
 | `dry-run` | boolean | Do not modify the files but print a diff |
-| `checkout-path` (default: `_action`) | string | Folder where the repository should be checked out to for running the action |
-| `skip-checkout` (default: `false`) | boolean | If the workflow already checks out the shared-workflows repository, you can skip the additional checkout inside the action |
+| `checkout-path` (default: `_action`) | string | Folder where the repository should be checked out to for running the action or where a checkout already exists |
+| `checkout` (default: `true`) | boolean | If the workflow already checks out the shared-workflows repository, you can set this to false |
diff --git a/actions/techdocs-rewrite-relative-links/action.yaml b/actions/techdocs-rewrite-relative-links/action.yaml
@@ -18,15 +18,20 @@ inputs:
     required: false
     default: false
   checkout-path:
+    description: |
+      Path where the action checks out its own code. If you disable the
+      checkout, make sure to set this to where a previous checkout has been
+      made to.
     type: string
     default: _action
     required: false
-  skip-checkout:
+  checkout:
     description: |
-      If the action is already present in the workspace you can skip another checkout.
+      By default this action checks out its own code. If you want to skip this,
+      set to false.
     type: boolean
     required: false
-    default: false
+    default: true
 
 runs:
   using: composite