feat: render a report as a Markdown page for a GitLab wiki - #3
Merged
Merged
Conversation
…targets, report unwritable pages
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
release-scope render report.json -o report.md. It turns a collected report into a Markdown page for a GitLab wiki without calling GitLab.Page
N changes · untagged head) and a failures cell (❌ blocking · ⚠️ N allowed).<details>table showing their production refs.|, brackets,</>, and newlines become<br>. Link targets encode space,)and|.<details>; this follows the GitLab Flavored Markdown docs.Design
_render.py, with no template engine and no new dependency.renderexits 2 on an unreadable or unknown-schema report and 1 when it can't write the page. It writes the file atomically.collectgets no--markdownflag. The README chains the two commands with;rather than&&, becausecollectexits 1 exactly when the page should show a failed service.allow_failurejobs, and important jobs that are allowed to fail still matter, just less.Checks
75 tests pass at 100% coverage. They include a golden test of a full page with services that are changed, up to date, failed and skipped. I haven't yet checked the result rendered in a real GitLab wiki.