mirror of
https://github.com/actions/checkout
synced 2024-12-23 05:34:55 +00:00
add our feature
This commit is contained in:
parent
b4ffde65f4
commit
e72243fb91
7 changed files with 101 additions and 8 deletions
|
@ -29,6 +29,11 @@ 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
|
||||||
|
# exist. If this is set to true, then fetch-depth should be 0
|
||||||
|
# Default: true
|
||||||
|
default-ref-on-error: ''
|
||||||
|
|
||||||
# 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
|
||||||
# commands. The post-job step removes the PAT.
|
# commands. The post-job step removes the PAT.
|
||||||
|
|
|
@ -813,6 +813,8 @@ async function setup(testName: string): Promise<void> {
|
||||||
nestedSubmodules: false,
|
nestedSubmodules: false,
|
||||||
persistCredentials: true,
|
persistCredentials: true,
|
||||||
ref: 'refs/heads/main',
|
ref: 'refs/heads/main',
|
||||||
|
defaultRefOnError: true,
|
||||||
|
defaultBranch: 'main',
|
||||||
repositoryName: 'my-repo',
|
repositoryName: 'my-repo',
|
||||||
repositoryOwner: 'my-org',
|
repositoryOwner: 'my-org',
|
||||||
repositoryPath: '',
|
repositoryPath: '',
|
||||||
|
|
|
@ -9,6 +9,11 @@ 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:
|
||||||
|
description: >
|
||||||
|
Whether to checkout the default repository branch if specified ref does not exist.
|
||||||
|
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
|
||||||
|
|
32
dist/index.js
vendored
32
dist/index.js
vendored
|
@ -1226,6 +1226,17 @@ function getSource(settings) {
|
||||||
core.startGroup('Setting up auth');
|
core.startGroup('Setting up auth');
|
||||||
yield authHelper.configureAuth();
|
yield authHelper.configureAuth();
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
|
if (settings.defaultRefOnError && settings.defaultRefOnError === true) {
|
||||||
|
// Configure default branch
|
||||||
|
core.startGroup('Setting up default branch');
|
||||||
|
if (settings.sshKey) {
|
||||||
|
settings.defaultBranch = yield git.getDefaultBranch(repositoryUrl);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
settings.defaultBranch = yield githubApiHelper.getDefaultBranch(settings.authToken, settings.repositoryOwner, settings.repositoryName);
|
||||||
|
}
|
||||||
|
core.endGroup();
|
||||||
|
}
|
||||||
// Determine the default branch
|
// Determine the default branch
|
||||||
if (!settings.ref && !settings.commit) {
|
if (!settings.ref && !settings.commit) {
|
||||||
core.startGroup('Determining the default branch');
|
core.startGroup('Determining the default branch');
|
||||||
|
@ -1250,7 +1261,8 @@ function getSource(settings) {
|
||||||
else if (settings.sparseCheckout) {
|
else if (settings.sparseCheckout) {
|
||||||
fetchOptions.filter = 'blob:none';
|
fetchOptions.filter = 'blob:none';
|
||||||
}
|
}
|
||||||
if (settings.fetchDepth <= 0) {
|
if (settings.fetchDepth <= 0 ||
|
||||||
|
(settings.defaultRefOnError && settings.defaultRefOnError === true)) {
|
||||||
// Fetch all branches and tags
|
// Fetch all branches and tags
|
||||||
let refSpec = refHelper.getRefSpecForAllHistory(settings.ref, settings.commit);
|
let refSpec = refHelper.getRefSpecForAllHistory(settings.ref, settings.commit);
|
||||||
yield git.fetch(refSpec, fetchOptions);
|
yield git.fetch(refSpec, fetchOptions);
|
||||||
|
@ -1270,7 +1282,19 @@ function getSource(settings) {
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
// Checkout info
|
// Checkout info
|
||||||
core.startGroup('Determining the checkout info');
|
core.startGroup('Determining the checkout info');
|
||||||
const checkoutInfo = yield refHelper.getCheckoutInfo(git, settings.ref, settings.commit);
|
let checkoutInfo;
|
||||||
|
if (settings.defaultRefOnError && settings.defaultRefOnError === true) {
|
||||||
|
try {
|
||||||
|
checkoutInfo = yield refHelper.getCheckoutInfo(git, settings.ref, settings.commit);
|
||||||
|
}
|
||||||
|
catch (error) {
|
||||||
|
core.info('Could not determine the checkout info. Trying the default repo branch');
|
||||||
|
checkoutInfo = yield refHelper.getCheckoutInfo(git, settings.defaultBranch, settings.commit);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
checkoutInfo = yield refHelper.getCheckoutInfo(git, settings.ref, settings.commit);
|
||||||
|
}
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
// LFS fetch
|
// LFS fetch
|
||||||
// Explicit lfs-fetch to avoid slow checkout (fetches one lfs object at a time).
|
// Explicit lfs-fetch to avoid slow checkout (fetches one lfs object at a time).
|
||||||
|
@ -1724,6 +1748,10 @@ function getInputs() {
|
||||||
}
|
}
|
||||||
core.debug(`ref = '${result.ref}'`);
|
core.debug(`ref = '${result.ref}'`);
|
||||||
core.debug(`commit = '${result.commit}'`);
|
core.debug(`commit = '${result.commit}'`);
|
||||||
|
// Default ref on error
|
||||||
|
result.defaultRefOnError =
|
||||||
|
(core.getInput('default-ref-on-error') || 'true').toUpperCase() === 'TRUE';
|
||||||
|
core.debug(`default-ref-on-error = '${result.defaultRefOnError}'`);
|
||||||
// Clean
|
// Clean
|
||||||
result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE';
|
result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE';
|
||||||
core.debug(`clean = ${result.clean}`);
|
core.debug(`clean = ${result.clean}`);
|
||||||
|
|
|
@ -130,6 +130,21 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
|
||||||
await authHelper.configureAuth()
|
await authHelper.configureAuth()
|
||||||
core.endGroup()
|
core.endGroup()
|
||||||
|
|
||||||
|
if (settings.defaultRefOnError && settings.defaultRefOnError === true) {
|
||||||
|
// Configure default branch
|
||||||
|
core.startGroup('Setting up default branch')
|
||||||
|
if (settings.sshKey) {
|
||||||
|
settings.defaultBranch = await git.getDefaultBranch(repositoryUrl)
|
||||||
|
} else {
|
||||||
|
settings.defaultBranch = await githubApiHelper.getDefaultBranch(
|
||||||
|
settings.authToken,
|
||||||
|
settings.repositoryOwner,
|
||||||
|
settings.repositoryName
|
||||||
|
)
|
||||||
|
}
|
||||||
|
core.endGroup()
|
||||||
|
}
|
||||||
|
|
||||||
// Determine the default branch
|
// Determine the default branch
|
||||||
if (!settings.ref && !settings.commit) {
|
if (!settings.ref && !settings.commit) {
|
||||||
core.startGroup('Determining the default branch')
|
core.startGroup('Determining the default branch')
|
||||||
|
@ -166,7 +181,10 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
|
||||||
fetchOptions.filter = 'blob:none'
|
fetchOptions.filter = 'blob:none'
|
||||||
}
|
}
|
||||||
|
|
||||||
if (settings.fetchDepth <= 0) {
|
if (
|
||||||
|
settings.fetchDepth <= 0 ||
|
||||||
|
(settings.defaultRefOnError && settings.defaultRefOnError === true)
|
||||||
|
) {
|
||||||
// Fetch all branches and tags
|
// Fetch all branches and tags
|
||||||
let refSpec = refHelper.getRefSpecForAllHistory(
|
let refSpec = refHelper.getRefSpecForAllHistory(
|
||||||
settings.ref,
|
settings.ref,
|
||||||
|
@ -190,11 +208,31 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
|
||||||
|
|
||||||
// Checkout info
|
// Checkout info
|
||||||
core.startGroup('Determining the checkout info')
|
core.startGroup('Determining the checkout info')
|
||||||
const checkoutInfo = await refHelper.getCheckoutInfo(
|
let checkoutInfo: refHelper.ICheckoutInfo
|
||||||
|
if (settings.defaultRefOnError && settings.defaultRefOnError === true) {
|
||||||
|
try {
|
||||||
|
checkoutInfo = await refHelper.getCheckoutInfo(
|
||||||
git,
|
git,
|
||||||
settings.ref,
|
settings.ref,
|
||||||
settings.commit
|
settings.commit
|
||||||
)
|
)
|
||||||
|
} catch (error) {
|
||||||
|
core.info(
|
||||||
|
'Could not determine the checkout info. Trying the default repo branch'
|
||||||
|
)
|
||||||
|
checkoutInfo = await refHelper.getCheckoutInfo(
|
||||||
|
git,
|
||||||
|
settings.defaultBranch,
|
||||||
|
settings.commit
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
checkoutInfo = await refHelper.getCheckoutInfo(
|
||||||
|
git,
|
||||||
|
settings.ref,
|
||||||
|
settings.commit
|
||||||
|
)
|
||||||
|
}
|
||||||
core.endGroup()
|
core.endGroup()
|
||||||
|
|
||||||
// LFS fetch
|
// LFS fetch
|
||||||
|
|
|
@ -19,6 +19,16 @@ export interface IGitSourceSettings {
|
||||||
*/
|
*/
|
||||||
ref: string
|
ref: string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to checkout the default repository branch if specified ref does not exist.
|
||||||
|
*/
|
||||||
|
defaultRefOnError: boolean
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The target ref to fetch if it exists
|
||||||
|
*/
|
||||||
|
defaultBranch: string
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The commit to checkout
|
* The commit to checkout
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -78,6 +78,11 @@ export async function getInputs(): Promise<IGitSourceSettings> {
|
||||||
core.debug(`ref = '${result.ref}'`)
|
core.debug(`ref = '${result.ref}'`)
|
||||||
core.debug(`commit = '${result.commit}'`)
|
core.debug(`commit = '${result.commit}'`)
|
||||||
|
|
||||||
|
// Default ref on error
|
||||||
|
result.defaultRefOnError =
|
||||||
|
(core.getInput('default-ref-on-error') || 'true').toUpperCase() === 'TRUE'
|
||||||
|
core.debug(`default-ref-on-error = '${result.defaultRefOnError}'`)
|
||||||
|
|
||||||
// Clean
|
// Clean
|
||||||
result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE'
|
result.clean = (core.getInput('clean') || 'true').toUpperCase() === 'TRUE'
|
||||||
core.debug(`clean = ${result.clean}`)
|
core.debug(`clean = ${result.clean}`)
|
||||||
|
|
Loading…
Reference in a new issue