Skip to content

feat(3333): Add skip git clone variable [2] #248

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

Merged
merged 12 commits into from
Jun 26, 2025
Merged

feat(3333): Add skip git clone variable [2] #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
316e065
refactoring
yakanechi Jun 23, 2025
d86c2ab
skip clone
yakanechi Jun 23, 2025
8c50a9f
fix trim
yakanechi Jun 24, 2025
c8f31cc
fix trim
yakanechi Jun 24, 2025
7fecb17
fix brackets
yakanechi Jun 24, 2025
dd69b10
Merge branch 'refactoring-for-skip-clone' of github.com:sonic-screwdr…
yakanechi Jun 24, 2025
0fb4ff0
fix echo text
yakanechi Jun 24, 2025
d596d52
fix semicolon
yakanechi Jun 24, 2025
1efab46
fix pr and if
yakanechi Jun 24, 2025
a7c85e6
Merge branch 'master' into skip-clone
yakanechi Jun 25, 2025
1d289cf
fix check git
yakanechi Jun 26, 2025
e0c9359
fix test
yakanechi Jun 26, 2025
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
168 changes: 98 additions & 70 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,8 @@ class GithubScm extends Scm {
// Set sparse option
trimIndentJoin([
'if [ ! -z "$GIT_SPARSE_CHECKOUT_PATH" ]; then',
' export GIT_SPARSE_OPTION="--no-checkout";else',
' export GIT_SPARSE_OPTION="--no-checkout";',
'else',
' export GIT_SPARSE_OPTION="";',
'fi'
])
Expand Down Expand Up @@ -746,9 +747,15 @@ class GithubScm extends Scm {
'fi'
]),
// Set config
'echo Setting user name and user email',
`$SD_GIT_WRAPPER "git config --global user.name ${this.config.username}"`,
`$SD_GIT_WRAPPER "git config --global user.email ${this.config.email}"`,
trimIndentJoin([
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ] && ! $SD_GIT_WRAPPER "git -v" >/dev/null 2>&1; then',
` echo 'Skipping git config';`,
'else',
' echo "Setting user name and user email";',
` $SD_GIT_WRAPPER "git config --global user.name ${this.config.username}";`,
` $SD_GIT_WRAPPER "git config --global user.email ${this.config.email}";`,
'fi'
]),
// Set final checkout dir, default to SD_SOURCE_DIR for backward compatibility
'export SD_CHECKOUT_DIR_FINAL=$SD_SOURCE_DIR',
trimIndentJoin([
Expand Down Expand Up @@ -778,35 +785,37 @@ class GithubScm extends Scm {
]),
// Git clone
`export SD_CONFIG_DIR=${externalConfigDir}`,
`echo 'Cloning external config repo ${parentCheckoutUrl}'`,
trimIndentJoin([
'if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git clone $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${escapedParentBranch}' $CONFIG_URL $SD_CONFIG_DIR";`,
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ]; then',
` echo 'Skipping cloning ${checkoutUrl}, on branch ${singleQuoteEscapedBranch}';`,
'else',
' if [ ! -z "$GIT_SHALLOW_CLONE_SINCE" ]; then',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--shallow-since=\'$GIT_SHALLOW_CLONE_SINCE\'";',
` echo 'Cloning external config repo ${parentCheckoutUrl}';`,
' if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git clone $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${escapedParentBranch}' $CONFIG_URL $SD_CONFIG_DIR";`,
' else',
' if [ -z $GIT_SHALLOW_CLONE_DEPTH ]; then',
' export GIT_SHALLOW_CLONE_DEPTH=50;',
' if [ ! -z "$GIT_SHALLOW_CLONE_SINCE" ]; then',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--shallow-since=\'$GIT_SHALLOW_CLONE_SINCE\'";',
' else',
' if [ -z $GIT_SHALLOW_CLONE_DEPTH ]; then',
' export GIT_SHALLOW_CLONE_DEPTH=50;',
' fi;',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--depth=$GIT_SHALLOW_CLONE_DEPTH";',
' fi;',
' export GIT_SHALLOW_CLONE_BRANCH="--no-single-branch";',
' if [ "$GIT_SHALLOW_CLONE_SINGLE_BRANCH" = true ]; then',
' export GIT_SHALLOW_CLONE_BRANCH="";',
' fi;',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--depth=$GIT_SHALLOW_CLONE_DEPTH";',
` $SD_GIT_WRAPPER "git clone $GIT_SHALLOW_CLONE_DEPTH_OPTION $GIT_SHALLOW_CLONE_BRANCH $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${escapedParentBranch}' $CONFIG_URL $SD_CONFIG_DIR";`,
' fi;',
' export GIT_SHALLOW_CLONE_BRANCH="--no-single-branch";',
' if [ "$GIT_SHALLOW_CLONE_SINGLE_BRANCH" = true ]; then',
' export GIT_SHALLOW_CLONE_BRANCH="";',
// Sparse Checkout
' if [ ! -z "$GIT_SPARSE_CHECKOUT_PATH" ]; then',
' $SD_GIT_WRAPPER "git sparse-checkout set $GIT_SPARSE_CHECKOUT_PATH" && $SD_GIT_WRAPPER "git checkout";',
' fi;',
` $SD_GIT_WRAPPER "git clone $GIT_SHALLOW_CLONE_DEPTH_OPTION $GIT_SHALLOW_CLONE_BRANCH $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${escapedParentBranch}' $CONFIG_URL $SD_CONFIG_DIR";`,
'fi'
]),
// Sparse Checkout
trimIndentJoin([
'if [ ! -z "$GIT_SPARSE_CHECKOUT_PATH" ];then',
' $SD_GIT_WRAPPER "git sparse-checkout set $GIT_SPARSE_CHECKOUT_PATH" && $SD_GIT_WRAPPER "git checkout";',
// Reset to SHA
` $SD_GIT_WRAPPER "git -C $SD_CONFIG_DIR reset --hard ${config.parentConfig.sha} --";`,
` echo Reset external config repo to ${config.parentConfig.sha};`,
'fi'
]),
// Reset to SHA
`$SD_GIT_WRAPPER "git -C $SD_CONFIG_DIR reset --hard ${config.parentConfig.sha} --"`,
`echo Reset external config repo to ${config.parentConfig.sha}`
])
);
}

Expand Down Expand Up @@ -854,47 +863,49 @@ class GithubScm extends Scm {
const resetEchoSha = config.prRef ? singleQuoteEscapedBranch : config.sha;

command.push(
// Git clone
`echo 'Cloning ${checkoutUrl}, on branch ${singleQuoteEscapedBranch}'`,
trimIndentJoin([
'if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git clone $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${doubleQuoteEscapedBranch}' $SCM_URL $SD_CHECKOUT_DIR_FINAL";`,
// Git clone
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ]; then',
` echo 'Skipping cloning ${checkoutUrl}, on branch ${singleQuoteEscapedBranch}';`,
'else',
' if [ ! -z "$GIT_SHALLOW_CLONE_SINCE" ]; then',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--shallow-since=\'$GIT_SHALLOW_CLONE_SINCE\'";',
` echo 'Cloning ${checkoutUrl}, on branch ${singleQuoteEscapedBranch}';`,
' if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git clone $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${doubleQuoteEscapedBranch}' $SCM_URL $SD_CHECKOUT_DIR_FINAL";`,
' else',
' if [ -z $GIT_SHALLOW_CLONE_DEPTH ]; then',
' export GIT_SHALLOW_CLONE_DEPTH=50;',
' if [ ! -z "$GIT_SHALLOW_CLONE_SINCE" ]; then',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--shallow-since=\'$GIT_SHALLOW_CLONE_SINCE\'";',
' else',
' if [ -z $GIT_SHALLOW_CLONE_DEPTH ]; then',
' export GIT_SHALLOW_CLONE_DEPTH=50;',
' fi;',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--depth=$GIT_SHALLOW_CLONE_DEPTH";',
' fi;',
' export GIT_SHALLOW_CLONE_BRANCH="--no-single-branch";',
' if [ "$GIT_SHALLOW_CLONE_SINGLE_BRANCH" = true ]; then',
' export GIT_SHALLOW_CLONE_BRANCH="";',
' fi;',
' export GIT_SHALLOW_CLONE_DEPTH_OPTION="--depth=$GIT_SHALLOW_CLONE_DEPTH";',
` $SD_GIT_WRAPPER "git clone $GIT_SHALLOW_CLONE_DEPTH_OPTION $GIT_SHALLOW_CLONE_BRANCH $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${doubleQuoteEscapedBranch}' $SCM_URL $SD_CHECKOUT_DIR_FINAL";`,
' fi;',
' export GIT_SHALLOW_CLONE_BRANCH="--no-single-branch";',
' if [ "$GIT_SHALLOW_CLONE_SINGLE_BRANCH" = true ]; then',
' export GIT_SHALLOW_CLONE_BRANCH="";',
// Sparse Checkout
' if [ ! -z "$GIT_SPARSE_CHECKOUT_PATH" ]; then',
' $SD_GIT_WRAPPER "git sparse-checkout set $GIT_SPARSE_CHECKOUT_PATH" && $SD_GIT_WRAPPER "git checkout";',
' fi;',
` $SD_GIT_WRAPPER "git clone $GIT_SHALLOW_CLONE_DEPTH_OPTION $GIT_SHALLOW_CLONE_BRANCH $GIT_SPARSE_OPTION $GIT_RECURSIVE_OPTION --quiet --progress --branch '${doubleQuoteEscapedBranch}' $SCM_URL $SD_CHECKOUT_DIR_FINAL";`,
'fi'
]),
// Sparse Checkout
trimIndentJoin([
'if [ ! -z "$GIT_SPARSE_CHECKOUT_PATH" ];then',
' $SD_GIT_WRAPPER "git sparse-checkout set $GIT_SPARSE_CHECKOUT_PATH" && $SD_GIT_WRAPPER "git checkout";',
// Reset to SHA
...(!config.prRef
? [
trimIndentJoin([
'if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git fetch origin '${config.sha}'";`,
'else',
` $SD_GIT_WRAPPER "git fetch $GIT_SHALLOW_CLONE_DEPTH_OPTION origin '${config.sha}'";`,
'fi;'
])
]
: []),
` $SD_GIT_WRAPPER "git reset --hard '${resetSha}' --";`,
` echo 'Reset to ${resetEchoSha}';`,
'fi'
]),
// Reset to SHA
...(!config.prRef
? [
trimIndentJoin([
'if [ ! -z $GIT_SHALLOW_CLONE ] && [ $GIT_SHALLOW_CLONE = false ]; then',
` $SD_GIT_WRAPPER "git fetch origin '${config.sha}'";`,
'else',
` $SD_GIT_WRAPPER "git fetch $GIT_SHALLOW_CLONE_DEPTH_OPTION origin '${config.sha}'";`,
'fi'
])
]
: []),
`$SD_GIT_WRAPPER "git reset --hard '${resetSha}' --"`,
`echo 'Reset to ${resetEchoSha}'`
])
);
}

Expand All @@ -908,14 +919,20 @@ class GithubScm extends Scm {

// Fetch a pull request
command.push(
`echo 'Fetching PR ${prRef}'`,
`$SD_GIT_WRAPPER "git fetch origin ${prRef}"`,
`export PR_BASE_BRANCH_NAME='${singleQuoteEscapedBranch}'`,
`export PR_BRANCH_NAME='${baseRepo}/${singleQuoteEscapedPrBranch}'`,
`echo 'Checking out the PR branch ${singleQuoteEscapedPrBranch}'`,
`$SD_GIT_WRAPPER "git checkout ${LOCAL_BRANCH_NAME}"`,
`$SD_GIT_WRAPPER "git merge '${doubleQuoteEscapedBranch}'"`,
`export GIT_BRANCH=origin/refs/${prRef}`
`export GIT_BRANCH=origin/refs/${prRef}`,
trimIndentJoin([
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ]; then',
` echo 'Skipping fetching PR ${prRef}';`,
'else',
` echo 'Fetching PR ${prRef}';`,
` $SD_GIT_WRAPPER "git fetch origin ${prRef}";`,
` echo 'Checking out the PR branch ${singleQuoteEscapedPrBranch}';`,
` $SD_GIT_WRAPPER "git checkout ${LOCAL_BRANCH_NAME}";`,
` $SD_GIT_WRAPPER "git merge '${doubleQuoteEscapedBranch}'";`,
'fi'
])
);
} else {
command.push(`export GIT_BRANCH='origin/${singleQuoteEscapedBranch}'`);
Expand All @@ -925,10 +942,14 @@ class GithubScm extends Scm {
// Init & Update submodule only when sd-repo is not used
command.push(
trimIndentJoin([
'if [ ! -z $GIT_RECURSIVE_CLONE ] && [ $GIT_RECURSIVE_CLONE = false ]; then',
' $SD_GIT_WRAPPER "git submodule init";',
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ]; then',
` echo 'Skipping submodule init and update';`,
'else',
' $SD_GIT_WRAPPER "git submodule update --init --recursive";',
' if [ ! -z $GIT_RECURSIVE_CLONE ] && [ $GIT_RECURSIVE_CLONE = false ]; then',
' $SD_GIT_WRAPPER "git submodule init";',
' else',
' $SD_GIT_WRAPPER "git submodule update --init --recursive";',
' fi;',
'fi'
])
);
Expand All @@ -939,7 +960,14 @@ class GithubScm extends Scm {
// The path is then wrapped in single quotes to safely change directories using the 'cd' command.
const escapedRootDir = config.rootDir.replace(/'/g, "'\\''");

command.push(`cd '${escapedRootDir}'`);
command.push(
trimIndentJoin([
'if [ ! -z $SD_SKIP_REPOSITORY_CLONE ] && [ $SD_SKIP_REPOSITORY_CLONE = true ]; then',
` mkdir -p ${escapedRootDir};`,
'fi'
]),
`cd '${escapedRootDir}'`
);
}
}

Expand Down
Loading