You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "villebro (via GitHub)" <gi...@apache.org> on 2026/07/07 20:14:48 UTC
[PR] build: add rumdl for deterministic Markdown formatting [superset-kubernetes-operator]
villebro opened a new pull request, #175:
URL: https://github.com/apache/superset-kubernetes-operator/pull/175
## Summary
Introduce [rumdl](https://rumdl.dev/) — a fast, self-contained Rust Markdown linter/formatter — to enforce a single deterministic format across the README, the docs site, and other Markdown files. Until now Markdown had no linter, so formatting drifted: inconsistent heading spacing and list indentation, and mixed prose conventions (some docs used single-line paragraphs, others hard-wrapped at ~80 columns). rumdl gives one canonical, machine-enforced format wired into CI, a local pre-commit hook, and Renovate for version bumps. It ships as a pinned binary, so it adds no Python or Node runtime dependency.
Prose is normalized to one line per paragraph (no hard wrapping). Because Markdown collapses newlines within a paragraph, rendered output is unchanged — this is purely a source/version-control choice that keeps diffs clean (editing a sentence never reflows the surrounding lines).
## Details
- **Tooling** (`Makefile`): `RUMDL_VERSION` pin (tracked by the existing github-releases Renovate custom manager); `make rumdl` downloads and checksum-verifies the release binary into `bin/`; `make lint-md` (check) and `make format-md` (auto-fix).
- **Config**: rules live in the repo-root `.rumdl.toml` (`gfm` flavor, for the GitHub-rendered README and other top-level files) with `MD013` reflow in `normalize` mode for single-line prose. `docs/.rumdl.toml` `extends` it and overrides the flavor to `mkdocs` so admonitions/content tabs are understood on the docs site. The generated `docs/reference/api-reference.md` and the `.github` templates are excluded.
- **CI**: a `Lint Markdown` step in the lint job fails if any file isn't in canonical form.
- **Pre-commit** (`.githooks/pre-commit`): reformats staged Markdown in a single `rumdl` pass and aborts the commit if anything changed (or if unfixable issues remain), so the author reviews and re-stages — nothing is silently amended.
- **Generator fix** (`scripts/render-make-commands.sh`): emits a trailing blank line so its generated table stays rumdl-clean.
- **Reformat**: all existing Markdown converted to the canonical form (the bulk of the diff).
- **Bycatch**: corrects a stale `kubectl get supersets` example in `docs/index.md` (`VERSION` → `TAG`, and adds the missing `LIFECYCLE` column) to match the CRD's printer columns.
Verification: `make lint-md` is clean and idempotent, and `mkdocs build --strict` passes on the reformatted docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] build: add rumdl for deterministic Markdown formatting [superset-kubernetes-operator]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #175:
URL: https://github.com/apache/superset-kubernetes-operator/pull/175#issuecomment-4908512305
## [Codecov](https://app.codecov.io/gh/apache/superset-kubernetes-operator/pull/175?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 89.87%. Comparing base ([`18ad5c6`](https://app.codecov.io/gh/apache/superset-kubernetes-operator/commit/18ad5c6abfdc236aa6ce900b5eac3101d1366327?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`a9f0abc`](https://app.codecov.io/gh/apache/superset-kubernetes-operator/commit/a9f0abcb8e797e8a174df21038e6e47d811db6c3?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
[:umbrella: View full report in Codecov by Harness](https://app.codecov.io/gh/apache/superset-kubernetes-operator/pull/175?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] build: add rumdl for deterministic Markdown formatting [superset-kubernetes-operator]
Posted by "villebro (via GitHub)" <gi...@apache.org>.
villebro merged PR #175:
URL: https://github.com/apache/superset-kubernetes-operator/pull/175
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org