docs: improve the API description #2
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
| # This workflow executes several linters on changed files based on languages used in your code base whenever | |
| # you push a code or open a pull request. | |
| # | |
| # You can adjust the behavior by modifying this file. | |
| # For more information, see: | |
| # https://github.com/github/super-linter | |
| name: Lint Code Base | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| jobs: | |
| run-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - 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 | |
| - name: Lint Code Base | |
| uses: github/super-linter@v5 | |
| env: | |
| DEFAULT_BRANCH: "main" | |
| FILTER_REGEX_EXCLUDE: "docs/.*.md" |