Editorial: linked the example linter.yml file (#1872)

This commit is contained in:
Philip Jake 2021-08-17 22:00:53 +02:00 committed by GitHub
parent 79dee46012
commit a6d60d8fa8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -120,17 +120,17 @@ To use this **GitHub** Action you will need to complete the following:
In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below: In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below:
- `.github/workflows/linter.yml` - `.github/workflows/linter.yml`
- Example file can be found at `TEMPLATES/linter.yml` - Example file can be found at [`TEMPLATES/linter.yml`](/TEMPLATES/linter.yml)
This file should have the following code: This file should have the following code:
```yml ```yml
--- ---
########################### #################################
########################### #################################
## Linter GitHub Actions ## ## Super Linter GitHub Actions ##
########################### #################################
########################### #################################
name: Lint Code Base name: Lint Code Base
# #
@ -143,10 +143,10 @@ name: Lint Code Base
############################# #############################
on: on:
push: push:
branches-ignore: [master] branches-ignore: [master, main]
# Remove the line above to run when pushing to master # Remove the line above to run when pushing to master
pull_request: pull_request:
branches: [master] branches: [master, main]
############### ###############
# Set the Job # # Set the Job #