From ebc103706176d0d2d0dea1b5d858b4349453810e Mon Sep 17 00:00:00 2001 From: Nick Holden Date: Thu, 22 Apr 2021 19:40:59 -0700 Subject: [PATCH] Improve docs for checking out a private repo I tried using `actions/checkout` to checkout a private repo using the README, and I bumped into two issues: 1. I thought that `secrets.GitHub_PAT` was something that I got for free. It turns out that the user must create this secret themselves. 2. User-created secrets [cannot start with `GitHub_`](https://docs.github.com/en/actions/reference/encrypted-secrets). This change updates the README to clarify both of those points. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c56a6f..2d073e7 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous uses: actions/checkout@v2 with: repository: my-org/my-private-tools - token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret that contains your PAT + token: ${{ secrets.MY_GITHUB_PAT }} # `MY_GITHUB_PAT` is a secret you create that contains your PAT path: my-tools ```