Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pre-commit: enable markdownlint rule MD018 #9134

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jbampton
Copy link
Member

https://github.com/DavidAnson/markdownlint/blob/main/doc/md018.md

Description

This PR adds another check for our Markdown linter.

MD018/no-missing-space-atx No space after hash on atx style heading.

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 locally:

pre-commit run --all-files

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

Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.78%. Comparing base (554ea22) to head (009ed10).
Report is 12 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #9134      +/-   ##
============================================
- Coverage     16.60%   15.78%   -0.83%     
- Complexity    12565    12613      +48     
============================================
  Files          5235     5627     +392     
  Lines        460072   494665   +34593     
  Branches      56928    61938    +5010     
============================================
+ Hits          76408    78091    +1683     
- Misses       375338   408082   +32744     
- Partials       8326     8492     +166     
Flag Coverage Δ
uitests 4.04% <ø> (?)
unittests 16.60% <ø> (-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 marked this pull request as draft May 29, 2024 08:13
@jbampton jbampton force-pushed the pre-commit-enable-markdownlint-MD018 branch from 2ee987a to 6dede89 Compare June 11, 2024 06:26
@jbampton jbampton marked this pull request as ready for review June 11, 2024 06:29
@jbampton
Copy link
Member Author

jbampton commented Jul 8, 2024

@blueorangutan package

@blueorangutan
Copy link

@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
Copy link

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

@jbampton jbampton force-pushed the pre-commit-enable-markdownlint-MD018 branch from 49deede to 009ed10 Compare October 14, 2024 11:46
@jbampton jbampton marked this pull request as ready for review October 14, 2024 11:49
@jbampton
Copy link
Member Author

@blueorangutan package

@blueorangutan
Copy link

@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
Copy link

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

Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

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

clgtm

Copy link
Member

@vishesh92 vishesh92 left a comment

Choose a reason for hiding this comment

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

lgtm

@DaanHoogland
Copy link
Contributor

@JoaoJandre , can we merge these linting changes (mostly by @jbampton ) during freeze? I don't think any of them have code changes. At least this one hasn't .

@JoaoJandre
Copy link
Contributor

@JoaoJandre , can we merge these linting changes (mostly by @jbampton ) during freeze? I don't think any of them have code changes. At least this one hasn't .

@DaanHoogland I don't see why we would merge them during a freeze. Although they generally do not pose any risks (at least this one doesn't), they are also not really high priority, are they? I see no problem in waiting until we release to merge these.

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

Successfully merging this pull request may close these issues.

5 participants