CNF-23578: Add yamllint coverage for telco-ran configuration#744
CNF-23578: Add yamllint coverage for telco-ran configuration#744sebrandon1 wants to merge 1 commit into
Conversation
|
@sebrandon1: This pull request references CNF-23578 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: sebrandon1 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (41)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (34)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughThe Changesyamllint expansion and YAML cleanup
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
5dc93ec to
fd1e419
Compare
fd1e419 to
bb78bd2
Compare
bb78bd2 to
1a54ed3
Compare
irinamihai
left a comment
There was a problem hiding this comment.
Just a couple of comments.
Also, the PR description states Add yamllint disable-line comments for base64-encoded ignition data lines that exceed the 2000-char line length limit which doesn't seem to be done 🤔
| fi | ||
|
|
||
| # Basic lint checking | ||
| lintCheck: |
There was a problem hiding this comment.
There are 3 different invocation styles under this target.
I wonder if we could successfully use the ignore directive of yamllint to hold the paths that we want to exclude. For example:
extends: default
ignore: |
# Go-templated kube-compare directories — not valid YAML
telco-core/configuration/reference-crs-kube-compare/
telco-hub/configuration/reference-crs-kube-compare/
telco-ran/configuration/kube-compare-reference/
# Generated MachineConfig CRs with base64 ignition data exceeding line limits
telco-ran/configuration/source-crs/extra-manifest/
rules:
# ... existing rules unchanged ...
Then the entire lintCheck will be pretty:
lintCheck:
yamllint -c .yamllint.yaml .
| yamllint -c .yamllint.yaml telco-hub/configuration/example-overlays-config | ||
| yamllint -c .yamllint.yaml telco-hub/install/ | ||
| find telco-ran/configuration/source-crs -path '*/extra-manifest' -prune -o -name '*.yaml' -print | xargs yamllint -c .yamllint.yaml | ||
| if [ -d telco-ran/configuration/hardening ]; then yamllint -c .yamllint.yaml telco-ran/configuration/hardening; fi |
There was a problem hiding this comment.
Is it necessary to have special handling of the hardening directory?
| yamllint -c .yamllint.yaml telco-hub/install/ | ||
| find telco-ran/configuration/source-crs -path '*/extra-manifest' -prune -o -name '*.yaml' -print | xargs yamllint -c .yamllint.yaml | ||
| if [ -d telco-ran/configuration/hardening ]; then yamllint -c .yamllint.yaml telco-ran/configuration/hardening; fi | ||
| yamllint -c .yamllint.yaml telco-ran/install/ |
| - nodeLabel: {{ template "matchNodeSelectorValue" (list .nodeLabel "node-role.kubernetes.io" ) }} | ||
| {{- end }} | ||
| {{- end }} No newline at end of file | ||
| {{- end }} No newline at end of file |
- Use yamllint ignore directive to exclude kube-compare reference directories, extra-manifest CRs, and generated PolicyGenTemplate output instead of per-directory Makefile invocations - Simplify lintCheck target to three broad directory scans - Add argocd directory to yamllint coverage - Fix trailing whitespace across argocd example files - Fix inconsistent indentation in acm-common-mno-ranGen.yaml - Fix extra blank line in acm-group-du-clo5-cleanup.yaml - Fix missing newline at EOF in PtpConfigDualFollower.yaml - Fix existing yamllint errors in telco-ran source-crs files
1a54ed3 to
5783a59
Compare
|
@sebrandon1: This pull request references CNF-23578 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
Summary
ignore:directive in.yamllint.yamlto exclude kube-compare reference directories, extra-manifest CRs, and generated PolicyGenTemplate output — replacing the piece-wise Makefile invocationslintChecktarget to three broad directory scans (telco-core/,telco-hub/,telco-ran/)telco-ran/configuration/argocdto yamllint coveragemake lintChecklocally before pushingJira: CNF-23578