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

format into steps

Browse source
This commit is contained in:
Zack Koppert 2020-06-30 16:27:52 -07:00 committed by GitHub
parent 77c5521127
commit f7b1f6b67c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -8,7 +8,6 @@ The end goal of this tool:
- Build guidelines for code layout and format - Build guidelines for code layout and format
- Automate the process to help streamline code reviews - Automate the process to help streamline code reviews
## Table of Contents ## Table of Contents
- [How it works](#how-it-works) - [How it works](#how-it-works)
@ -61,9 +60,12 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
## How to use ## How to use
To use this **GitHub** Action you will need to complete the following: To use this **GitHub** Action you will need to complete the following:
- Add the **GitHub** Action: **Super-Linter** to your current **GitHub** Actions workflow 1. Create a new file in your repository called `.github/workflows/linter.yml`
- Enjoy your more *stable*, and *cleaner* code base 2. Copy the example workflow from below into that new file
- Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options 3. Commit that file to a new branch
4. Open up a pull request and observe the action working
5. Enjoy your more *stable*, and *cleaner* code base
6. Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options
### Example connecting GitHub Action Workflow ### Example connecting GitHub Action Workflow
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: