Skip to content

ci(release): point the docs branch at every published release - #583

Merged
jdchawla29 merged 1 commit into
mainfrom
docs-release-autotrack
Aug 14, 2026
Merged

ci(release): point the docs branch at every published release#583
jdchawla29 merged 1 commit into
mainfrom
docs-release-autotrack

Conversation

@jdchawla29

@jdchawla29 jdchawla29 commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

docs.hud.ai builds its SDK tab from the docs branch: normally the latest release, optionally plus docs-only commits shipped between releases. The release workflow force-pushes the released commit to docs after publishing to PyPI, so the pointer needs no manual maintenance; docs-only commits on the branch are contained in the released main by construction.


Note

Low Risk
CI-only change to a release workflow; the force-push to docs is intentional and scoped to the release commit SHA.

Overview
After each published release, the Release workflow now updates the docs branch so docs.hud.ai’s SDK tab builds from the same commit that was shipped to PyPI.

The deploy job gains contents: write permissions and a new step Point docs at this release that runs git push --force origin "${GITHUB_SHA}:refs/heads/docs" after uv publish. PyPI publishing is unchanged.

Reviewed by Cursor Bugbot for commit 616f90b. Bugbot is set up for automated code reviews on this repo. Configure here.

@jdchawla29
jdchawla29 force-pushed the docs-release-autotrack branch from 35b55c8 to 0ff5b38 Compare August 14, 2026 19:46
@jdchawla29
jdchawla29 force-pushed the docs-release-autotrack branch from 0ff5b38 to 616f90b Compare August 14, 2026 19:48
@jdchawla29 jdchawla29 changed the title ci(release): point docs-release at every published release ci(release): point the docs branch at every published release Aug 14, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 35b55c8d2e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/release.yml Outdated
Comment thread .github/workflows/release.yml Outdated
Comment thread .github/workflows/release.yml Outdated
@jdchawla29
jdchawla29 merged commit 2400079 into main Aug 14, 2026
8 checks passed
@jdchawla29
jdchawla29 deleted the docs-release-autotrack branch August 14, 2026 19:54
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.

1 participant