actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-12-27 01:30:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update action.yml and readme

Browse source
This commit is contained in:
alexanderkranga 2024-02-19 18:24:39 +02:00
parent 5bbdf118df
commit 47b9382799
3 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -29,10 +29,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# Otherwise, uses the default branch. # Otherwise, uses the default branch.
ref: '' ref: ''
# Whether to checkout the default repository branch if specified ref does not # Indicates whether to checkout the default repository branch if the requested ref
# exist. If this is set to true, then fetch-depth should be 0 # does not exist
# Default: true # Default: false
default-ref-on-error: '' default-branch-checkout: ''
# Personal access token (PAT) used to fetch the repository. The PAT is configured # Personal access token (PAT) used to fetch the repository. The PAT is configured
# with the local git config, which enables your scripts to run authenticated git # with the local git config, which enables your scripts to run authenticated git

8
action.yml
View file

@ -9,11 +9,9 @@ inputs:
The branch, tag or SHA to checkout. When checking out the repository that The branch, tag or SHA to checkout. When checking out the repository that
triggered a workflow, this defaults to the reference or SHA for that triggered a workflow, this defaults to the reference or SHA for that
event. Otherwise, uses the default branch. event. Otherwise, uses the default branch.
default-ref-on-error: default-branch-checkout:
description: > description: 'Indicates whether to checkout the default repository branch if the requested ref does not exist'
Whether to checkout the default repository branch if specified ref does not exist. default: false
If this is set to true, then fetch-depth should be 0
default: true
token: token:
description: > description: >
Personal access token (PAT) used to fetch the repository. The PAT is configured Personal access token (PAT) used to fetch the repository. The PAT is configured

3
dist/index.js vendored
View file

@ -1741,7 +1741,8 @@ function getInputs() {
core.debug(`commit = '${result.commit}'`); core.debug(`commit = '${result.commit}'`);
// Default branch checkout // Default branch checkout
result.defaultBranchCheckout = result.defaultBranchCheckout =
(core.getInput('default-branch-checkout') || 'true').toUpperCase() === 'TRUE'; (core.getInput('default-branch-checkout') || 'true').toUpperCase() ===
'TRUE';
core.debug(`default-branch-checkout = '${result.defaultBranchCheckout}'`); core.debug(`default-branch-checkout = '${result.defaultBranchCheckout}'`);
// Clean // Clean
result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE'; result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE';