actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 07:12:11 -05:00
Code Issues Projects Releases Packages Wiki Activity

chore: update docs to improve build locally (#5788)

Browse source 
Improve the instructions on the 'build locally' page to actually store the
github PAT in the local filesystem.
This commit is contained in:
Niel Markwick 2024-06-19 10:23:21 +02:00 committed by GitHub
parent 5b5d2f7ef0
commit 9d154f5e68
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/run-linter-locally.md
View file

@ -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