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

Merge branch 'master' into issue/111

Browse source
This commit is contained in:
Cory Parent 2020-06-21 11:16:58 -04:00 committed by GitHub
commit 76e352bd4c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.automation/README.md
View file

@ -1,12 +1,12 @@
# .automation # .automation
This folder holds automation scripts to help `deploy` and `cleanup` **DockerHub** images of the **Super-Linter** This folder holds automation scripts to help `deploy` and `cleanup` **DockerHub** images of the **Super-Linter**
## cleanup-docker.md ## cleanup-docker.sh
This script uses **GitHub Actions** so that when a PR is merged and closed, the **GitHub Action** is triggered. This script uses **GitHub Actions** so that when a PR is merged and closed, the **GitHub Action** is triggered.
It will then search **DockerHub** for the image that was deployed during the development, and remove it. It will then search **DockerHub** for the image that was deployed during the development, and remove it.
## upload-docker.sh ## upload-docker.sh
This script uses **GitHub Actions** so that a push to the repository is committed, it will complete the following: This script uses **GitHub Actions** so that when a push to the repository is committed, it will complete the following:
- Checkout the source code - Checkout the source code
- Build the **Docker** container for **Super-Linter** using that source code - Build the **Docker** container for **Super-Linter** using that source code
- Upload the container to **DockerHub** - Upload the container to **DockerHub**
@ -16,7 +16,7 @@ When the script is triggered in a branch, it will push with the tag:**NameOfBran
- *testing* - *testing*
- *troubleshooting* - *troubleshooting*
- *debugging* - *debugging*
- **Note:** The branch name will be reduced to AlpaNumeric for consistency and uploading - **Note:** The branch name will be reduced to alphanumeric for consistency and uploading
## test ## test
This folder holds all **Test Cases** to help run the *CI/CT/CD* process for the **Super-Linter**. This folder holds all **Test Cases** to help run the *CI/CT/CD* process for the **Super-Linter**.

6
README.md
View file

@ -96,14 +96,14 @@ jobs:
# Run Linter against code base # # Run Linter against code base #
################################ ################################
- name: Lint Code Base - name: Lint Code Base
uses: docker://github/super-linter:v2.0.0 uses: docker://github/super-linter:v2.1.1
env: env:
VALIDATE_ALL_CODEBASE: false VALIDATE_ALL_CODEBASE: false
VALIDATE_ANSIBLE: false VALIDATE_ANSIBLE: false
... ...
``` ```
**NOTE:** Using the line:`uses: docker://github/super-linter:v2.0.0` will pull the image down from **DockerHub** and run the **GitHub Super-Linter**. Using the line: `uses: github/super-linter@v2.0.0` will build and compile the **GitHub Super-Linter** at build time. This can be far more costly in time... **NOTE:** Using the line:`uses: docker://github/super-linter:v2.1.0` will pull the image down from **DockerHub** and run the **GitHub Super-Linter**. Using the line: `uses: github/super-linter@v2.1.0` will build and compile the **GitHub Super-Linter** at build time. This can be far more costly in time...
## Environment variables ## Environment variables
The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality. The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality.
@ -147,7 +147,7 @@ and won't run anything unexpected.
### Template rules files ### Template rules files
You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level. You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level.
- Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository - Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository
- If your repository does not have rules files, they will fall back to defaults in this repositories `TEMPLATE` folder - If your repository does not have rules files, they will fall back to defaults in [this repository's `TEMPLATE` folder](https://github.com/github/super-linter/tree/master/TEMPLATES)
## Disabling rules ## Disabling rules
If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md) If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)

2
TEMPLATES/.yaml-lint.yml
View file

@ -3,7 +3,7 @@
# These are the rules used for # # These are the rules used for #
# linting all the yaml files in the stack # # linting all the yaml files in the stack #
# NOTE: # # NOTE: #
# You can disble line with: # # You can disable line with: #
# # yamllint disable-line # # # yamllint disable-line #
########################################### ###########################################
rules: rules:

2
docs/disabling-linters.md
View file

@ -477,7 +477,7 @@ alert('foo')
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
## Dockerfile ## Dockerfile
-[dockerfilelint](https://github.com/replicatedhq/dockerfilelint.git) - [dockerfilelint](https://github.com/replicatedhq/dockerfilelint.git)
### Dockerfilelint standard Config file ### Dockerfilelint standard Config file
- `.github/linters/.dockerfilelintrc` - `.github/linters/.dockerfilelintrc`

4
lib/linter.sh
View file

@ -746,8 +746,8 @@ GetValidationInfo()
VALIDATE_DOCKER=$(echo "$VALIDATE_DOCKER" | awk '{print tolower($0)}') VALIDATE_DOCKER=$(echo "$VALIDATE_DOCKER" | awk '{print tolower($0)}')
VALIDATE_GO=$(echo "$VALIDATE_GO" | awk '{print tolower($0)}') VALIDATE_GO=$(echo "$VALIDATE_GO" | awk '{print tolower($0)}')
VALIDATE_TERRAFORM=$(echo "$VALIDATE_TERRAFORM" | awk '{print tolower($0)}') VALIDATE_TERRAFORM=$(echo "$VALIDATE_TERRAFORM" | awk '{print tolower($0)}')
VALIDATE_CSS=$(echo "$VALIDATE_CSS" | awk '{print tolower($0)') VALIDATE_CSS=$(echo "$VALIDATE_CSS" | awk '{print tolower($0)}')
VALIDATE_ENV=$(echo "$VALIDATE_ENV" | awk '{print tolower($0)') VALIDATE_ENV=$(echo "$VALIDATE_ENV" | awk '{print tolower($0)}')
VALIDATE_CLOJURE=$(echo "$VALIDATE_CLOJURE" | awk '{print tolower($0)') VALIDATE_CLOJURE=$(echo "$VALIDATE_CLOJURE" | awk '{print tolower($0)')
################################################ ################################################