ci: pin docs-engine to v0.3.0 for the default Contributing page - #7
Merged
Merged
Conversation
docs-engine v0.3.0 adds an automatic Contributing page to every project's generated guide, purely additive and overridable by a project's own docs/guide/contributing.md. The shared site.yml reusable workflow still defaults docs-engine-ref to v0.2.0, so pinning it here explicitly is what actually gets the new page onto this project's live site. Pinning also keeps the build reproducible: once the shared default moves past v0.3.0, this project won't pick up a later version until someone bumps the pin on purpose. Same change as jlt-commons/raylib-android#8.
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
1 participant
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.
What
Pins this project's site build to `docs-engine-ref: v0.3.0` on the shared `jlt-commons/ci-builds` site workflow, instead of riding that workflow's own default (still `v0.2.0`).
Why
docs-engine v0.3.0 adds an automatic Contributing page to every project's generated guide. It's purely additive, needs no config, and a project's own `docs/guide/contributing.md` can still override it. The shared `site.yml` reusable workflow takes an optional `docs-engine-ref` input, but that input still defaults to `v0.2.0` — so without an explicit pin here, this project's live site never picks up the new page.
Pinning explicitly also keeps the build reproducible: once the shared default moves past v0.3.0, this project won't follow it until the pin is bumped on purpose.
Verified `docs/check-site.sh` has no exact guide-page-count assertion, only named-page-existence checks (e.g. `guide/architecture.html`, `guide/widgets.html`), so the extra generated page shouldn't trip it. Letting the actual CI run on this PR confirm that.
Prior art