Skip to content

ci: add qlrd/pymarkdownlnt-gh-action to lint-docs workflow job #815

Open
qlrd wants to merge 1 commit into
selfcustody:developfrom
qlrd:ci/pymarkdownlnt
Open

ci: add qlrd/pymarkdownlnt-gh-action to lint-docs workflow job #815
qlrd wants to merge 1 commit into
selfcustody:developfrom
qlrd:ci/pymarkdownlnt

Conversation

@qlrd
Copy link
Copy Markdown
Member

@qlrd qlrd commented Jan 7, 2026

What is this PR for?

pymarkdownlnt is a nice lib that lints markdown documents. It check for good formatting and standards managed by CommonMark. As proof of concept, the linter was applied only to the README.md.

Changes made to:

  • Code
  • Tests
  • Docs
  • CHANGELOG

Did you build the code and tested on device?

  • Yes, build and tested on

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Docs update
  • Other

@qlrd qlrd changed the title docs: add pymarkdownlnt to lint jobs docs: add pymarkdownlnt to lint jobs Jan 7, 2026
@qlrd qlrd force-pushed the ci/pymarkdownlnt branch from 521a4b9 to a6732e5 Compare January 7, 2026 11:01
@qlrd qlrd marked this pull request as ready for review January 7, 2026 11:01
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.30%. Comparing base (9ef5803) to head (877061f).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #815   +/-   ##
========================================
  Coverage    97.30%   97.30%           
========================================
  Files           83       83           
  Lines        10798    10798           
========================================
  Hits         10507    10507           
  Misses         291      291           

☔ 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.

@odudex
Copy link
Copy Markdown
Member

odudex commented Apr 28, 2026

I think it's a great tool that contributors can spin locally and submit their results to the project.
But making project infrastructure slim has become a security priority.
Tracking decencies tree I wonder, does it worth it? I tried it locally and saw the poetry.lock file grows significantly, so I think we don't need to mandate its use.

pymarkdownlnt 0.9.34 A GitHub Flavored Markdown compliant Markdown linter.
├── application-properties >=0.9.0
│   ├── pyjson5 >=1.6.9 
│   ├── pyyaml >=5.4.1 
│   ├── tomli >=2.0.1 
│   └── typing-extensions >=4.5.0 
├── columnar >=1.4.0
│   ├── toolz * 
│   └── wcwidth * 
└── typing-extensions >=4.5.0

@qlrd qlrd marked this pull request as draft May 10, 2026 19:04
@qlrd
Copy link
Copy Markdown
Member Author

qlrd commented May 10, 2026

We can add only on CI then, or close

@odudex
Copy link
Copy Markdown
Member

odudex commented May 10, 2026

I would repurpose the PR to lint files, the single one it targets now, or more, without adding weight to the project with tools and enforcements. It would be very welcome.

@qlrd qlrd force-pushed the ci/pymarkdownlnt branch 4 times, most recently from 7b0b8e3 to 9c74acc Compare May 19, 2026 12:24
`pymarkdownlnt` is a nice lib that lints markdown documents. It check
for good formatting and standards managed by
[CommonMark](https://spec.commonmark.org/); it runs only on CI and pass
with warnings if fails.
@qlrd qlrd force-pushed the ci/pymarkdownlnt branch from 9c74acc to 877061f Compare May 19, 2026 12:51
@qlrd qlrd marked this pull request as ready for review May 19, 2026 12:52
@qlrd
Copy link
Copy Markdown
Member Author

qlrd commented May 19, 2026

I would repurpose the PR to lint files, the single one it targets now, or more, without adding weight to the project with tools and enforcements. It would be very welcome.

Done

@qlrd qlrd changed the title docs: add pymarkdownlnt to lint jobs ci: add qlrd/pymarkdownlnt-gh-action to lint-docs workflow job May 19, 2026
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