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 mdformat to precommit #2906

Closed
wants to merge 17 commits into from
Closed

Add mdformat to precommit #2906

wants to merge 17 commits into from

Conversation

SorenSpicknall
Copy link
Contributor

@SorenSpicknall SorenSpicknall commented Aug 23, 2023

Description

Automatically lint changed markdown files in the repo during precommit. Will supersede #2897 if accepted. This PR includes an initial repo-wide run of the new tool with some small hand fixes (specifically, Kubernetes -> architecture and Kubernetes -> deployment in the Developers section of the docs site had some empty headers that needed to be filled in).

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

How has this been tested?

Testing has already taken place locally, and will take place on this PR while open.

Post-merge follow-ups

  • No action required
  • Actions required (specified below)

@github-actions
Copy link

@github-actions
Copy link

Copy link
Contributor

@atvaccaro atvaccaro left a comment

Choose a reason for hiding this comment

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

lgtm except for one regex recommendation

I'm not sure of a good way to test this except by manually comparing all of the rendered pages :(

.pre-commit-config.yaml Outdated Show resolved Hide resolved
@SorenSpicknall
Copy link
Contributor Author

Closing in favor of #2923

@SorenSpicknall SorenSpicknall deleted the mdformat-precommit branch December 12, 2023 16:30
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.

2 participants