diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 9ddbd2e..c188ae2 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -1,33 +1,55 @@ -# This is a basic workflow to help you get started with Actions +--- +########################### +########################### +## Linter GitHub Actions ## +########################### +########################### +name: Lint Code Base -name: CI +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# -# Controls when the action will run. Triggers the workflow on push or pull request -# events but only for the master branch +############################# +# Start the job on all push # +############################# on: push: - branches: [ master ] + branches-ignore: [master] + # Remove the line above to run when pushing to master pull_request: - branches: [ master ] + branches: [master] -# A workflow run is made up of one or more jobs that can run sequentially or in parallel +############### +# Set the Job # +############### jobs: - # This workflow contains a single job called "build" build: - # The type of runner that the job will run on + # Name the Job + name: Lint Code Base + # Set the agent to run on runs-on: ubuntu-latest - # Steps represent a sequence of tasks that will be executed as part of the job + ################## + # Load all steps # + ################## steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@v2 + with: + # Full git history is needed to get a proper list of changed files within `super-linter` + fetch-depth: 0 - # Runs a single command using the runners shell - - name: Run a one-line script - run: echo Hello, world! - - # Runs a set of commands using the runners shell - - name: Run a multi-line script - run: | - echo Add other actions to build, - echo test, and deploy your project. + ################################ + # Run Linter against code base # + ################################ + - name: Lint Code Base + uses: github/super-linter@v3 + env: + VALIDATE_ALL_CODEBASE: false + DEFAULT_BRANCH: master + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}