Add yamllint pre-commit hook for YAML file standardization #11017

vanzan01 · 2025-06-12T15:54:09Z

Add yamllint hook to .pre-commit-config.yaml to standardize YAML files across the project. Created .yamllint.yml configuration with relaxed rules to accommodate existing files. Fixed colon spacing in .asf.yaml to pass yamllint checks.

Changes

Add yamllint hook to .pre-commit-config.yaml
Create .yamllint.yml configuration with relaxed rules for existing files
Fix colon spacing in .asf.yaml to pass yamllint checks

Test plan

yamllint runs successfully on existing YAML files
Configuration allows existing files to pass with minimal changes
Fixed formatting issue in .asf.yaml

Closes #10974

Add yamllint hook to .pre-commit-config.yaml to standardize YAML files across the project. Created .yamllint.yml configuration with relaxed rules to accommodate existing files. Fixed colon spacing in .asf.yaml to pass yamllint checks. Closes apache#10974 Signed-off-by: vanzan01 <[email protected]>

boring-cyborg · 2025-06-12T15:54:17Z

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

In case of a new feature add useful documentation (raise doc PR at https://github.com/apache/cloudstack-documentation)
Be patient and persistent. It might take some time to get a review or get the final approval from the committers.
Pay attention to the quality of your code, ensure tests are passing and your PR doesn't have conflicts.
Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Issues, Mailing list and Slack.
Be sure to read the CloudStack Coding Conventions.
Apache CloudStack is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: [email protected] (https://cloudstack.apache.org/mailing-lists.html)
Slack: https://apachecloudstack.slack.com/

.yamllint.yml

Address review comment from DaanHoogland Signed-off-by: vanzan01 <[email protected]>

DaanHoogland · 2025-06-14T09:15:17Z

@blueorangutan package

blueorangutan · 2025-06-14T09:16:03Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2025-06-14T09:21:47Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 17.39%. Comparing base (a466750) to head (2972ea2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##              main   #11017       +/-   ##
============================================
+ Coverage     3.62%   17.39%   +13.77%     
- Complexity       0    15284    +15284     
============================================
  Files          441     5889     +5448     
  Lines        37136   526184   +489048     
  Branches      6808    64242    +57434     
============================================
+ Hits          1346    91540    +90194     
- Misses       35626   424299   +388673     
- Partials       164    10345    +10181

Flag	Coverage Δ
uitests	`3.62% <ø> (ø)`
unittests	`18.44% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

blueorangutan · 2025-06-14T10:43:42Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13778

DaanHoogland · 2025-06-16T12:55:44Z

@blueorangutan package

blueorangutan · 2025-06-16T12:58:04Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-16T14:16:16Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✔️ debian ✖️ suse15. SL-JID 13794

blueorangutan · 2025-06-17T11:32:30Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13815

DaanHoogland

clgtm

.yamllint.yml

.pre-commit-config.yaml

- Move .yamllint.yml to .github/linters/ directory for better organization - Update pre-commit config to point to new location - Change file pattern to \.ya?ml$ as suggested Address review feedback from jbampton Signed-off-by: vanzan01 <[email protected]>

.pre-commit-config.yaml

Co-authored-by: John Bampton <[email protected]>

jbampton

https://github.com/apache/cloudstack/actions/runs/15782986518/job/44493446898?pr=11017

Can you fix the pre-commit workflow ?

- Remove extensive file exclusions, keep only k8s templates - Increase line length limit to 400 chars (GitHub Actions friendly) - Allow flexible colon spacing (max-spaces-after: -1) - Disable document-start requirement This provides linting value while handling infrastructure patterns. Signed-off-by: vanzan01 <[email protected]>

sureshanaparti

clgtm

sureshanaparti · 2025-07-14T11:06:16Z

@blueorangutan package

blueorangutan · 2025-07-14T11:08:05Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

DaanHoogland · 2025-07-14T11:09:50Z

@jbampton , are your concerns addressed on this PR?

blueorangutan · 2025-07-14T16:00:25Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14170

.pre-commit-config.yaml

Co-authored-by: John Bampton <[email protected]>

jbampton · 2025-09-19T15:45:46Z

@blueorangutan package

blueorangutan · 2025-09-19T15:48:03Z

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

jbampton

Looks good.

pre-commit passes and no real code touched.

blueorangutan · 2025-09-19T17:10:12Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15109

jbampton · 2025-09-19T17:15:50Z

3 approvals and the checks pass. No code changes just config files and minor whitespace.

Merging.

boring-cyborg · 2025-09-19T17:16:03Z

Awesome work, congrats on your first merged pull request!

) * Add yamllint pre-commit hook for YAML file standardization Add yamllint hook to .pre-commit-config.yaml to standardize YAML files across the project. Created .yamllint.yml configuration with relaxed rules to accommodate existing files. Fixed colon spacing in .asf.yaml to pass yamllint checks. Closes apache#10974 Signed-off-by: vanzan01 <[email protected]> * Add extra eol to .yamllint.yml Address review comment from DaanHoogland Signed-off-by: vanzan01 <[email protected]> * Move .yamllint.yml to .github/linters/ and improve file pattern - Move .yamllint.yml to .github/linters/ directory for better organization - Update pre-commit config to point to new location - Change file pattern to \.ya?ml$ as suggested Address review feedback from jbampton Signed-off-by: vanzan01 <[email protected]> * Update .pre-commit-config.yaml Co-authored-by: John Bampton <[email protected]> * Make yamllint more forgiving and exclude only k8s templates - Remove extensive file exclusions, keep only k8s templates - Increase line length limit to 400 chars (GitHub Actions friendly) - Allow flexible colon spacing (max-spaces-after: -1) - Disable document-start requirement This provides linting value while handling infrastructure patterns. Signed-off-by: vanzan01 <[email protected]> * Update .pre-commit-config.yaml Co-authored-by: John Bampton <[email protected]> --------- Signed-off-by: vanzan01 <[email protected]> Co-authored-by: John Bampton <[email protected]>

DaanHoogland reviewed Jun 13, 2025

View reviewed changes

.yamllint.yml Outdated Show resolved Hide resolved

Add extra eol to .yamllint.yml

89cf7a6

Address review comment from DaanHoogland Signed-off-by: vanzan01 <[email protected]>

DaanHoogland force-pushed the main branch from 89cf7a6 to 4acfdf5 Compare June 16, 2025 12:55

DaanHoogland approved these changes Jun 17, 2025

View reviewed changes

jbampton requested changes Jun 20, 2025

View reviewed changes

.yamllint.yml Show resolved Hide resolved

.pre-commit-config.yaml Outdated Show resolved Hide resolved

vanzan01 force-pushed the main branch from 4acfdf5 to 6a94e6f Compare June 20, 2025 15:52

jbampton reviewed Jun 20, 2025

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

Update .pre-commit-config.yaml

c3f9d60

Co-authored-by: John Bampton <[email protected]>

jbampton requested changes Jun 20, 2025

View reviewed changes

vanzan01 requested a review from jbampton June 21, 2025 06:46

DaanHoogland added this to the 4.21.0 milestone Jul 7, 2025

sureshanaparti added this to Apache CloudStack 4.21.0 Jul 14, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jul 14, 2025

sureshanaparti approved these changes Jul 14, 2025

View reviewed changes

sureshanaparti closed this Jul 14, 2025

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.21.0 Jul 14, 2025

sureshanaparti reopened this Jul 14, 2025

sureshanaparti moved this from Done to In Progress in Apache CloudStack 4.21.0 Jul 14, 2025

jbampton reviewed Jul 14, 2025

View reviewed changes

.pre-commit-config.yaml Show resolved Hide resolved

Update .pre-commit-config.yaml

e74dd6d

Co-authored-by: John Bampton <[email protected]>

jbampton self-requested a review July 23, 2025 16:49

weizhouapache modified the milestones: 4.21.0, 4.22.0 Aug 29, 2025

sureshanaparti added this to Apache CloudStack 4.22.0 Aug 29, 2025

sureshanaparti removed this from Apache CloudStack 4.21.0 Aug 29, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.0 Aug 29, 2025

Merge branch 'main' into main

2972ea2

jbampton self-assigned this Sep 19, 2025

jbampton approved these changes Sep 19, 2025

View reviewed changes

jbampton merged commit e6c7a71 into apache:main Sep 19, 2025
28 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.0 Sep 19, 2025

Add yamllint pre-commit hook for YAML file standardization #11017

Add yamllint pre-commit hook for YAML file standardization #11017

Uh oh!

Conversation

vanzan01 commented Jun 12, 2025

Changes

Test plan

Uh oh!

boring-cyborg bot commented Jun 12, 2025

Uh oh!

Uh oh!

DaanHoogland commented Jun 14, 2025

Uh oh!

blueorangutan commented Jun 14, 2025

Uh oh!

codecov bot commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jun 14, 2025

Uh oh!

DaanHoogland commented Jun 16, 2025

Uh oh!

blueorangutan commented Jun 16, 2025

Uh oh!

blueorangutan commented Jun 16, 2025

Uh oh!

blueorangutan commented Jun 17, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jbampton left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 14, 2025

Uh oh!

DaanHoogland commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 14, 2025

Uh oh!

Uh oh!

jbampton commented Sep 19, 2025

Uh oh!

blueorangutan commented Sep 19, 2025

Uh oh!

jbampton left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Sep 19, 2025

Uh oh!

jbampton commented Sep 19, 2025

Uh oh!

Uh oh!

boring-cyborg bot commented Sep 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Jun 14, 2025 •

edited

Loading