Skip to content

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

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 adds an automatic Contributing page to every generated site. It's purely additive, needs no config, and any project can override it with its own docs/guide/contributing.md.

This project's site.yml calls the shared jlt-commons/ci-builds reusable workflow, whose docs-engine-ref input still defaults to v0.2.0. Without an explicit pin here, the published site keeps building against the old version and never gets the new page.

This bumps the pin to v0.3.0 and adds a comment explaining why it's pinned explicitly rather than left on the shared workflow's default: it keeps this project's build reproducible even after that default moves again.

Same change already landed as prior art in jlt-commons/raylib-android#8, following the feature introduced in jlt-commons/docs-engine#2.

docs-engine v0.3.0 adds an automatic Contributing page to every
generated site, purely additive and overridable by a project's own
docs/guide/contributing.md. The shared site.yml workflow still
defaults its docs-engine-ref input to v0.2.0, so this project needs
an explicit pin to actually pick up the new page on its published
site.

Pinning here rather than relying on the shared default also keeps
this project's build reproducible the next time that default moves.

Same pattern already landed in jlt-commons/raylib-android#8.
@burinc
burinc merged commit 9184342 into main Sep 7, 2026
5 checks passed
@burinc
burinc deleted the ci/bump-docs-engine-v0.3.0 branch September 7, 2026 04:53
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