Merge bb656e1855 into 85e6279cec

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2026-02-24 22:59:49 +08:00 · 2025-02-01 11:09:10 +00:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2021-12-09 11:13:12 -08:00
2 changed files with 13 additions and 0 deletions
--- a/.github/workflows/check-dist.yml
+++ b/.github/workflows/check-dist.yml
@@ -17,8 +17,12 @@ on:
      - '**.md'
  workflow_dispatch:

+permissions: read-all
+
 jobs:
  check-dist:
+    permissions:
+      contents: read # for actions/checkout to fetch code
    runs-on: ubuntu-latest

    steps:
--- a/README.md
+++ b/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
Author	SHA1	Message	Date
Varun Sharma	4dbda13fa8	Merge `bb656e1855` into `85e6279cec`	2025-02-01 11:09:10 +00: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
Varun Sharma	bb656e1855	Update check-dist.yml	2021-12-09 11:13:12 -08:00