Skip to content

fix: Automate versioned documentation publication - #6763

Open
larrysingleton007 wants to merge 4 commits into
feast-dev:masterfrom
larrysingleton007:feature/issue-6762-automate-and-verify-versioned
Open

fix: Automate versioned documentation publication#6763
larrysingleton007 wants to merge 4 commits into
feast-dev:masterfrom
larrysingleton007:feature/issue-6762-automate-and-verify-versioned

Conversation

@larrysingleton007

@larrysingleton007 larrysingleton007 commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

Minor releases currently finish without creating their maintenance branch or advancing the public GitBook version. This adds a post-release job that creates or verifies the version branch, imports it into GitBook, publishes it, and confirms it became the default.

The release workflow can also publish documentation for an existing release without rerunning the release jobs. Maintainers provide the released version and can preview the operation with the default dry-run setting before publishing. The standalone path does not move stable or create a release.

The helper is safe to rerun. It reuses matching resources, refuses to move a conflicting maintenance branch, and keeps the previous documentation default until the new import succeeds. The release guide now covers the required GitBook configuration, standalone publishing, and manual recovery path.

Which issue(s) this PR fixes:

Fixes #6762

Checks

  • I've made sure the tests are passing.
  • My commits are signed off (git commit -s)
  • My PR title follows conventional commits format

Testing Strategy

  • Unit tests
  • Integration tests
  • Manual tests
  • Testing is not required for this change

Ran the 10 focused unit tests, Ruff, repository pre-commit hooks, YAML parsing, a credential-free v0.66.0 dry run, and git diff --check. Live GitBook validation still requires a maintainer-owned test site and scoped token.

Fixes feast-dev#6762

Signed-off-by: Larry Singleton <166439969+larrysingleton007@users.noreply.github.com>
@codecov-commenter

codecov-commenter commented Aug 19, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.08%. Comparing base (f0bc070) to head (dd06b84).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6763      +/-   ##
==========================================
- Coverage   47.09%   47.08%   -0.01%     
==========================================
  Files         419      419              
  Lines       51878    51878              
  Branches     7525     7525              
==========================================
- Hits        24430    24429       -1     
  Misses      25700    25700              
- Partials     1748     1749       +1     
Flag Coverage Δ
go-feature-server 30.58% <ø> (ø)
python-unit 48.39% <ø> (-0.01%) ⬇️
see 1 file with indirect coverage changes

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0bc070...dd06b84. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@larrysingleton007

larrysingleton007 commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

v0.66.0 shipped while this PR was open and reproduced the gap it addresses. The release and version branch succeeded, but the public docs root and /v0.66-branch/ currently return 404. The old /v0.64-branch/ and /master/ paths still return 200, so the current v0.66 GitBook default needs a manual repair.

I merged current upstream master into this branch and reran the 10 focused tests, Ruff, pre-commit, YAML parsing, and the dry run. They pass, and PR CI has restarted.

@franciscojavierarceo @ntkathole, could one of you review the future-release automation when you have a chance?

@ntkathole ntkathole left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

looks good

Signed-off-by: Larry Singleton <166439969+larrysingleton007@users.noreply.github.com>
@larrysingleton007

Copy link
Copy Markdown
Contributor Author

Added the standalone publish option discussed in Slack. Setting publish_docs_version skips the release jobs and runs only the documentation publisher, with dry-run enabled by default. It does not move stable or create a release. The v0.66.0 dry run and all 10 focused tests pass locally. @ntkathole, please take another look at the new workflow path when CI finishes.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate and verify versioned documentation publication after minor releases

3 participants