Skip to content

Conversation

aaronsteers
Copy link
Contributor

fix: add --all-extras flag to pdoc-publish workflow

Summary

Fixed the consistently failing "Publish Docs" CI workflow by adding the missing --all-extras flag to the uv sync command. This makes the workflow configuration consistent with the working "Generate Docs" workflow and ensures all necessary dependencies are installed for documentation generation.

Root cause: The pdoc-publish.yml workflow was using uv sync while the working pdoc-preview.yml workflow uses uv sync --all-extras. Without the --all-extras flag, pdoc and other documentation dependencies weren't being installed, causing the documentation generation to fail.

Change: Single line modification in .github/workflows/pdoc-publish.yml line 43:

- run: uv sync
+ run: uv sync --all-extras

Review & Testing Checklist for Human

  • Verify CI passes: Check that the "Publish Docs" workflow now succeeds when this PR is merged to main
  • Test documentation deployment: Confirm that docs are successfully deployed to GitHub Pages and accessible
  • Validate generated content: Spot-check that the generated documentation looks correct and complete

Recommended test plan:

  1. Merge this PR and wait for the "Publish Docs" workflow to run on main branch
  2. Visit the GitHub Pages URL to verify docs are deployed correctly
  3. Check that the documentation content matches what's generated locally with poe docs-generate

Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    subgraph "CI Workflows"
        preview[".github/workflows/<br/>pdoc-preview.yml"]:::context
        publish[".github/workflows/<br/>pdoc-publish.yml"]:::major-edit
    end
    
    subgraph "Documentation"
        poe["poe_tasks.toml<br/>docs-generate task"]:::context
        pdoc["pdoc command"]:::context
        output["docs/generated/<br/>output"]:::context
    end
    
    preview -->|"uv sync --all-extras<br/>(working)"| poe
    publish -->|"uv sync --all-extras<br/>(fixed)"| poe
    poe --> pdoc
    pdoc --> output
    
    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit  
        L3[Context/No Edit]:::context
    end

classDef major-edit fill:#90EE90
classDef minor-edit fill:#87CEEB
classDef context fill:#FFFFFF
Loading

Notes

  • This fix was identified by comparing the failing pdoc-publish.yml with the working pdoc-preview.yml workflow
  • Documentation generation was tested locally and works correctly with the --all-extras flag
  • The change is minimal and follows existing patterns in the codebase
  • Recent CI runs show the "Publish Docs" workflow has been failing consistently, while "Generate Docs" works fine

Link to Devin run: https://app.devin.ai/sessions/a6da195870d44c0f9b651a780642c2ff
Requested by: @aaronsteers

This fixes the failing 'Publish Docs' CI step by ensuring all dependencies
are installed, matching the working 'Generate Docs' workflow configuration.

Co-Authored-By: AJ Steers <[email protected]>
Copy link
Contributor

Original prompt from AJ Steers
@Devin - Fix the build docs CI step for connector builder MCP. Lmk if you need help.

Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Testing This Branch via MCP

To test the changes in this specific branch with an MCP client like Claude Desktop, use the following configuration:

{
  "mcpServers": {
    "connector-builder-mcp-dev": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/airbytehq/connector-builder-mcp.git@devin/1755739941-fix-build-docs-ci", "connector-builder-mcp"]
    }
  }
}

Testing This Branch via CLI

You can test this version of the MCP Server using the following CLI snippet:

# Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/connector-builder-mcp.git@devin/1755739941-fix-build-docs-ci#egg=airbyte-connector-builder-mcp' --help

PR Slash Commands

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

  • /autofix - Fixes most formatting and linting issues
  • /poe <command> - Runs any poe command in the uv virtual environment

📝 Edit this welcome message.

Copy link

PyTest Results (Fast)

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ❌ ±0 

Results for commit 9dec0fd. ± Comparison against base commit c5b6665.

@aaronsteers aaronsteers merged commit 80a462b into main Aug 21, 2025
12 checks passed
@aaronsteers aaronsteers deleted the devin/1755739941-fix-build-docs-ci branch August 21, 2025 01:43
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