Merge 0e208935da into 85e6279cec

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2026-02-19 02:34:43 +08:00 · 2025-01-16 22:54:35 -08:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2024-12-30 12:27:53 -08:00
1 changed files with 21 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -129,6 +129,18 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
 ```
 <!-- end usage -->

+# Outputs
+
+The action sets some outputs after a successful run
+```yaml
+outputs:
+  ref:
+    description: 'The branch, tag or SHA that was checked out'
+
+  commit:
+    description: 'The commit SHA that was checked out'
+```
+
 # Scenarios

 - [Fetch only the root files](#Fetch-only-the-root-files)
@@ -311,8 +323,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
Guido Martínez	1f8894a1b7	Merge `0e208935da` into `85e6279cec`	2025-01-16 22:54:35 -08:00
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (javascript) (push) Failing after 3m16s Build and Test / build (push) Failing after 25s Build and Test / test (ubuntu-latest) (push) Failing after 25s Build and Test / test-proxy (push) Failing after 1m24s Build and Test / test-bypass-proxy (push) Failing after 25s Build and Test / test-git-container (push) Failing after 1m13s Build and Test / test-output (push) Failing after 25s Build and Test / test (macos-latest) (push) Has been cancelled Build and Test / test (windows-latest) (push) Has been cancelled	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
Guido Martínez	0e208935da	README.md: document the outputs	2024-12-30 12:27:53 -08:00