Skip to content

Conversation

ian-at-airbyte
Copy link
Contributor

What

This PR adds support for migration guides on enterprise connectors.

image

How

Updated filtering logic to support top-level id as well as nested link.id.

The existing filtering logic for enterprise connectors in the sidebar did not expect nested migration guides. The reason is because the getFilenamesInDir() function returns two different object structures.

Simple doc (no migration file): { type: "doc", id: "...", label: "..." } - has id at top level
Category with migration doc: { type: "category", label: "...", link: { id: "..." }, items: [...] } - has id nested in link.id

@darynaishchenko discovered during work on #67214 that all builds failed when a migration guide was added to an enterprise connector.

Review guide

  1. Review the logic in the sidebar filtering code.
  2. There is currently no migration guide in master to test this on, but I did test this fix with Darnya's PR and it built correctly with the updated code. You can simulate a migration guide by adding a dummy <connector_filename>-migrations.md doc for an enterprise connector. At build time it should nest appropriately under its parent object.

User Impact

Enterprise customers can have migration guides too.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Helpful Resources

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • /format-fix - Fixes most formatting issues.
  • /bump-version - Bumps connector versions.
    • You can specify a custom changelog by passing changelog. Example: /bump-version changelog="My cool update"
    • Leaving the changelog arg blank will auto-populate the changelog from the PR title.
  • /run-cat-tests - Runs legacy CAT tests (Connector Acceptance Tests)
  • /build-connector-images - Builds and publishes a pre-release docker image for the modified connector(s).
  • JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
    • /bump-bulk-cdk-version type=patch changelog='foo' - Bump the Bulk CDK's version. type can be major/minor/patch.
  • Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.

📝 Edit this welcome message.

Copy link
Contributor

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-g606oc0vx-airbyte-growth.vercel.app

Built with commit ec2f36a.
This pull request is being automatically deployed with vercel-action

Copy link
Contributor

@letiescanciano letiescanciano left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for fixing :)

@letiescanciano letiescanciano merged commit f3c5ac2 into master Oct 13, 2025
33 checks passed
@letiescanciano letiescanciano deleted the feat-support-enterprise-migration-guides branch October 13, 2025 16:11
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.

2 participants