Test markdown validity after usethis badge calls#1584
Merged
Conversation
Creates a canonical expected_all_badges.md file that prek (markdownlint + prettier) validates, and a test that runs all 7 badge commands on a blank-slate project and compares the resulting README against this canonical file. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d900c1cf-759f-4cd3-85a2-4ccac33d5116 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add test for markdown validity after usethis badge calls
Test markdown validity after Mar 27, 2026
usethis badge calls
nathanjmcdougall
approved these changes
Mar 27, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a regression guard against invalid badge markdown (like #923) by comparing badge output against a canonical
.mdfile that prek validates.tests/usethis/_core/assets/expected_all_badges.md— the expected README after all 7 badge commands run in sequence. Validated by markdownlint-cli2 + prettier via prek hooks.TestAllBadgesMarkdownValidintest_core_badge.py— sets up a blank-slate project, runs alladd_badge()calls in order, asserts output matches the canonical file.If badge output changes to produce invalid markdown, either the test fails (output mismatch) or the canonical file update gets caught by prek.
⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.