cloudstack icon indicating copy to clipboard operation
cloudstack copied to clipboard

Add `markdownlint` with `pre-commit`

Open jbampton opened this issue 1 year ago • 4 comments

https://github.com/DavidAnson/markdownlint/tree/main?tab=readme-ov-file#rules--aliases

https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#use-with-pre-commit

Description

This PR adds some checking for Markdown files with pre-commit.

I have added a markdownlint config file which sets a basic standard to start with.

markdownlint is a popular tool and helps improve readability and the portability of the Markdown files.

If needed further clean ups of the Markdown files can be done in future PRs.

Types of changes

  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] Enhancement (improves an existing feature and functionality)
  • [ ] Cleanup (Code refactoring and cleanup, that may add test cases)
  • [x] build/CI

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • [ ] Major
  • [ ] Minor

Bug Severity

  • [ ] BLOCKER
  • [ ] Critical
  • [ ] Major
  • [ ] Minor
  • [ ] Trivial

Screenshots (if appropriate):

How Has This Been Tested?

Ran pre-commit run --all-files

How did you try to break this feature and the system with this change?

jbampton avatar May 13 '24 02:05 jbampton

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 15.28%. Comparing base (21af134) to head (e4b125b).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #9078   +/-   ##
=========================================
  Coverage     15.28%   15.28%           
+ Complexity    11535    11534    -1     
=========================================
  Files          5425     5425           
  Lines        474138   474138           
  Branches      58984    58969   -15     
=========================================
+ Hits          72486    72490    +4     
+ Misses       393584   393581    -3     
+ Partials       8068     8067    -1     
Flag Coverage Δ
uitests 4.26% <ø> (ø)
unittests 16.02% <ø> (+<0.01%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 13 '24 02:05 codecov[bot]

@blueorangutan package

jbampton avatar May 13 '24 04:05 jbampton

@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.

blueorangutan avatar May 13 '24 04:05 blueorangutan

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

blueorangutan avatar May 13 '24 05:05 blueorangutan