Merge cd866a98fbf90f0c35f81de563bdd40b4155e4ff into 85e6279cec87321a52edac9c87bce653a07cf6c2

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2025-06-05 07:32:37 +08:00 · 2025-01-17 09:18:15 +05:30 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2022-10-21 11:06:00 -07:00
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -216,6 +216,8 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/

 ## Checkout multiple repos (nested)

+Note: the checkout order must be primary _then_ secondary repo checkout.
+
 ```yaml
 - name: Checkout
  uses: actions/checkout@v4
@ -230,6 +232,8 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/

 ## Checkout multiple repos (private)

+Note: the checkout order must be primary _then_ secondary repo checkout.
+
 ```yaml
 - name: Checkout
  uses: actions/checkout@v4
@ -311,8 +315,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
Author	SHA1	Message	Date
John Hill	ff2b59f894	Merge cd866a98fbf90f0c35f81de563bdd40b4155e4ff into 85e6279cec87321a52edac9c87bce653a07cf6c2	2025-01-17 09:18:15 +05:30
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (javascript) (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2025-01-16 15:56:18 -05:00
Ben Wells	009b9ae9e4	Documentation update - add recommended permissions to Readme (#2043 ) * Update README.md * Update README.md Co-authored-by: Josh Gross <joshmgross@github.com> --------- Co-authored-by: Josh Gross <joshmgross@github.com>	2025-01-16 14:14:48 -05:00
John Hill	cd866a98fb	Improve multi-repo checkout behavior	2022-10-21 11:06:00 -07:00