Publish versioned release websites and templated resource links - #97
Merged
Merged
Conversation
Signed-off-by: helly25 <6420169+helly25@users.noreply.github.com>
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
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.
Publish proto documentation as immutable static websites for each release, with a root redirect to the latest stable release. Release notes link to that release's website and coverage report; historical documentation can be backfilled without creating a release or moving a tag.
AG;DR
release-site.jsonmapping all 11 Markdown documents to static HTML undersite/tag/<exact-tag>/. Rewrite configured links, snapshot images, and validate internal files and anchors before retaining a snapshot..github/release-notes.md.templatebytools/release_notes.sh TAGto the existing changelog and installation notes. Link to/proto/site/tag/<tag>/and/proto/coverage/tag/<version>/.Validation before push: all 26 site/template tests, a complete conversion of the actual documentation, focused pre-commit checks (including existing coverage-policy tests), and
bazel test //...(four tests) passed. Local hooks use current Homebrew Python because the system Python is too old for an existing coverage test. Pushed-head verification and GitHub CI are recorded below as they complete.This independently includes the implementation from mbo #433, with no merge dependency. The original mbo 0.15.0 tag was successfully backfilled and deployed before merge: live snapshot. Historical proto tags with different documentation layouts need a compatible explicit configuration; missing sources never fall back to current content.
Coordinated rollout: xff #783, carve #119, coderef #113, bashtest #46, bzl #61.
Verification on pushed commit
f9c000e52488ec23fdce7ca9a9b3b3b97d89243a, current with main: all 26 site/template tests,bazel test //...(four tests), and focused pre-commit checks passed. GitHub reports the PR mergeable; CI is queued/running.