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

Add markdownlint as a pytool plugin [Rebase & FF] #928

Conversation

kenlautner
Copy link
Contributor

@kenlautner kenlautner commented Jun 18, 2024

Description

Cherry-pick commits that add markdownlint as a pytool plugin as well as markdown fixes in several MD files.
Commits from 202311 included here:

df8805c
6d509b2
72f4ac0
40da3f2
984dee9
c149b3f
aa5ae2a
26eb685
26e38dc

  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

N/A

Integration Instructions

N/A

@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from d956fb2 to 03fe0c1 Compare June 21, 2024 00:56
@github-actions github-actions bot added the impact:non-functional Does not have a functional impact label Jun 21, 2024
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from d4f36e6 to 6b792e0 Compare June 24, 2024 21:01
@codecov-commenter
Copy link

codecov-commenter commented Jun 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release/202405@41f41fc). Learn more about missing BASE report.

Additional details and impacted files
@@                Coverage Diff                @@
##             release/202405     #928   +/-   ##
=================================================
  Coverage                  ?    1.25%           
=================================================
  Files                     ?     1424           
  Lines                     ?   358662           
  Branches                  ?     4391           
=================================================
  Hits                      ?     4495           
  Misses                    ?   354106           
  Partials                  ?       61           
Flag Coverage Δ
MdeModulePkg 0.24% <ø> (?)
MdePkg 5.41% <ø> (?)
NetworkPkg 0.55% <ø> (?)
UefiCpuPkg 4.80% <ø> (?)

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.

@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from 8eadb14 to 46692cd Compare June 27, 2024 20:38
@kenlautner kenlautner added the language:python Pull requests that update Python code label Jun 28, 2024
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from 46692cd to e29f524 Compare June 28, 2024 02:39
@github-actions github-actions bot removed the language:python Pull requests that update Python code label Jun 28, 2024
.pytool/Plugin/SpellCheck/cspell.base.yaml Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch 3 times, most recently from 3a70fc9 to 8e4f87f Compare June 29, 2024 03:19
@makubacki makubacki changed the title Add markdownlint as a pytool plugin Add markdownlint as a pytool plugin [Rebase & FF] Jul 1, 2024
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch 3 times, most recently from 9274db6 to d6c687f Compare July 3, 2024 16:50
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
UnitTestFrameworkPkg/ReadMe.md Outdated Show resolved Hide resolved
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from d6c687f to e1890bc Compare July 12, 2024 23:11
spbrogan and others added 2 commits July 12, 2024 16:13
REBASE: Fixed markdown lint errors in various .md files

UnitTestFrameworkPkg: Fix markdownlint issues

Fixes markdownlint issues introduced from edk2 cherry-picks.

Signed-off-by: Michael Kubacki <[email protected]>

Fixed markdown issues that changes from edk2 brought

Fixed Markdown errors MdeModulePkg
@kenlautner kenlautner force-pushed the personal/klautner/add_markdownlint branch from e1890bc to fd9fe7a Compare July 12, 2024 23:17
@kenlautner kenlautner enabled auto-merge (rebase) July 12, 2024 23:24
@kenlautner kenlautner merged commit cb4dd47 into microsoft:release/202405 Jul 12, 2024
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants