Skip to content

Conversation

@qlrd
Copy link
Member

@qlrd qlrd commented Jan 6, 2026

markdown-cli is low maintained and pymarkdownlnt appears to be a good choice given its features. Also, with this change, the CHANGELOG was changed.

@qlrd qlrd requested a review from Copilot January 6, 2026 16:39
@qlrd qlrd requested review from jdlcdl, odudex and tadeubas January 6, 2026 16:39
@qlrd qlrd marked this pull request as draft January 6, 2026 16:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR replaces the low-maintained markdown-cli tool with pymarkdownlnt for markdown linting in the CI pipeline. The change consolidates markdown linting into the main Poetry-based toolchain and updates the CHANGELOG with recent project changes.

  • Adds pymarkdownlnt as a dev dependency with appropriate rule configuration
  • Removes the separate GitHub Actions markdown linting job in favor of Poetry task integration
  • Updates CHANGELOG.md with version 0.0.21 entries and improves formatting consistency

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
pyproject.toml Adds pymarkdownlnt dependency and integrates markdown linting into the Poetry lint task sequence
.github/workflows/ci.yml Removes the standalone markdown linting job (job2) that used markdownlint-cli
CHANGELOG.md Adds version 0.0.21 entries and converts inconsistent bullet formatting to standard hyphenated lists

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@qlrd qlrd force-pushed the ci/lint-markdown branch from 6fd5cfc to 9e0f894 Compare January 6, 2026 20:11
`markdown-cli` is low maintained and `pymarkdownlnt` appears to be a
good choice given its features. Also, with this change, the CHANGELOG
was changed.
@qlrd qlrd force-pushed the ci/lint-markdown branch from 9e0f894 to 8a21c64 Compare January 6, 2026 20:13
@qlrd qlrd marked this pull request as ready for review January 6, 2026 20:16
@codecov
Copy link

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.60%. Comparing base (3dd1c9a) to head (8a21c64).
⚠️ Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #201      +/-   ##
==========================================
- Coverage   98.76%   98.60%   -0.16%     
==========================================
  Files          63       63              
  Lines        3167     3236      +69     
  Branches      273      284      +11     
==========================================
+ Hits         3128     3191      +63     
- Misses         24       26       +2     
- Partials       15       19       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant