wip-docs: Add Guardrails Documentation #389
Workflow file for this run
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 | |
| ## https://github.com/github/super-linter | |
| ################################# | |
| name: linter | |
| # only run during PRs or manually | |
| on: | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| name: Lint Code Base | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| 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 | |
| # each step will run even if one fails | |
| # this is accomplished with the 'if: ${{ success() || failure() }}' | |
| ################################ | |
| - name: Lint YAML | |
| if: ${{ success() || failure() }} | |
| uses: github/super-linter/slim@v4 | |
| env: | |
| VALIDATE_ALL_CODEBASE: false | |
| DEFAULT_BRANCH: main | |
| FILTER_REGEX_EXCLUDE: cli/.* | |
| LINTER_RULES_PATH: .github/linter-rules | |
| VALIDATE_YAML: true | |
| YAML_CONFIG_FILE: .yaml-lint-config.yaml | |
| # the linter-rules file for bash (.shellcheckrc) needs to exists in the repo's root | |
| # use 'SHELLCHECK_OPTS' instead to ignore certain errors and/or add command options | |
| # https://github.com/koalaman/shellcheck/blob/master/shellcheck.1.md | |
| - name: Lint Bash | |
| if: ${{ success() || failure() }} | |
| uses: github/super-linter/slim@v4 | |
| env: | |
| VALIDATE_ALL_CODEBASE: false | |
| DEFAULT_BRANCH: main | |
| FILTER_REGEX_EXCLUDE: cli/.* | |
| VALIDATE_BASH: true | |
| SHELLCHECK_OPTS: "--severity=info" | |
| # Super-Linter markdown validation | |
| - name: Lint Markdown | |
| if: ${{ success() || failure() }} | |
| uses: github/super-linter/slim@v4 | |
| env: | |
| VALIDATE_ALL_CODEBASE: false | |
| DEFAULT_BRANCH: main | |
| FILTER_REGEX_EXCLUDE: cli/.* | |
| LINTER_RULES_PATH: .github/linter-rules | |
| VALIDATE_MARKDOWN: true | |
| MARKDOWN_CONFIG_FILE: .markdown-lint-config.yaml |