Repository navigation
Updating Documentation release stratagy - #79
Open
Matthew Metcalf (mrm9084) wants to merge 1 commit into
Open
Matthew Metcalf (mrm9084) wants to merge 1 commit into
Matthew Metcalf (mrm9084) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified for the release-tag-based documentation build changes.
No open issues 🎉
What changed in this PR
This PR introduces a release-tag-based documentation build for FeatureManagement Python, replacing manual page updates with validated artifacts and opt-in GitHub Pages deployment.
Changes:
- Builds documentation from verified
v2.2.0source, with versioned pages,/latest/aliases, and legacy redirects. - Validates release identity, local links, and API anchors, with regression tests.
- Adds preview builds and manual deployment, plus local build and rollback instructions.
| File | Description |
|---|---|
tests/test_release_docs.py |
Tests release verification, redirects, and site validation. |
scripts/build_release_docs.py |
Builds and validates documentation from a stable release tag. |
README.md |
Documents local builds, deployment, rollback, and current scope. |
project-words.txt |
Adds documentation tooling terms to the spelling dictionary. |
docs/requirements.txt |
Pins documentation build dependencies. |
docs/_sphinx/conf.py |
Configures rendering and historical docstring corrections. |
.gitignore |
Excludes the local release checkout. |
.github/workflows/docs.yml |
Adds documentation builds, artifact uploads, and opt-in Pages deployment. |
Review effort: Balanced
This branch has not been deployed
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.
Description
This PR updates the method used to update the api documentation. This is step one updating some pipelines, currently someone needs to manually update the gh pages to release new docs.
https://microsoft.github.io/FeatureManagement-Python/