Skip to content

markdownlint for 3.1.1.md #4041

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

Merged
merged 5 commits into from
Aug 26, 2024
Merged

Conversation

ralfhandl
Copy link
Contributor

@ralfhandl ralfhandl commented Aug 19, 2024

  • Github Workflow: markdownlint after mdv on 3.1.1.md only (because the older files won't pass)
    • this ensures new pushes comply with our linter rules in the main branch
  • add npm script format-markdown to conveniently reformat markdown after changes
  • add .markdownlint.yaml because the npm script needs it
  • did not run the script on 3.1.1.md to not mess up other open PRs

Part of

@ralfhandl ralfhandl requested review from lornajane, handrews, mikekistler and a team August 19, 2024 13:21
@ralfhandl ralfhandl added this to the v3.1.1 milestone Aug 19, 2024
@ralfhandl ralfhandl added Housekeeping script Pull requests that update Bash or JavaScript code labels Aug 19, 2024
@ralfhandl ralfhandl linked an issue Aug 19, 2024 that may be closed by this pull request
mikekistler
mikekistler previously approved these changes Aug 20, 2024
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@ralfhandl ralfhandl marked this pull request as draft August 20, 2024 13:33
@ralfhandl
Copy link
Contributor Author

Update after #4027 is merged, check out .markdownlint.yaml from main and use it for validation.

@ralfhandl ralfhandl marked this pull request as ready for review August 22, 2024 12:53
@ralfhandl ralfhandl requested a review from mikekistler August 22, 2024 12:54
@@ -0,0 +1,16 @@
# Unordered list symbol
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you need this file if you are going to pull the .markdownlint.yaml from main? Or we could just commit the same version of .markdownlint.yaml in the root directory in all the branches -- that might be simpler.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

validate-markdown.yaml pulls package.json and package-lock.json from main, most likely to make sure that the same version of mdv is used across all branches, so it makes sense to also use the same linter ruleset across all branches.

The "branch-local" copy of .markdownlint.yaml allows formatting the current spec markdown locally.

@ralfhandl ralfhandl requested a review from mikekistler August 22, 2024 17:06
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

@ralfhandl ralfhandl merged commit 4573bd7 into OAI:v3.1.1-dev Aug 26, 2024
1 check passed
@ralfhandl ralfhandl deleted the v3.1.1-dev-markdownlint branch August 26, 2024 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping script Pull requests that update Bash or JavaScript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add whitespace/formatting automation to the build process
3 participants