Conversation
…lease The docs' v1 API reference is generated from flytekit's docstrings and today only picks up a release through a daily poll, so it can lag by ~24h. This adds a notify-docs job that sends repository_dispatch(flytekit-release) to unionai/unionai-docs after deploy succeeds, mirroring the signal flyteorg/flyte-sdk already sends for the v2 line. Authenticates as the "Unionai Docsy Bot" GitHub App, which is installed on unionai-docs only; this repo holds its credentials as secrets and mints a token scoped to that one repo. Without the secrets the job warns and exits 0, so it can never fail a publish. Co-Authored-By: docsy <docsy@union.ai> Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
ppiegaze
marked this pull request as ready for review
September 20, 2026 07:42
ppiegaze
requested review from
cosmicbboy,
davidmirror-ops,
kumare3,
machichima,
pingsutw,
samhita-alla and
wild-endeavor
as code owners
September 20, 2026 07:42
kumare3
approved these changes
Sep 20, 2026
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.
What this does
Adds a
notify-docsjob topythonpublish.yml. Afterdeploysucceeds, it tells unionai/unionai-docs to regenerate the API reference generated from flytekit's docstrings.Today that regeneration happens on a daily poll, so a release can take up to ~24 hours to show up in the docs. flyteorg/flyte-sdk already sends the same kind of signal for the v2 docs line; this is the v1 counterpart.
How it works
repository_dispatchwithevent_type=flytekit-releaseandclient_payload={version: <x.y.z>}.Needs before it does anything
Two repo secrets,
DOCSY_BOT_APP_IDandDOCSY_BOT_PRIVATE_KEY, which someone with admin on this repo has to add (the same pair flyte-sdk has held since June). Until then the job is a no-op that logs a warning, so this PR is safe to merge either way. I can supply the values.The receiving side is unionai/unionai-docs#1616.
Unrelated observation, not changed here
The existing "Sleep until pypi is available" step in the
deployjob pollshttps://pypi.org/project/flytekitplugins-pod/${VERSION}/. That page returns 200 for any version string, including ones that were never published, so the loop always succeeds on its first attempt and the step is effectively just thesleep 300above it.https://pypi.org/pypi/flytekitplugins-pod/${VERSION}/jsonreturns 404 until the version is published. Left alone to keep this PR to one change; happy to fix it here or in a follow-up if you want.Verified
actionlint reports nothing on the new job (the pre-existing warnings about old
docker/*action versions in other jobs are untouched). Not run end to end; the first real test is the next release.— docsy · automated docs agent
🤖 Generated with Claude Code