Skip to content

feat(drivercentral): a facts strip not yet uploaded is left out of the description, with a build warning - #200

Merged
derek-miller merged 1 commit into
mainfrom
feat/facts-strip-warning
Nov 10, 2026
Merged

derek-miller merged 1 commit into
mainfrom
feat/facts-strip-warning

Conversation

@derek-miller

Copy link
Copy Markdown
Contributor

A description whose facts strip isn't uploaded to DriverCentral yet still has FACTS-STRIP-URL as the image's src. make build carried that into listing/description.html, so a paste showed a broken image at the top of the listing. Eight repos shipped that way before anyone noticed.

What it does now

  • docs.py description leaves out an image whose src is FACTS-STRIP-URL, with or without its <p>. A paste before the upload shows no strip instead of a broken one. Any other image is untouched.
  • make docs-drivercentral prints a ::warning:: naming resources/drivercentral/description.md while the placeholder is there. It shows as an annotation on the Build run, a tag build included, and tells you which file to upload and where its URL goes.
  • Nothing fails. On Derek's call, a missing strip never blocks a tag, so the GitHub release and the rest of the DriverCentral kit still build.
  • CONTRIBUTING says the same in one paragraph.

Checked: the default render's render and build checks pass. Its seeded description prints the warning, and its description.html starts at the Overview. A direct run removes the placeholder in both forms and keeps a real strip URL.

What reaches a driver repo

On copier update, tools/docs.py, the Makefile and CONTRIBUTING change. It goes out with the next template tag's normal re-roll.

@svc-finitelabs svc-finitelabs Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I checked the strip line as it stands in all six driver repos still on the placeholder, plus the bare <img> form two live repos use and a markdown ![](FACTS-STRIP-URL). The new description() drops each one, keeps a real DriverCentral strip URL, and starts at <h3>Overview</h3>. Main's docs.py keeps the placeholder in all three placeholder forms (the control). I also ran make build locally on the default render, packaging included: it prints the warning once and the listing's description.html has no FACTS left in it.

@derek-miller
derek-miller merged commit d622ff4 into main Nov 10, 2026
20 checks passed
@derek-miller
derek-miller deleted the feat/facts-strip-warning branch November 10, 2026 17:00
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