Fix docs for LFS option of checkout action

bakdata · Nov 21, 2024 · 6be868b · 6be868b
1 parent 0075395
commit 6be868b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/actions/checkout/action.yaml b/actions/checkout/action.yaml
@@ -18,11 +18,11 @@ inputs:
     required: false
     default: "1"
   lfs:
-    description: "Describes if the repository is using any LFS files"
+    description: "Whether LFS files of the repository should be checked out"
     required: false
     default: "false"
   cache:
-    description: "Describes if the repository is using any LFS files"
+    description: "Whether LFS files should be cached. Only has an effect if lfs=true."
     required: false
     default: "true"
   submodules:
@@ -32,7 +32,7 @@ inputs:
 
 outputs:
   lfs-cache-hit:
-    description: "A boolean value to indicate an exact match was found for the key"
+    description: "Whether LFS files were retrieved from cache."
     value: ${{ steps.cache-lfs.outputs.cache-hit }}
 
 runs:

diff --git a/docs/actions/checkout/README.md b/docs/actions/checkout/README.md
@@ -34,9 +34,9 @@ steps:
 
 | INPUT               | TYPE   | REQUIRED | DEFAULT                      | DESCRIPTION                                                                                                      |
 | ------------------- | ------ | -------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| cache               | string | false    | `"true"`                     | Describes if the repository is using any LFS files                                                               |
+| cache               | string | false    | `"true"`                     | Whether LFS files should be cached. Only has an effect if lfs=true.                                              |
 | fetch-depth         | string | false    | `"1"`                        | Number of commits to fetch. 0 indicates all history for all branches and tags                                    |
-| lfs                 | string | false    | `"false"`                    | Describes if the repository is using any LFS files                                                               |
+| lfs                 | string | false    | `"false"`                    | Whether LFS files of the repository should be checked out                                                        |
 | persist-credentials | string | false    | `"true"`                     | Whether to configure the token or SSH key with the local git config                                              |
 | ref                 | string | false    |                              | The branch, tag or SHA to checkout                                                                               |
 | repository          | string | false    | `"${{ github.repository }}"` | The repository name with owner                                                                                   |
@@ -48,9 +48,9 @@ steps:
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
 
-| OUTPUT        | TYPE   | DESCRIPTION                                                      |
-| ------------- | ------ | ---------------------------------------------------------------- |
-| lfs-cache-hit | string | A boolean value to indicate an exact match was found for the key |
+| OUTPUT        | TYPE   | DESCRIPTION                                  |
+| ------------- | ------ | -------------------------------------------- |
+| lfs-cache-hit | string | Whether LFS files were retrieved from cache. |
 
 <!-- AUTO-DOC-OUTPUT:END -->