From 9d154f5e68af77bf3f7fb08a89d4cdc0552dde80 Mon Sep 17 00:00:00 2001 From: Niel Markwick Date: Wed, 19 Jun 2024 10:23:21 +0200 Subject: [PATCH] chore: update docs to improve build locally (#5788) Improve the instructions on the 'build locally' page to actually store the github PAT in the local filesystem. --- docs/run-linter-locally.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index b18ea1d9..f1aafa69 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -84,17 +84,19 @@ them accordingly: ## Build the container image and run the test suite locally -To run the build and test process locally, do the following: +To run the build and test process locally, in the top-level super-linter +directory, do the following: 1. [Create a fine-grained GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). -1. Create a file to store the personal access token on your machine: + The token only needs to have public/read-only access. + +1. Store the generated personal access token in a file in the top-level + directory (This file is ignored by Git). ```bash - touch .github-personal-access-token + echo "github_pat_XXXXXX_XXXXXX" > .github-personal-access-token ``` - The file to store the personal access token is ignored by Git. - 1. Run the build process: ```bash