Allow configuration of submodule.fetchJobs

.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
+          path: v3

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 <path>`
     # Default: true

__test__/git-auth-helper.test.ts

@@ -811,6 +811,7 @@ async function setup(testName: string): Promise<void> {
     lfs: false,
     submodules: false,
     nestedSubmodules: false,
+    submodulesFetchJobs: '1',
     persistCredentials: true,
     ref: 'refs/heads/main',
     repositoryName: 'my-repo',

__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

action.yml

@@ -1,100 +1,104 @@
-name: 'Checkout'
+name: 'Checkout'
-description: 'Checkout a Git repository at a particular version'
+description: 'Checkout a Git repository at a particular version'
-inputs:
+inputs:
-  repository:
+  repository:
-    description: 'Repository name with owner. For example, actions/checkout'
+    description: 'Repository name with owner. For example, actions/checkout'
-    default: ${{ github.repository }}
+    default: ${{ github.repository }}
-  ref:
+  ref:
-    description: >
+    description: >
-      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.
-  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
-      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.
-
+
-
+
-      We recommend using a service account with the least permissions necessary.
+      We recommend using a service account with the least permissions necessary.
-      Also when generating a new PAT, select the least scopes 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)
+      [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 }}
+    default: ${{ github.token }}
-  ssh-key:
+  ssh-key:
-    description: >
+    description: >
-      SSH key used to fetch the repository. The SSH key is configured with the local
+      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.
+      git config, which enables your scripts to run authenticated git commands.
-      The post-job step removes the SSH key.
+      The post-job step removes the SSH key.
-
+
-
+
-      We recommend using a service account with the least permissions necessary.
+      We recommend using a service account with the least permissions necessary.
-
+
-
+
-      [Learn more about creating and using
+      [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)
+      encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
-  ssh-known-hosts:
+  ssh-known-hosts:
-    description: >
+    description: >
-      Known hosts in addition to the user and global host key database. The public
+      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 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-keyscan github.com`. The public key for github.com is always implicitly added.
-  ssh-strict:
+  ssh-strict:
-    description: >
+    description: >
-      Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes`
+      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
+      and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to
-      configure additional hosts.
+      configure additional hosts.
-    default: true
+    default: true
-  persist-credentials:
+  persist-credentials:
-    description: 'Whether to configure the token or SSH key with the local git config'
+    description: 'Whether to configure the token or SSH key with the local git config'
-    default: true
+    default: true
-  path:
+  path:
-    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
+    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
-  clean:
+  clean:
-    description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
+    description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
-    default: true
+    default: true
-  filter:
+  filter:
-    description: >
+    description: >
-      Partially clone against a given filter.
+      Partially clone against a given filter.
-      Overrides sparse-checkout if set.
+      Overrides sparse-checkout if set.
-    default: null
+    default: null
-  sparse-checkout:
+  sparse-checkout:
-    description: >
+    description: >
-      Do a sparse checkout on given patterns.
+      Do a sparse checkout on given patterns.
-      Each pattern should be separated with new lines.
+      Each pattern should be separated with new lines.
-    default: null
+    default: null
-  sparse-checkout-cone-mode:
+  sparse-checkout-cone-mode:
-    description: >
+    description: >
-      Specifies whether to use cone-mode when doing a sparse checkout.
+      Specifies whether to use cone-mode when doing a sparse checkout.
-    default: true
+    default: true
-  fetch-depth:
+  fetch-depth:
-    description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
+    description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
-    default: 1
+    default: 1
-  fetch-tags:
+  fetch-tags:
-    description: 'Whether to fetch tags, even if fetch-depth > 0.'
+    description: 'Whether to fetch tags, even if fetch-depth > 0.'
-    default: false
+    default: false
-  show-progress:
+  show-progress:
-    description: 'Whether to show progress status output when fetching.'
+    description: 'Whether to show progress status output when fetching.'
-    default: true
+    default: true
-  lfs:
+  lfs:
-    description: 'Whether to download Git-LFS files'
+    description: 'Whether to download Git-LFS files'
-    default: false
+    default: false
-  submodules:
+  submodules:
-    description: >
+    description: >
-      Whether to checkout submodules: `true` to checkout submodules or `recursive` to
+      Whether to checkout submodules: `true` to checkout submodules or `recursive` to
-      recursively checkout submodules.
+      recursively checkout submodules.
-
+
-
+
-      When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are
+      When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are
-      converted to HTTPS.
+      converted to HTTPS.
-    default: false
+    default: false
-  set-safe-directory:
+  submodulesFetchJobs:
-    description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
+    description: >
-    default: true
+      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.
-  github-server-url:
+    default: 1
-    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
+  set-safe-directory:
-    required: false
+    description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
-runs:
+    default: true
-  using: node20
+  github-server-url:
-  main: dist/index.js
+    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
-  post: dist/index.js
+    required: false
+runs:
+  using: node20
+  main: dist/index.js
+  post: dist/index.js

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

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
+}

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
+              ];
+          };
+      });
+}

src/git-source-provider.ts

@@ -232,6 +232,7 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
 
       // 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(

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
    */

src/input-helper.ts

@@ -132,8 +132,10 @@ export async function getInputs(): Promise<IGitSourceSettings> {
   } 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})