Enhance CI system for checking GitHub Actions workflows #6
Conversation
|
Hi @per1234. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
.github/workflows/check-yaml.yml
Outdated
| find . \ | ||
| -path './.git' -prune -or \ | ||
| \( \ | ||
| \( \ | ||
| -name '.clang-format' -or \ | ||
| -name '.clang-tidy' -or \ | ||
| -name '.gemrc' -or \ | ||
| -name '*.yml' -or \ | ||
| -name '*.mir' -or \ | ||
| -name '*.reek' -or \ | ||
| -name '*.rviz' -or \ | ||
| -name '*.sublime-syntax' -or \ | ||
| -name '*.syntax' -or \ | ||
| -name '*.yaml' -or \ | ||
| -name '*.yaml-tmlanguage' -or \ | ||
| -name '*.yaml.sed' -or \ | ||
| -name '*.yaml.mysql' \ | ||
| \) \ | ||
| -and -type f \ | ||
| \) \ | ||
| -exec \ | ||
| yamllint \ | ||
| --config-file "${{ github.workspace }}/.github/.yamllint.yml" \ | ||
| --format ${{ matrix.configuration.format }} \ | ||
| '{}' + \ | ||
| || \ | ||
| ${{ matrix.configuration.fail-command }} |
There was a problem hiding this comment.
Couldn't we use the yaml-files config to avoid doing this?
There was a problem hiding this comment.
Thanks Silvano! That is such a huge improvement to the system:
https://github.com/arduino/library-registry/compare/051008b..0c09834a08711d1c9efd0a9f756bd2fa9c37106e
I guess I missed that feature completely. This will provide consistency for people running yamllint locally and I never enjoy using find.
|
I like how we get warnings directly in the code now, this will be really useful.
|
On every push or pull request that affects the repository's GitHub Actions workflows, and periodically, validate them against the JSON schema.
|
Hi @per1234. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
On every push and pull request that affects relevant files, and periodically, 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
|
Hi @per1234. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
Yeah, it is convenient! I think it will be especially beneficial for casual contributors who won't be so familiar with hunting down the cause of a CI failure in the log. This is something worth considering when setting up the traditional Tooling Team style taskfile-based CI. In this case it should work either way because yamllint has built-in support. But in most other cases I've seen the problem matcher is implemented in the action, not in the tool (e.g., codespell). I think it is still possible to set that up in the workflow itself. For example, here is an independent problem matcher action I used for markdownlint in the "Check Markdown" workflow: |
The "Manage PRs" workflow is an essential component of the new Library Manager submission system. This is a quite complex workflow which will cause the users of the submission to have a bad experience if it is not working correctly.
For this reason, it's worth setting up some automated systems to verify the workflows of this repository.