More explanation of GITHUB_TOKEN

This commit is contained in:
Barry 2020-08-10 23:38:53 +01:00
parent 184fa681e7
commit b65cf4a256

View file

@ -90,7 +90,7 @@ To use this **GitHub** Action you will need to complete the following:
5. Enjoy your more _stable_, and _cleaner_ code base
6. Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options
**NOTE:** You will need the _Environment_ variable `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` set in your workflow file to be able to use the multiple status API returns. There is no need to set the **GitHub** Secret, it only needs to be passed.
**NOTE:** If you pass the _Environment_ variable `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` in your workflow file, then the GitHub Super-Linter will mark the status of each individual linter run in the Checks section of a pull request. There is no need to set the **GitHub** Secret as it is automatically set by GitHub, it only needs to be passed to the action.
### Example connecting GitHub Action Workflow