Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for LFS option of checkout action #223

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Fix docs for LFS option of checkout action #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions actions/checkout/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions docs/actions/checkout/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 -->

Expand Down