hotfix(docs): dated release-notes sections for 0.20.1–0.20.5; require them for all hotfixes - #418
Merged
Merged
Conversation
…or all hotfixes Add a dated release-notes section for this hotfix (0.20.5, public registry pulls) and backfill 0.20.1–0.20.4, which landed without sections. Codify the rule in the bump-version-and-release skill and the AGENTS.md skill table: every hotfix on main — docs-only and CI-only included — adds its own dated '## X.Y.Z — YYYY-MM-DD' patch-notes section, since the MAJOR.MINOR docs build renders all of a line's patch sections together. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… them for all hotfixes Follow-up to #417, whose release-notes/skill commit was pushed after the PR had already merged. Adds the dated patch-notes sections for hotfixes 0.20.1–0.20.5 (none had one) and codifies the rule in the bump-version-and-release skill and the AGENTS.md skill table: every hotfix on main adds its own dated '## X.Y.Z — YYYY-MM-DD' section. VERSION 0.20.5 → 0.20.6 (gate). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Test Metrics —
|
| Test | Pass | Fail | Skip | Rate |
|---|---|---|---|---|
| test_colcon_build_gcs | 1 | 0 | 0 | 100% |
| test_colcon_build_ms_airsim | 1 | 0 | 0 | 100% |
| test_colcon_build_robot | 1 | 0 | 0 | 100% |
| test_colcon_test_robot | 1 | 0 | 0 | 100% |
Metrics
| Test | Metric | Value |
|---|---|---|
| test_colcon_build_robot | duration_s | 92.2s |
| test_colcon_test_robot | duration_s | 43.09s |
| test_colcon_build_gcs | duration_s | 83.98s |
| test_colcon_build_ms_airsim | duration_s | 15.19s |
andrewjong
added a commit
that referenced
this pull request
Aug 30, 2026
…(0.20.7) (#419) * hotfix(docs): anchor exclude_docs README pattern to repo root The exclude_docs entry meant to hide the GitHub-facing repo README used the bare pattern 'README.md'. exclude_docs patterns are gitignore-style, so an unanchored name matches at every depth — silently excluding every README.md the same-dir plugin serves as a docs page. On the published 0.20 site this 404'd the System Test Suite (/tests/), the OSMO Lab Admin Guide (/osmo/), and all autonomy package reference pages, while non-README sources (e.g. tests/ci-cd-orchestrator.md) kept working. Anchor the pattern as '/README.md' so only the repo root is excluded. Verified with a local mkdocs build: tests/, osmo/, and package README pages are generated again and the root URL still serves the redirect. VERSION 0.20.6 -> 0.20.7 with a dated release-notes section per the hotfix rule from #418. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * hotfix(docs): Open Graph metadata for link previews Sharing docs.theairlab.org in Slack/WhatsApp/iMessage previewed as "Redirecting": preview scrapers fetch raw HTML without running JS or following meta-refresh, and every layer of the site lacked metadata — the root redirect stub (mike set-default), the version-root stub (/0.20/, from the mkdocs-redirects index.md map), and the content pages themselves (Material emits og: tags only via its social plugin). Three fixes, one per layer: - root: deploy the redirect via `mike set-default -T` with a custom template (.github/workflows/templates/root-redirect.html) carrying a real title, description, and OG/Twitter Card tags ({{href}} keeps the instant redirect) - version root: a post-build hook (docs/hooks/social_meta_redirect_stub.py) retitles the generated redirect stub and injects the same meta block - content pages: docs/overrides/main.html adds per-page og:title / og:description / og:image + twitter tags in block extrahead (home.html already extends main.html, so the whole site inherits), and mkdocs.yml gains site_description og:image is the 1600x900 splash poster via the moving /main/ alias, which serves real asset files, so the absolute URL survives releases. Verified with a local mkdocs build (stub injected, home hero intact, per-page titles on README pages) and by rendering the mike template with Jinja2 exactly as mike 2.2 does. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(docs): "Edit this page" pencil on every docs page Enable Material's content.action.edit feature with edit_uri so each page links to GitHub's editor for its source file; contributors without write access get GitHub's fork-and-propose flow automatically. docs_dir is the repo root, so page paths are already repo-relative and edit_uri is just the branch prefix. It defaults to edit/main/ and is overridable via the DOCS_EDIT_URI env var (mkdocs !ENV tag), which the develop docs deploy sets to edit/develop/ so unstable docs edit the branch they were built from. The landing page keeps no edit button by design: its home.html hero template has no content header. Verified with a local build — README pages link to e.g. edit/main/tests/README.md, regular pages to their own .md source. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.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.
Summary
Follow-up to #417 — that PR merged before its second commit (release notes + hotfix rule) was pushed, so those changes never reached
main. This PR carries them, rebased onto the merged main.Changes
docs/release_notes/index.md— dated patch-notes sections for 0.20.1 through 0.20.6 (none of the 0.20.x hotfixes had one; the release-notes build hook renders every section sharing the built MAJOR.MINOR, so the published /0.20/ page was silently missing all hotfix history).agents/skills/bump-version-and-release/SKILL.md— codified the rule in the Update the Release Notes step, the Release Notes Conventions rules, and the release checklist: every hotfix onmain(docs-only and CI-only included) adds its own dated## X.Y.Z — YYYY-MM-DDsectionAGENTS.md— skill-table row forbump-version-and-releasenow states the requirement.env— VERSION 0.20.5 → 0.20.6 (gate; docs-only, publish should retag)🤖 Generated with Claude Code