Skip to content

ci: pin docs-engine to v0.3.0 for the default Contributing page - #7

Merged
burinc merged 1 commit into
mainfrom
ci/bump-docs-engine-v0.3.0
Sep 7, 2026
Merged

burinc merged 1 commit into
mainfrom
ci/bump-docs-engine-v0.3.0

Conversation

@burinc

@burinc burinc commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

docs-engine v0.3.0 (jlt-commons/docs-engine) adds an automatic
Contributing page to every project's generated guide — purely
additive, no config required, and overridable by a project's own
docs/guide/contributing.md. glitter-uikit has no such override in
place, so it picks up the new default page as-is.

This project's site.yml calls the shared reusable workflow,
jlt-commons/ci-builds/.github/workflows/site.yml@main, whose
docs-engine-ref input still defaults to the older v0.2.0. Pinning
this project explicitly to v0.3.0 is what actually gets the new
Contributing page onto glitter-uikit's live site, rather than
waiting on the shared default to move. It also keeps this project's
build reproducible if that shared default changes again later.

Verified docs/check-site.sh has no exact guide-page-count assertion
that an extra generated page would break — only named-page-existence
checks — and this PR's own CI run is the authoritative confirmation
of that.

Prior art:

docs-engine v0.3.0 adds an automatic Contributing page to every
project's generated guide, with no config needed and no override in
place here. The shared site.yml workflow still defaults to v0.2.0, so
pinning this project's docs-engine-ref explicitly is what actually
gets the new page onto glitter-uikit's live site, and it also keeps
this build reproducible if that shared default moves again later.

Same change already landed in jlt-commons/raylib-android#8.
@burinc
burinc merged commit 90ae085 into main Sep 7, 2026
4 checks passed
@burinc
burinc deleted the ci/bump-docs-engine-v0.3.0 branch September 7, 2026 04:53
burinc added a commit that referenced this pull request Sep 17, 2026
docs-engine v0.3.0 adds an automatic Contributing page to every
project's generated guide, with no config needed and no override in
place here. The shared site.yml workflow still defaults to v0.2.0, so
pinning this project's docs-engine-ref explicitly is what actually
gets the new page onto glitter-uikit's live site, and it also keeps
this build reproducible if that shared default moves again later.

Same change already landed in jlt-commons/raylib-android#8.
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