Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add markdownlint with pre-commit#9078

Merged
DaanHoogland merged 1 commit into
apache:mainfrom
jbampton:add-markdownlint-with-pre-commit
May 28, 2024
Merged

Add markdownlint with pre-commit#9078
DaanHoogland merged 1 commit into
apache:mainfrom
jbampton:add-markdownlint-with-pre-commit

Conversation

@jbampton

@jbampton jbampton commented May 13, 2024

Copy link
Copy Markdown
Member

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)
  • 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 jbampton marked this pull request as draft May 13, 2024 02:16
@codecov

codecov Bot commented May 13, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

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%) ⬆️

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.

@jbampton jbampton force-pushed the add-markdownlint-with-pre-commit branch from 3df8314 to e4b125b Compare May 13, 2024 02:54
@jbampton

Copy link
Copy Markdown
Member Author

@blueorangutan package

@blueorangutan

Copy link
Copy Markdown

@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 jbampton marked this pull request as ready for review May 13, 2024 04:17
@blueorangutan

Copy link
Copy Markdown

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

@shwstppr shwstppr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants