docs: added readme #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| ################################# | |
| ################################# | |
| ## Super Linter GitHub Actions ## | |
| ################################# | |
| ################################# | |
| name: Lint Code Base | |
| ############################# | |
| # Start the job on all push # | |
| ############################# | |
| on: | |
| push: | |
| branches-ignore: [master, main] | |
| # Remove the line above to run when pushing to master or main | |
| pull_request: | |
| branches: [master, main] | |
| ############### | |
| # Set the Job # | |
| ############### | |
| jobs: | |
| build: | |
| # Name the Job | |
| name: Lint Code Base | |
| # Set the agent to run on | |
| runs-on: ubuntu-latest | |
| ############################################ | |
| # Grant status permission for MULTI_STATUS # | |
| ############################################ | |
| permissions: | |
| contents: read | |
| packages: read | |
| statuses: write | |
| ################## | |
| # Load all steps # | |
| ################## | |
| steps: | |
| ########################## | |
| # Checkout the code base # | |
| ########################## | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 | |
| with: | |
| # Full git history is needed to get a proper | |
| # list of changed files within `super-linter` | |
| fetch-depth: 0 | |
| ################################ | |
| # Run Linter against code base # | |
| ################################ | |
| - name: Lint Code Base | |
| uses: super-linter/super-linter@v5 | |
| env: | |
| VALIDATE_ALL_CODEBASE: true | |
| VALIDATE_MARKDOWN: false | |
| VALIDATE_DOCKERFILE: true | |
| VALIDATE_DOCKERFILE_HADOLINT: false | |
| VALIDATE_PYTHON_FLAKE8: false | |
| VALIDATE_BASH: false | |
| VALIDATE_JSCPD: false | |
| VALIDATE_RUST_2015: false | |
| DEFAULT_BRANCH: main | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |