Add GitHub Actions workflow for linting YAML files #11493
Conversation
- This workflow ensures that any YAML files in the .github/workflows directory are checked for syntax and formatting issues using yamllint, and GitHub Actions-specific errors are caught using actionlint. - This will help prevent issues related to incorrect workflows during pull requests. - Added a reminder step to ensure contributors see a message to address all linting errors before merging the pull request.
KenEkanem
force-pushed
the
lint-workflows
branch
from
d229dca to
3a8f9ea
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11493 +/- ##
==========================================
+ Coverage 91.48% 91.53% +0.04%
==========================================
Files 433 443 +10
Lines 23617 23771 +154
==========================================
+ Hits 21607 21759 +152
+ Misses 1642 1638 -4
- Partials 368 374 +6 ☔ View full report in Codecov by Sentry. |
| run: yamllint .github/workflows/*.yml | ||
|
|
||
| - name: Run Actions-specific checks | ||
| uses: reviewdog/action-actionlint@v1 |
There was a problem hiding this comment.
Have you had a chance to test this w/ the original issue https://github.com/open-telemetry/opentelemetry-collector/pull/9675/files?
KenEkanem
force-pushed
the
lint-workflows
branch
from
3549e70 to
3a8f9ea
Compare
- Updated the PR to replace yamllint with actionlint, as actionlint is better suited for catching mistakes in GitHub Actions workflow files specifically. - For general YAML code style checks, we can use a general YAML checker like yamllint.
|
Action lint also detected a couple more errors
with your permissions I'd like to work on this as well when this is merged |
|
|
||
| - name: Lint GitHub Workflow YAML Files with Docker | ||
| run: | | ||
| docker run --rm -v "${{ github.workspace }}:/repo" --workdir /repo rhysd/actionlint:latest -color .github/workflows/*.yml .github/workflows/*.yaml |
There was a problem hiding this comment.
Should this use a specific version rather than latest to prevent the build from suddenly breaking with an unexpected change in a new release?
(ideally, the version should also be auto-upgraded with a renovate PR)
There was a problem hiding this comment.
You're right using a specific version will ensure stability. I will update that. thanks
| { | ||
| "matchManagers": ["dockerfile"], | ||
| "matchPackageNames": ["rhysd/actionlint"], | ||
| "groupName": "Actionlint docker image", | ||
| "versioning": "docker" | ||
| }, |
There was a problem hiding this comment.
Actionlint Docker image for stable updates
…lity - Updated Docker command in GitHub workflow to use `rhysd/actionlint:1.7.3` instead of `latest` to maintain workflow stability. - Specifying a version tag to avoid potential unexpected breaks due to changes in the latest version of actionlint.
… versioning - Added Renovate package rule to monitor `rhysd/actionlint` Docker image in workflows to avoid using `latest` tag and instead update to a specific version when available. - Set versioning to `docker` to ensure Renovate fetches the latest tag from the Docker registry.
KenEkanem
force-pushed
the
lint-workflows
branch
from
875f2c3 to
115372d
Compare
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
|
|
||
| - name: Lint GitHub Workflow YAML Files with Docker | ||
| run: | | ||
| docker run --rm -v "${{ github.workspace }}:/repo" --workdir /repo rhysd/actionlint:1.7.3 -color .github/workflows/*.yml .github/workflows/*.yaml |
There was a problem hiding this comment.
Could you move the version number to a variable so it's easier to catch?
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
Add GitHub Actions workflow for linting YAML files
Description
Adding a new workflow to lint GitHub Actions workflow files. This workflow ensures that any YAML files in the
.github/workflowsdirectory are checked for syntax and formatting issues using yamllint, and GitHub Actions-specific errors are caught using actionlint. This will help prevent issues related to incorrect workflows during pull requests.Link to tracking issue
Fixes
#9676
Testing
Tested by opening a pull request that modifies a workflow file to ensure that the linting workflow triggers and validates the changes correctly.
Documentation
No new documentation added, as this change is self-explanatory within the context of CI.