Skip to content

ci(docs): publish release-candidate/v1 docs under /rc/ - #1429

Open
Aaron ("AJ") Steers (aaronsteers) wants to merge 1 commit into
mainfrom
devin/1793142384-rc-docs-publish
Open

Aaron ("AJ") Steers (aaronsteers) wants to merge 1 commit into
mainfrom
devin/1793142384-rc-docs-publish

Conversation

@aaronsteers

Copy link
Copy Markdown
Member

Summary

Publishes the release-candidate/v1 docs alongside the main docs, at https://airbytehq.github.io/PyAirbyte/rc/. This makes MCP tools that only exist on the RC branch browsable before the RC merges, such as the insiders-only Connector Builder tools (#1407). Today airbyte/mcp/connector_builder.html returns 404 on the live site because Publish Docs only builds main.

Changes

  • pydoc_publish.yml checks out main (at the triggering SHA) and release-candidate/v1 side by side, builds both with poe docs-generate, and uploads one Pages artifact: main at the root, RC under /rc/.
  • The RC build steps use continue-on-error, so a broken RC docs build can't block the main docs from publishing. The /rc/ copy step runs only when the RC build succeeds.
  • The workflow now also triggers on pushes to release-candidate/v1. The github-pages environment only allows deployments from main, so on an RC push the new dispatch_from_rc job runs gh workflow run pydoc_publish.yml --ref main instead of deploying. GITHUB_TOKEN is allowed to fire workflow_dispatch, and that job gets actions: write.
  • publish_docs is now gated to refs/heads/main and has a job name:.

Notes

  • The RC branch picks up this workflow change through the usual main → RC sync. RC pushes start dispatching only after that sync lands.
  • The /rc/ pages have no "pre-release" banner and no link from the stable docs. That could be a follow-up if wanted.

Test plan

  • actionlint .github/workflows/pydoc_publish.yml passes.
  • Ran uv run poe docs-generate locally on release-candidate/v1. The output includes airbyte/mcp/connector_builder.html with all 10 builder tools, each labelled "experimental, insiders only". The generated HTML has no root-absolute href="/..." links, so it works when served under /rc/.
  • Not yet run in CI: the Pages deploy itself. After merge, check https://airbytehq.github.io/PyAirbyte/rc/airbyte/mcp/connector_builder.html.

Link to Devin session: https://app.devin.ai/sessions/4a494a658fcc4210892ae2c59065bc99
Open in Devin Desktop: https://app.devin.ai/desktop/session/4a494a658fcc4210892ae2c59065bc99?variant=devin
Requested by: Aaron ("AJ") Steers (@aaronsteers)

@devin-ai-integration

Copy link
Copy Markdown
Contributor

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

Testing This PyAirbyte Version

You can test this version of PyAirbyte using the following:

# Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1793142384-rc-docs-publish' pyairbyte --help

# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1793142384-rc-docs-publish'

PR Slash Commands

Airbyte Maintainers can execute the following slash commands on your PR:

  • /fix-pr - Fixes most formatting and linting issues
  • /uv-lock - Updates uv.lock file
  • /test-pr - Runs tests with the updated PyAirbyte
  • /prerelease - Builds and publishes a prerelease version to PyPI
  • /evals - Runs the Cloud MCP evals that use the MCP tools this PR changed (/evals full=true runs the full suite)
📚 Show Repo Guidance

Helpful Resources

Community Support

Questions? Join the #pyairbyte channel in our Slack workspace.

📝 Edit this welcome message.

@github-code-quality

github-code-quality Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Code coverage overview

Languages: Python

Python / code-coverage/pytest-no-creds

main d9f652f devin/1793142384-rc-... 4c903ac +/-
65% 77% +12%
View coverage of the 10 most impacted files.
File main d9f652f devin/1793142384-rc-... 4c903ac +/-
airbyte/mcp/cloud.py 52% 71% +19%
airbyte/_util/api_util.py 36% 56% +20%
airbyte/mcp/_otel.py 0% 89% +89%
airbyte/mcp/int..._registry_ui.py 0% 92% +92%
airbyte/cloud/models.py 0% 95% +95%
airbyte/mcp/_sso_auth.py 0% 96% +96%
airbyte/mcp/int...nc_status_ui.py 0% 97% +97%
airbyte/_direct...nnector_docs.py 0% 97% +97%
airbyte/mcp/agents.py 0% 98% +98%
airbyte/_direct...ctors/models.py 0% 99% +99%

Python / code-coverage/pytest

main d9f652f devin/1793142384-rc-... 4c903ac +/-
71% 80% +9%
View coverage of the 10 most impacted files.
File main d9f652f devin/1793142384-rc-... 4c903ac +/-
airbyte/mcp/cloud.py 52% 71% +19%
airbyte/mcp/_otel.py 0% 89% +89%
airbyte/mcp/int..._registry_ui.py 0% 92% +92%
airbyte/_direct...ors/api_util.py 0% 92% +92%
airbyte/mcp/_sso_auth.py 0% 96% +96%
airbyte/cloud/models.py 0% 96% +96%
airbyte/mcp/int...nc_status_ui.py 0% 97% +97%
airbyte/_direct...nnector_docs.py 0% 97% +97%
airbyte/mcp/agents.py 0% 98% +98%
airbyte/_direct...ctors/models.py 0% 99% +99%

Python / code-coverage/pytest-unit

main devin/1793142384-rc-... 4c903ac +/-
— 73% —

Line coverage data for the main branch is not yet available.

View coverage of the 10 most covered files.
File main devin/1793142384-rc-... 4c903ac +/-
airbyte/mcp/agents.py — 98% —
airbyte/mcp/_sso_auth.py — 96% —
airbyte/cloud/models.py — 95% —
airbyte/cloud/client.py — 91% —
airbyte/mcp/_otel.py — 89% —
airbyte/exceptions.py — 84% —
airbyte/progress.py — 80% —
airbyte/mcp/cloud.py — 71% —
airbyte/shared/...ql_processor.py — 68% —
airbyte/_util/api_util.py — 56% —

ℹ️ Calculations represent line coverage. Results may change as calculations are updated.


Updated October 27, 2026 23:19 UTC

@aaronsteers
Aaron ("AJ") Steers (aaronsteers) marked this pull request as ready for review October 30, 2026 17:39
Copilot AI balanced review requested due to automatic review settings October 30, 2026 17:39

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.

1 participant