ci: pin docs-engine to v0.3.0 for the default Contributing page - #8
Merged
Merged
Conversation
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 reusable workflow still defaults docs-engine-ref to v0.2.0, so picking up the new page here means naming v0.3.0 explicitly rather than waiting on the shared default to move. Pinning it also keeps this project's site build reproducible: a future bump of the shared default won't silently change what this repo publishes until the pin is bumped on purpose. Mirrors 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 v0.3.0 via the shared
docs-engine-refinput onjlt-commons/ci-builds/.github/workflows/site.yml@main,which currently defaults to v0.2.0.
Why
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. Pinning the refexplicitly is what actually gets that page onto this project's live
site, rather than waiting for the shared workflow's own default to
move.
Pinning also keeps the build reproducible: a future bump of the
shared default won't silently change what this repo publishes until
the pin here is bumped on purpose.
Verification
docs/check-site.shasserts specific named pages by path and doesn'tcount total pages, so the new Contributing page shouldn't trip it.
The new page only lands in the guide's root directory, so this
project's nested
docs/guide/adr/is untouched. CI on this PR is theauthoritative check.
Prior art
18bd3ea