Skip to content

Updating Documentation release stratagy - #79

Open
Matthew Metcalf (mrm9084) wants to merge 1 commit into
mainfrom
FixingDocumentationRelease
Open

Matthew Metcalf (mrm9084) wants to merge 1 commit into
mainfrom
FixingDocumentationRelease

Conversation

@mrm9084

Copy link
Copy Markdown
Member

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/

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.0 source, 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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants