Combination of multiple linters to install as a GitHub Action
Find a file
2019-10-22 12:21:42 -05:00
.automation initial commit 2019-10-21 09:12:50 -05:00
.github initial commit 2019-10-21 09:12:50 -05:00
lib cleanup of scripts 2019-10-22 12:21:42 -05:00
TEMPLATES cleanup of scripts 2019-10-22 12:21:42 -05:00
.gitignore initial commit 2019-10-21 09:12:50 -05:00
Dockerfile cleanup of scripts 2019-10-22 12:21:42 -05:00
LICENSE initial commit 2019-10-21 09:12:50 -05:00
README.md adding it 2019-10-21 11:05:55 -05:00

Super-Linter

This repository is for the GitHub Action to run a Super-Linter.
Developers on GitHub can call this Action to lint their code base with the following list of linters:

  • Ruby (Rubocop)
  • Shell (Shellcheck)
  • Ansible (Ansible-lint)
  • YAML (Yamllint)
  • Python3 (Pylint)
  • JSON (JsonLint)
  • MarkDown (Markdownlint)
  • Perl (Perl)
  • XML (LibXML)
  • Coffeescript (coffeelint)

How to use

To use this GitHub Action you will need to complete the following:

  • Copy any or all template rules files TEMPLATES/ to your repository in the location: .github/
    • If your repository does not have rules files, they will fall back to defaults
  • Validate all variables are correct and allow for proper permissions on AWS
  • Add the Github Action: Super-Linter to your current Github Actions workflow
  • Enjoy your more stable, and cleaner code base

Example GitHub Action Workflow

In your repository you should have a workflows folder similar to below:

  • .github/workflows/linter.yml

This file should have the following code:

---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base

#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#

#############################
# Start the job on all push #
#############################
on: ['push']

###############
# Set the Job #
###############
jobs:
  build:
    # Name the Job
    name: Lint Code Base
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # Load all steps #
    ##################
    steps:
      ##########################
      # Checkout the code base #
      ##########################
      - name: Checkout Code
        uses: actions/checkout@master

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: docker://admiralawkbar/super-linter:latest
...

How to contribute

If you would like to help contribute to this Github Action, please see CONTRIBUTING


License