diff --git a/.github/workflows/superlinter.yml b/.github/workflows/superlinter.yml index 50c5747..6f7b959 100644 --- a/.github/workflows/superlinter.yml +++ b/.github/workflows/superlinter.yml @@ -1,32 +1,55 @@ -name: Super-Linter +--- +################################# +################################# +## Super Linter GitHub Actions ## +################################# +################################# +name: Lint Code Base -# Run this workflow every time a new commit pushed to your repository -on: push +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# +############################# +# Start the job on all push # +############################# +on: + push: + branches-ignore: [master, main] + # Remove the line above to run when pushing to master + pull_request: + branches: [master, main] + +############### +# Set the Job # +############### jobs: - # Set the job key. The key is displayed as the job name - # when a job name is not provided - super-lint: + build: # Name the Job - name: Lint code base - # Set the type of machine to run on + name: Lint Code Base + # Set the agent to run on runs-on: ubuntu-latest + ################## + # Load all steps # + ################## steps: - # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + ########################## + # 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 the Super-Linter action - - name: Run Super-Linter - uses: github/super-linter@v3 + ################################ + # Run Linter against code base # + ################################ + - name: Lint Code Base + uses: github/super-linter@v4 env: + VALIDATE_ALL_CODEBASE: false DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - # Uncomment to exclude files from analysis - # Skip .vscode/*.json (JSON files with comments not yet supported - see https://github.com/github/super-linter/issues/921) - FILTER_REGEX_EXCLUDE: .*vscode/.*.json - VALIDATE_TYPESCRIPT_STANDARD: false - VALIDATE_MARKDOWN: false - -# EOF