Skip to content

chore(source-orb): fix stale external documentation URLs in metadata - #83327

Draft
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1785737449-source-orb-external-docs-urls
Draft

chore(source-orb): fix stale external documentation URLs in metadata#83327
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1785737449-source-orb-external-docs-urls

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

What

Found during an API deprecation audit of the Orb vendor API (requested by Danylo Jablonski, gl_danylo.jablonski@airbyte.io).

Two externalDocumentationUrls entries in source-orb's metadata return 404:

  • https://docs.withorb.com/reference/api-reference
  • https://docs.withorb.com/reference/authentication

There was also no link to Orb's changelog, which is the only place Orb announces API changes (their docs site has no changelog or deprecations page).

Resolves https://github.com/airbytehq/oncall/issues/13218

How

Repointed the two dead URLs at their live equivalents and added the changelog as api_release_history. Verified HTTP status of every URL in the block:

URL Status
https://docs.withorb.com/api-reference 200
https://docs.withorb.com/essentials/authentication 200
https://changelog.withorb.com 200
https://status.withorb.com/ 200

Review guide

  1. airbyte-integrations/connectors/source-orb/metadata.yamlexternalDocumentationUrls only. No version bump, matching the precedent in b02a7b2 (chore(source-github): update stale external documentation URL in metadata).

User Impact

None. Metadata-only change; no connector behavior or spec change.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Link to Devin session: https://app.devin.ai/sessions/1b432c957b5347d3adfeef11e83505a7

Co-Authored-By: Danylo Jablonski <daniel.i.jablonski@globallogic.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 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, CI, and merge conflict monitoring

@octavia-bot
octavia-bot Bot marked this pull request as draft August 3, 2026 06:12
@octavia-bot

octavia-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Note

📝 PR Converted to Draft

More info...

Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy.

As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page.

To skip draft status in future PRs, please include [ready] in your PR title or add the skip-draft-status label when creating your PR.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

PR Slash Commands

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

  • 🛠️ Quick Fixes
    • /format-fix - Fixes most formatting issues.
    • /bump-version - Bumps connector versions, scraping changelog description from the PR title.
      • Bump types: patch (default), minor, major, major_rc, rc, promote.
      • The rc type is a smart default: applies minor_rc if stable, or bumps the RC number if already RC.
      • The promote type strips the RC suffix to finalize a release.
      • Example: /bump-version type=rc or /bump-version type=minor
    • /bump-progressive-rollout-version - Alias for /bump-version type=rc. Bumps with an RC suffix and enables progressive rollout.
  • ❇️ AI Testing and Review (internal link: AI-SDLC Docs):
    • /ai-prove-fix - Runs prerelease readiness checks, including testing against customer connections.
    • /ai-canary-prerelease - Rolls out prerelease to 5-10 connections for canary testing.
    • /ai-review - AI-powered PR review for connector safety and quality gates.
  • 📝 AI Documentation:
    • /ai-docs-review - AI-powered documentation review for PRs with connector changes.
    • /ai-create-docs-pr - Creates a documentation PR for connector changes, stacked on the current PR.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /enable-autopilot-rollouts - Enables autopilot progressive rollouts for the modified connector(s) in the PR, remediating "autopilot rollouts not enabled for {connector-name}" auto-merge blockers. Sets defaultRolloutMode: autopilot and enableProgressiveRollout: true, preserving any existing autopilotConfig.
      • Optional args: connector=<CONNECTOR_NAME> (defaults to the modified connectors in the PR), strategy=fast|slow|default (defaults to fast).
      • Example: /enable-autopilot-rollouts or /enable-autopilot-rollouts connector=source-faker strategy=slow
  • ☕️ 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
  • 🐍 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.
  • ⚙️ Admin commands:
    • /force-merge reason="<REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.
      Example: /force-merge reason="CI is flaky, tests pass locally"
📚 Show Repo Guidance

Helpful Resources

📝 Edit this welcome message.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Note

Autopilot progressive rollouts are not enabled for the following modified connector(s):

  • source-orb

This is a courtesy heads-up only — it does not block merge or fail any check.
To enable automatic progressive rollouts for the connector(s) above, comment
/enable-autopilot-rollouts on this PR. This sets defaultRolloutMode: autopilot
and enableProgressiveRollout: true in each connector's metadata.yaml,
preserving any existing autopilotConfig.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

source-orb Connector Test Results

1 tests   0 ✅  0s ⏱️
1 suites  0 💤
1 files    0 ❌  1 🔥

For more details on these errors, see this check.

Results for commit 8a9e45b.

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

CI note: source-orb Pre-Release Checks fails on Connector Version Increment Check (dockerImageTag not incremented), and Test source-orb Connector fails during collection with ValueError: Acceptance tests config not found in acceptance-test-config.yml.

Both are expected for a metadata-URL-only change and were deliberately not worked around:

  • No version bump: this PR changes only externalDocumentationUrls, which has no effect on the published connector image. The directly comparable precedent, chore(source-github): update stale external documentation URL in metadata #82265 (chore(source-github): update stale external documentation URL in metadata), was merged on 2026-07-30 with the same four checks red (Connector CI Checks Summary, Lint, Test, Build and Verify Artifacts, Pre-Release Checks).
  • acceptance-test-config.yml is byte-for-byte unchanged from master in this branch, so the acceptance-test collection error is not caused by this diff.

Happy to bump dockerImageTag and add a changelog entry if maintainers prefer a green build over the metadata-only precedent.


Devin session

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant