forked from arduino/compile-sketches
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add infrastructure to lint YAML files
A task and GitHub Actions workflow are provided here for linting the project's YAML files. On every push and pull request that affects relevant files, the worflow will run yamllint to check the YAML files of the repository for issues. The .yamllint.yml file is used to configure yamllint: https://yamllint.readthedocs.io/en/stable/configuration.html
- Loading branch information
Showing
6 changed files
with
238 additions
and
1 deletion.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-yaml-task.md | ||
| name: Check YAML | ||
|
|
||
| # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows | ||
| on: | ||
| create: | ||
| push: | ||
| paths: | ||
| - ".python-version" | ||
| - ".yamllint*" | ||
| - "poetry.lock" | ||
| - "pyproject.toml" | ||
| # Source: https://github.com/ikatyang/linguist-languages/blob/master/data/YAML.json (used by Prettier) | ||
| - "**/.clang-format" | ||
| - "**/.clang-tidy" | ||
| - "**/.gemrc" | ||
| - "**/glide.lock" | ||
| - "**.ya?ml*" | ||
| - "**.mir" | ||
| - "**.reek" | ||
| - "**.rviz" | ||
| - "**.sublime-syntax" | ||
| - "**.syntax" | ||
| pull_request: | ||
| paths: | ||
| - ".python-version" | ||
| - ".yamllint*" | ||
| - "poetry.lock" | ||
| - "pyproject.toml" | ||
| # Source: https://github.com/ikatyang/linguist-languages/blob/master/data/YAML.json (used by Prettier) | ||
| - "**/.clang-format" | ||
| - "**/.clang-tidy" | ||
| - "**/.gemrc" | ||
| - "**/glide.lock" | ||
| - "**.ya?ml*" | ||
| - "**.mir" | ||
| - "**.reek" | ||
| - "**.rviz" | ||
| - "**.sublime-syntax" | ||
| - "**.syntax" | ||
| schedule: | ||
| # Run periodically to catch breakage caused by external changes. | ||
| - cron: "0 9 * * WED" | ||
| workflow_dispatch: | ||
| repository_dispatch: | ||
|
|
||
| jobs: | ||
| run-determination: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| result: ${{ steps.determination.outputs.result }} | ||
| steps: | ||
| - name: Determine if the rest of the workflow should run | ||
| id: determination | ||
| run: | | ||
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | ||
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | ||
| if [[ | ||
| "${{ github.event_name }}" != "create" || | ||
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | ||
| ]]; then | ||
| # Run the other jobs. | ||
| RESULT="true" | ||
| else | ||
| # There is no need to run the other jobs. | ||
| RESULT="false" | ||
| fi | ||
| echo "result=$RESULT" >> $GITHUB_OUTPUT | ||
| check: | ||
| name: ${{ matrix.configuration.name }} | ||
| needs: run-determination | ||
| if: needs.run-determination.outputs.result == 'true' | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
|
|
||
| matrix: | ||
| configuration: | ||
| - name: Generate problem matcher output | ||
| # yamllint's "github" output type produces annotated diffs, but is not useful to humans reading the log. | ||
| format: github | ||
| # The other matrix job is used to set the result, so this job is configured to always pass. | ||
| continue-on-error: true | ||
| - name: Check formatting | ||
| # yamllint's "colored" output type is most suitable for humans reading the log. | ||
| format: colored | ||
| continue-on-error: false | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version-file: .python-version | ||
|
|
||
| - name: Install Poetry | ||
| run: | | ||
| pipx install \ | ||
| --python "$(which python)" \ | ||
| poetry | ||
| - name: Install Task | ||
| uses: arduino/setup-task@v1 | ||
| with: | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
| version: 3.x | ||
|
|
||
| - name: Check YAML | ||
| continue-on-error: ${{ matrix.configuration.continue-on-error }} | ||
| run: task yaml:lint YAMLLINT_FORMAT=${{ matrix.configuration.format }} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-yaml/.yamllint.yml | ||
| # See: https://yamllint.readthedocs.io/en/stable/configuration.html | ||
| # The code style defined in this file is the official standardized style to be used in all Arduino tooling projects and | ||
| # should not be modified. | ||
| # Note: Rules disabled solely because they are redundant to Prettier are marked with a "Prettier" comment. | ||
|
|
||
| rules: | ||
| braces: | ||
| level: error | ||
| forbid: non-empty | ||
| min-spaces-inside: -1 # Prettier | ||
| max-spaces-inside: -1 # Prettier | ||
| min-spaces-inside-empty: -1 # Prettier | ||
| max-spaces-inside-empty: -1 # Prettier | ||
| brackets: | ||
| level: error | ||
| forbid: non-empty | ||
| min-spaces-inside: -1 # Prettier | ||
| max-spaces-inside: -1 # Prettier | ||
| min-spaces-inside-empty: -1 # Prettier | ||
| max-spaces-inside-empty: -1 # Prettier | ||
| colons: disable # Prettier | ||
| commas: disable # Prettier | ||
| comments: disable # Prettier | ||
| comments-indentation: disable # Prettier | ||
| document-end: disable # Prettier | ||
| document-start: disable | ||
| empty-lines: disable # Prettier | ||
| empty-values: disable | ||
| hyphens: disable # Prettier | ||
| indentation: disable # Prettier | ||
| key-duplicates: disable # Prettier | ||
| key-ordering: disable | ||
| line-length: | ||
| level: warning | ||
| max: 120 | ||
| allow-non-breakable-words: true | ||
| allow-non-breakable-inline-mappings: true | ||
| new-line-at-end-of-file: disable # Prettier | ||
| new-lines: disable # Prettier | ||
| octal-values: | ||
| level: warning | ||
| forbid-implicit-octal: true | ||
| forbid-explicit-octal: false | ||
| quoted-strings: disable | ||
| trailing-spaces: disable # Prettier | ||
| truthy: | ||
| level: error | ||
| allowed-values: | ||
| - "true" | ||
| - "false" | ||
| - "on" # Used by GitHub Actions as a workflow key. | ||
| check-keys: true | ||
|
|
||
| yaml-files: | ||
| # Source: https://github.com/ikatyang/linguist-languages/blob/master/data/YAML.json (used by Prettier) | ||
| - ".clang-format" | ||
| - ".clang-tidy" | ||
| - ".gemrc" | ||
| - ".yamllint" | ||
| - "glide.lock" | ||
| - "*.yml" | ||
| - "*.mir" | ||
| - "*.reek" | ||
| - "*.rviz" | ||
| - "*.sublime-syntax" | ||
| - "*.syntax" | ||
| - "*.yaml" | ||
| - "*.yaml-tmlanguage" | ||
| - "*.yaml.sed" | ||
| - "*.yml.mysql" | ||
|
|
||
| ignore: | | ||
| /.git/ | ||
| __pycache__/ | ||
| node_modules/ |
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 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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