Merge 83f93bf255 into 09d2acae67

Fixes #603

README.md

@@ -10,6 +10,24 @@ The auth token is persisted in the local git config. This enables your scripts t
 
 When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.
 
+### Note
+
+Thank you for your interest in this GitHub action, however, right now we are not taking contributions. 
+
+We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features we’re working on and what stage they’re in.
+
+We are taking the following steps to better direct requests related to GitHub Actions, including:
+
+1. We will be directing questions and support requests to our [Community Discussions area](https://github.com/orgs/community/discussions/categories/actions)
+
+2. High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.
+
+3. Security Issues should be handled as per our [security.md](security.md)
+
+We will still provide security updates for this project and fix major breaking changes during this time.
+
+You are welcome to still raise bugs in this repo.
+
 # What's new
 
 Please refer to the [release page](https://github.com/actions/checkout/releases/latest) for the latest release notes.
@@ -126,6 +144,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
     # running from unless specified. Example URLs are https://github.com or
     # https://my-ghes-server.example.com
     github-server-url: ''
+
+    # Whether to clone the repository as a bare repository
+    # Default: false
+    bare: ''
 ```
 <!-- end usage -->
 

__test__/git-command-manager.test.ts

@@ -375,4 +375,42 @@ describe('Test fetchDepth and fetchTags options', () => {
       expect.any(Object)
     )
   })
+
+  it('should call execGit with the correct arguments when bare is true', async () => {
+    jest.spyOn(exec, 'exec').mockImplementation(mockExec)
+
+    const workingDirectory = 'test'
+    const lfs = false
+    const doSparseCheckout = false
+    git = await commandManager.createCommandManager(
+      workingDirectory,
+      lfs,
+      doSparseCheckout
+    )
+    const refSpec = ['refspec1', 'refspec2']
+    const options = {
+      filter: 'filterValue',
+      bare: true
+    }
+
+    await git.fetch(refSpec, options)
+
+    expect(mockExec).toHaveBeenCalledWith(
+      expect.any(String),
+      [
+        '-c',
+        'protocol.version=2',
+        'fetch',
+        '--bare',
+        '--no-tags',
+        '--prune',
+        '--no-recurse-submodules',
+        '--filter=filterValue',
+        'origin',
+        'refspec1',
+        'refspec2'
+      ],
+      expect.any(Object)
+    )
+  })
 })

action.yml

@@ -1,109 +1,112 @@
-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
-  ssh-user:
+  ssh-user:
-    description: >
+    description: >
-      The user to use when connecting to the remote SSH host. By default 'git' is used.
+      The user to use when connecting to the remote SSH host. By default 'git' is used.
-    default: git
+    default: git
-  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:
+  set-safe-directory:
-    description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
+    description: Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
-    default: true
+    default: true
-  github-server-url:
+  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
+    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
+    required: false
-outputs:
+  bare:
-  ref:
+    description: 'Whether to clone the repository as a bare repository'
-    description: 'The branch, tag or SHA that was checked out'
+    default: false
-  commit:
+outputs:
-    description: 'The commit SHA that was checked out'
+  ref:
-runs:
+    description: 'The branch, tag or SHA that was checked out'
-  using: node20
+  commit:
-  main: dist/index.js
+    description: 'The commit SHA that was checked out'
-  post: dist/index.js
+runs:
+  using: node20
+  main: dist/index.js
+  post: dist/index.js

src/git-source-provider.ts

@@ -110,7 +110,11 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
       !fsHelper.directoryExistsSync(path.join(settings.repositoryPath, '.git'))
     ) {
       core.startGroup('Initializing the repository')
-      await git.init()
+      const initArgs = ['init']
+      if (settings.bare) {
+        initArgs.push('--bare')
+      }
+      await git.execGit(initArgs)
       await git.remoteAdd('origin', repositoryUrl)
       core.endGroup()
     }