feat: versioned release docs deployment #325
Open
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
This PR implements versioned documentation deployment with manual control over docs branch creation. Documentation can be deployed from specific release branches, allowing us to maintain docs for multiple versions while keeping full control over the process.
What's New
Manual Docs Branch Creation
release-docs-branch.ymlfor creating docs branches on-demandmajor-minor: v0.1.0 → v0.1-docs (default, reused for patches)full-version: v0.1.0 → v0.1.0-docsControlled Docs Deployment
v*-docsbranches to GitHub PagesACTIVE_DOCS_BRANCHrepository variableVersion Badge
Cargo.tomlin docs headerUpdated Banner
How to Use
Creating a Docs Branch
v0.1.0,v0.2.0)Deploying Docs
ACTIVE_DOCS_BRANCHv0.1-docsExamples
Major-Minor Strategy (Default):
ACTIVE_DOCS_BRANCH=v0.1-docs→ Docs deploy from v0.1-docsFull-Version Strategy:
ACTIVE_DOCS_BRANCH=v0.1.0-docs→ Docs deploy from that branchDesign Decisions