Add reminders for fixing linting errors in workflow (from Patch1 lint) #3
Conversation
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
added 3 commits
October 19, 2024 17:06
Adding a new workflow to lint GitHub Actions workflow files. 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. Link to tracking issue Fixes open-telemetry#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.
- Update the `Lint Workflow Files` job to ensure that all `.yml` files in `.github/workflows` are checked, even if errors are encountered. - Use `yamllint` for general YAML syntax checks and `actionlint` for GitHub Actions-specific linting. - Implement `continue-on-error` to prevent the workflow from failing prematurely, ensuring all workflow files are validated during pull requests. - Allows better error reporting while ensuring full validation coverage.
- Implemented an echo statement in the `yamllint` step to log a message when YAML linting errors are detected: "YAML lint errors detected, please fix all issues before merging." - Added a dedicated reminder step to ensure contributors see a message to address all linting errors before merging the pull request. This change aims to improve code quality by encouraging contributors to resolve all issues identified during the linting process.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds reminders for fixing linting errors in the workflow. An echo statement has been implemented in the
yamllintstep to notify contributors when YAML linting errors are detected. Additionally, a dedicated reminder step has been added to encourage addressing all linting issues before merging pull requests.Link to tracking issue
Testing
Tested the workflow by intentionally introducing YAML linting errors to verify that the reminder messages appear in the logs, ensuring contributors are prompted to fix any issues.
Documentation
No additional documentation needed as the change is internal to the CI.