From 2bd5ef5487b953b5db186c7a68dcab4e4a8fe3fc Mon Sep 17 00:00:00 2001 From: Gonzalo Peci Date: Thu, 14 Dec 2023 14:53:04 +0100 Subject: [PATCH] Allow configuration of submodule.fetchJobs --- .github/workflows/test.yml | 15 +- README.md | 6 + __test__/git-auth-helper.test.ts | 1 + __test__/verify-submodules-with-jobs.sh | 33 ++++ action.yml | 204 ++++++++++++------------ dist/index.js | 3 + flake.lock | 78 +++++++++ flake.nix | 25 +++ src/git-source-provider.ts | 1 + src/git-source-settings.ts | 5 + src/input-helper.ts | 2 + 11 files changed, 271 insertions(+), 102 deletions(-) create mode 100755 __test__/verify-submodules-with-jobs.sh create mode 100644 flake.lock create mode 100644 flake.nix diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 15996ee..bccfe74 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -150,6 +150,17 @@ jobs: - name: Verify submodules recursive run: __test__/verify-submodules-recursive.sh + # Submodules fetchJobs + - name: Checkout submodules true + uses: ./ + with: + ref: test-data/v2/submodule-ssh-url + path: submodules-true + submodules: recursive + submodulesFetchJobs: "10" + - name: Verify submodules true + run: __test__/verify-submodules-with-jobs.sh + # Basic checkout using REST API - name: Remove basic if: runner.os != 'windows' @@ -242,7 +253,7 @@ jobs: path: basic - name: Verify basic run: __test__/verify-basic.sh --archive - + test-git-container: runs-on: ubuntu-latest container: bitnami/git:latest @@ -279,4 +290,4 @@ jobs: - name: Fix Checkout v3 uses: actions/checkout@v3 with: - path: v3 \ No newline at end of file + path: v3 diff --git a/README.md b/README.md index bfecf46..c4c618e 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/ # Default: false submodules: '' + # Specifies how many submodules are fetched/cloned at the same time. A positive + # integer allows up to that number of submodules fetched in parallel. A value of 0 + # will give some reasonable default. If unset, it defaults to 1. + # Default: 1 + submodulesFetchJobs: '' + # Add repository path as safe.directory for Git global config by running `git # config --global --add safe.directory ` # Default: true diff --git a/__test__/git-auth-helper.test.ts b/__test__/git-auth-helper.test.ts index 411faed..94924f1 100644 --- a/__test__/git-auth-helper.test.ts +++ b/__test__/git-auth-helper.test.ts @@ -811,6 +811,7 @@ async function setup(testName: string): Promise { lfs: false, submodules: false, nestedSubmodules: false, + submodulesFetchJobs: '1', persistCredentials: true, ref: 'refs/heads/main', repositoryName: 'my-repo', diff --git a/__test__/verify-submodules-with-jobs.sh b/__test__/verify-submodules-with-jobs.sh new file mode 100755 index 0000000..45ccec8 --- /dev/null +++ b/__test__/verify-submodules-with-jobs.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +if [ ! -f "./submodules-recursive/regular-file.txt" ]; then + echo "Expected regular file does not exist" + exit 1 +fi + +if [ ! -f "./submodules-recursive/submodule-level-1/submodule-file.txt" ]; then + echo "Expected submodule file does not exist" + exit 1 +fi + +if [ ! -f "./submodules-recursive/submodule-level-1/submodule-level-2/nested-submodule-file.txt" ]; then + echo "Expected nested submodule file does not exists" + exit 1 +fi + +echo "Testing fetchJobs exists" +git config --local --get-regexp submodules.fetchJobs | grep 10 +if [ "$?" != "0" ]; then + echo "Failed to validate fetchJobs configuration" + exit 1 +fi + +echo "Testing persisted credential" +pushd ./submodules-recursive/submodule-level-1/submodule-level-2 +git config --local --name-only --get-regexp http.+extraheader && git fetch +if [ "$?" != "0" ]; then + echo "Failed to validate persisted credential" + popd + exit 1 +fi +popd diff --git a/action.yml b/action.yml index 5aa90a7..4e27f10 100644 --- a/action.yml +++ b/action.yml @@ -1,100 +1,104 @@ -name: 'Checkout' -description: 'Checkout a Git repository at a particular version' -inputs: - repository: - description: 'Repository name with owner. For example, actions/checkout' - default: ${{ github.repository }} - ref: - description: > - 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 - event. Otherwise, uses the default branch. - token: - description: > - 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 - commands. The post-job step removes the PAT. - - - We recommend using a service account with the least permissions necessary. - Also when generating a new PAT, select the least scopes necessary. - - - [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) - default: ${{ github.token }} - ssh-key: - description: > - SSH key used to fetch the repository. The SSH key is configured with the local - git config, which enables your scripts to run authenticated git commands. - The post-job step removes the SSH key. - - - We recommend using a service account with the least permissions necessary. - - - [Learn more about creating and using - encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) - ssh-known-hosts: - description: > - Known hosts in addition to the user and global host key database. The public - SSH keys for a host may be obtained using the utility `ssh-keyscan`. For example, - `ssh-keyscan github.com`. The public key for github.com is always implicitly added. - ssh-strict: - description: > - Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes` - and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to - configure additional hosts. - default: true - persist-credentials: - description: 'Whether to configure the token or SSH key with the local git config' - default: true - path: - description: 'Relative path under $GITHUB_WORKSPACE to place the repository' - clean: - description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching' - default: true - filter: - description: > - Partially clone against a given filter. - Overrides sparse-checkout if set. - default: null - sparse-checkout: - description: > - Do a sparse checkout on given patterns. - Each pattern should be separated with new lines. - default: null - sparse-checkout-cone-mode: - description: > - Specifies whether to use cone-mode when doing a sparse checkout. - default: true - fetch-depth: - description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.' - default: 1 - fetch-tags: - description: 'Whether to fetch tags, even if fetch-depth > 0.' - default: false - show-progress: - description: 'Whether to show progress status output when fetching.' - default: true - lfs: - description: 'Whether to download Git-LFS files' - default: false - submodules: - description: > - Whether to checkout submodules: `true` to checkout submodules or `recursive` to - recursively checkout submodules. - - - When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are - converted to HTTPS. - default: false - set-safe-directory: - description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory ` - default: true - github-server-url: - description: The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com - required: false -runs: - using: node20 - main: dist/index.js - post: dist/index.js +name: 'Checkout' +description: 'Checkout a Git repository at a particular version' +inputs: + repository: + description: 'Repository name with owner. For example, actions/checkout' + default: ${{ github.repository }} + ref: + description: > + 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 + event. Otherwise, uses the default branch. + token: + description: > + 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 + commands. The post-job step removes the PAT. + + + We recommend using a service account with the least permissions necessary. + Also when generating a new PAT, select the least scopes necessary. + + + [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) + default: ${{ github.token }} + ssh-key: + description: > + SSH key used to fetch the repository. The SSH key is configured with the local + git config, which enables your scripts to run authenticated git commands. + The post-job step removes the SSH key. + + + We recommend using a service account with the least permissions necessary. + + + [Learn more about creating and using + encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) + ssh-known-hosts: + description: > + Known hosts in addition to the user and global host key database. The public + SSH keys for a host may be obtained using the utility `ssh-keyscan`. For example, + `ssh-keyscan github.com`. The public key for github.com is always implicitly added. + ssh-strict: + description: > + Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes` + and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to + configure additional hosts. + default: true + persist-credentials: + description: 'Whether to configure the token or SSH key with the local git config' + default: true + path: + description: 'Relative path under $GITHUB_WORKSPACE to place the repository' + clean: + description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching' + default: true + filter: + description: > + Partially clone against a given filter. + Overrides sparse-checkout if set. + default: null + sparse-checkout: + description: > + Do a sparse checkout on given patterns. + Each pattern should be separated with new lines. + default: null + sparse-checkout-cone-mode: + description: > + Specifies whether to use cone-mode when doing a sparse checkout. + default: true + fetch-depth: + description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.' + default: 1 + fetch-tags: + description: 'Whether to fetch tags, even if fetch-depth > 0.' + default: false + show-progress: + description: 'Whether to show progress status output when fetching.' + default: true + lfs: + description: 'Whether to download Git-LFS files' + default: false + submodules: + description: > + Whether to checkout submodules: `true` to checkout submodules or `recursive` to + recursively checkout submodules. + + + When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are + converted to HTTPS. + default: false + submodulesFetchJobs: + description: > + Specifies how many submodules are fetched/cloned at the same time. A positive integer allows up to that number of submodules fetched in parallel. A value of 0 will give some reasonable default. If unset, it defaults to 1. + default: 1 + set-safe-directory: + description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory ` + default: true + github-server-url: + description: The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com + required: false +runs: + using: node20 + main: dist/index.js + post: dist/index.js diff --git a/dist/index.js b/dist/index.js index ddf2b3d..b27e94a 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1304,6 +1304,7 @@ function getSource(settings) { core.endGroup(); // Checkout submodules core.startGroup('Fetching submodules'); + yield git.config('submodule.fetchJobs', settings.submodulesFetchJobs); yield git.submoduleSync(settings.nestedSubmodules); yield git.submoduleUpdate(settings.fetchDepth, settings.nestedSubmodules); yield git.submoduleForeach('git config --local gc.auto 0', settings.nestedSubmodules); @@ -1770,8 +1771,10 @@ function getInputs() { else if (submodulesString == 'TRUE') { result.submodules = true; } + result.submodulesFetchJobs = core.getInput('submodulesFetchJobs') || '1'; core.debug(`submodules = ${result.submodules}`); core.debug(`recursive submodules = ${result.nestedSubmodules}`); + core.debug(`submodules fetchJobs= ${result.submodulesFetchJobs}`); // Auth token result.authToken = core.getInput('token', { required: true }); // SSH diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..fcfc119 --- /dev/null +++ b/flake.lock @@ -0,0 +1,78 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1702485969, + "narHash": "sha256-pGHfPZK6pGCPo42f1sylwjmJfjqZM6DXX4ZJM4JUP1Y=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "750644b56300bfa3312710e47ab087904e0c655b", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-23.11-small", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-unstable": { + "locked": { + "lastModified": 1702483393, + "narHash": "sha256-xdZ+69I2z5ywVtJHW3+BQ99rKFDPkyaPNznstw+gfS8=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "224b3a5ad9a960e4a6e3cd59233c1616164c5ef5", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixos-unstable-small", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs", + "nixpkgs-unstable": "nixpkgs-unstable" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..9e91f7c --- /dev/null +++ b/flake.nix @@ -0,0 +1,25 @@ +{ + description = "A Nix wrapped development environment"; + + inputs = { + nixpkgs.url = "github:nixos/nixpkgs/nixos-23.11-small"; + nixpkgs-unstable.url = "github:nixos/nixpkgs/nixos-unstable-small"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, nixpkgs-unstable, flake-utils }: + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + pkgs-unstable = nixpkgs-unstable.legacyPackages.${system}; + in + { + devShell = pkgs.mkShell + rec { + buildInputs = with pkgs; + [ + nodePackages.typescript-language-server + ]; + }; + }); +} diff --git a/src/git-source-provider.ts b/src/git-source-provider.ts index 5c98e9f..58d4292 100644 --- a/src/git-source-provider.ts +++ b/src/git-source-provider.ts @@ -232,6 +232,7 @@ export async function getSource(settings: IGitSourceSettings): Promise { // Checkout submodules core.startGroup('Fetching submodules') + await git.config('submodule.fetchJobs', settings.submodulesFetchJobs) await git.submoduleSync(settings.nestedSubmodules) await git.submoduleUpdate(settings.fetchDepth, settings.nestedSubmodules) await git.submoduleForeach( diff --git a/src/git-source-settings.ts b/src/git-source-settings.ts index 629350b..ae6bb74 100644 --- a/src/git-source-settings.ts +++ b/src/git-source-settings.ts @@ -74,6 +74,11 @@ export interface IGitSourceSettings { */ nestedSubmodules: boolean + /** + * Indicates the number of parallel jobs to use when fetching submodules + */ + submodulesFetchJobs: string + /** * The auth token to use when fetching the repository */ diff --git a/src/input-helper.ts b/src/input-helper.ts index e546c19..b2e76a9 100644 --- a/src/input-helper.ts +++ b/src/input-helper.ts @@ -132,8 +132,10 @@ export async function getInputs(): Promise { } else if (submodulesString == 'TRUE') { result.submodules = true } + result.submodulesFetchJobs = core.getInput('submodulesFetchJobs') || '1' core.debug(`submodules = ${result.submodules}`) core.debug(`recursive submodules = ${result.nestedSubmodules}`) + core.debug(`submodules fetchJobs= ${result.submodulesFetchJobs}`) // Auth token result.authToken = core.getInput('token', {required: true})