Merge 38cc68387c into 85e6279cec

* Update README.md

* Update README.md

Co-authored-by: Josh Gross <joshmgross@github.com>

---------

Co-authored-by: Josh Gross <joshmgross@github.com>

README.md

@@ -311,8 +311,17 @@ jobs:
           git commit -m "generated"
           git push
 ```
+
 *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D
 
+# Recommended permissions
+
+When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs:
+
+```yaml
+permissions:
+  contents: read
+```
 
 # License
 

src/git-command-manager.ts

@@ -44,6 +44,7 @@ export interface IGitCommandManager {
   getWorkingDirectory(): string
   init(): Promise<void>
   isDetached(): Promise<boolean>
+  lfsCheckout(): Promise<void>
   lfsFetch(ref: string): Promise<void>
   lfsInstall(): Promise<void>
   log1(format?: string): Promise<string>
@@ -340,6 +341,10 @@ class GitCommandManager {
     return !output.stdout.trim().startsWith('refs/heads/')
   }
 
+  async lfsCheckout(): Promise<void> {
+    await this.execGit(['lfs', 'checkout'])
+  }
+
   async lfsFetch(ref: string): Promise<void> {
     const args = ['lfs', 'fetch', 'origin', ref]
 

src/git-source-provider.ts

@@ -232,6 +232,11 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
     await git.checkout(checkoutInfo.ref, checkoutInfo.startPoint)
     core.endGroup()
 
+    // LFS checkout
+    core.startGroup('Checking out LFS objects')
+    await git.lfsCheckout()
+    core.endGroup()
+
     // Submodules
     if (settings.submodules) {
       // Temporarily override global config