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

.azurepipelines/BuildAndTest.yml: Add markdownlint and spell check #2

Merged

Conversation

makubacki
Copy link
Member

Description

  • Run spell check against .md, .py, and .rs files in the repo

  • Run markdownlint against .md files in the repo

  • 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

PR pipelines.

Integration Instructions

N/A

@makubacki makubacki added the semver:patch Pull requests that should increment the release patch version label Sep 21, 2023
@makubacki makubacki self-assigned this Sep 21, 2023
@github-actions github-actions bot added the impact:non-functional Does not have a functional impact label Sep 21, 2023
Fixes the following issues reported by markdownlint:

  README.md:46:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
  README.md:47:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
@makubacki makubacki force-pushed the add_spellcheck_markdownlint_to_pipeline branch 2 times, most recently from 28cf567 to e20361e Compare September 21, 2023 00:41
@makubacki
Copy link
Member Author

Webhooks with Azure Pipelines will be added soon to get results back here. In the meantime, here's the run for this PR.

- Run spell check against .md, .py, and .rs files
- Run markdownlint against .md files

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
@makubacki makubacki force-pushed the add_spellcheck_markdownlint_to_pipeline branch from e20361e to 39958a5 Compare September 21, 2023 01:14
@makubacki
Copy link
Member Author

Webhooks with Azure Pipelines will be added soon to get results back here.

Done

@makubacki makubacki merged commit ce9079c into microsoft:main Sep 21, 2023
7 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 semver:patch Pull requests that should increment the release patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants