arcodange-org/super-linter-workflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bret Fisher
2022-01-14 13:43:58 -05:00
committed by GitHub
parent 4e3a226a52
commit 76713541d0
1 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,9 +1,8 @@
# Super Linter Reusable Worklow Example
The GitHub [Super-Linter](https://github.com/marketplace/actions/super-linter) project is a great way to lint all your file types with a single GitHub Actions Workflow.
A great way to implement it is in all repos using a Workflow step that points to this Reusable Workflow.
The GitHub [Super-Linter](https://github.com/marketplace/actions/super-linter) project is a fantastic way to lint all your file types with a single GitHub Actions Workflow. A great way to implement it everywhere is to use GHA's [Reusable Workflows](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows) (see below).
[Video Walkthrough of this repo](https://youtu.be/aXZgQM8DqXg)
[My video walkthrough of this repo](https://youtu.be/aXZgQM8DqXg)
## Features of this Super-Linter example
@@ -11,8 +10,30 @@ A great way to implement it is in all repos using a Workflow step that points to
- Bonus: Added Job steps to correctly determine which branch to diff files with
- Bonus: Lints only changed files on a PR, but lints all files on merge to main (or any release) branch
## How to reuse this example as a template and Reusable Workflow
## How to reuse this example as a *Reusable* Workflow
1. Fork this repo for you to customize your linters
2. Add a workflow to all your other repos that calls your linter workflow using GitHub's "Reusable Workflow"
3. Add something similar to this to those workflows:
```yaml
---
name: Lint Code Base
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
call-super-linter:
#customize uri to point to your forked linter repo
uses: bretfisher/super-linter-workflow/.github/workflows/super-linter.yaml@main
```
## How to run Super-Linter locally
## How to run Super-Linter in GitLab, Drone, Jenkins, etc
Option 1: Use [nektos/act](https://github.com/nektos/act) to run an existing GitHub Action workflow on your local repo clone.
Option 2: Use Docker to [run the Super-Linter image directly](https://github.com/github/super-linter/blob/main/docs/run-linter-locally.md).