Skip to content

docs(source-github): fix changelog dates and improve documentation clarity#76128

Closed
devin-ai-integration[bot] wants to merge 2 commits into
masterfrom
devin/1775592256-source-github-docs-update
Closed

docs(source-github): fix changelog dates and improve documentation clarity#76128
devin-ai-integration[bot] wants to merge 2 commits into
masterfrom
devin/1775592256-source-github-docs-update

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented Apr 7, 2026

Documentation Confidence Assessment

Overall Confidence: 3/5

Dimension Score Rationale
Code Comprehension 2/5 Python CDK with complex multi-file logic (1874 lines in streams.py), custom GraphQL, backoff strategies, and error handlers.
API Documentation Quality 5/5 GitHub has comprehensive official API docs; 8 external doc URLs in metadata covering auth, rate limits, OpenAPI spec, and more.
Change Scope & Risk 5/5 Changelog date corrections, one missing stream addition, and prose cleanup — 18 lines added, 23 removed.
Existing Doc Maturity 5/5 Mature doc (435 lines) with comprehensive coverage of prerequisites, setup, streams, troubleshooting, and changelog.
Connector Sensitivity 2/5 Certified connector with high usage (ql=400, sl=300).
Triggering Context 5/5 Triggered from a small merged bug-fix PR (#76080).

What I Verified vs. What I Inferred

Areas of Concern

  • Reviewer should verify that workflow_jobs correctly belongs in the Start Date list — it was the only incremental stream omitted from that list.

What

Updates the source-github connector documentation triggered by commit 828cdd9 (#76080). Fixes incorrect changelog dates, adds a missing stream to the Start Date list, and improves readability of the Notes and Rate Limiting sections.

How

  1. Changelog date corrections — v2.1.17 date corrected from 2026-04-03 to 2026-04-07 (actual merge date of PR fix(source-github): fix remaining NameError references to removed MessageRepresentationAirbyteTracedErrors #76080); v2.1.16 date corrected from 2026-04-02 to 2026-04-03 (actual merge date of PR fix(source-github): replace deprecated MessageRepresentationAirbyteTracedErrors with AirbyteTracedException #76038). Dates were set by /bump-version at PR creation time, not at merge time.

  2. Missing stream in Start Date list — Added workflow_jobs to the list of streams that respect the Start Date configuration. This stream is incremental and was already documented in the incremental streams section but was omitted from the Start Date applicability list.

  3. Notes section cleanup — Removed unnecessary backslash escapes around parentheses, improved grammar and sentence structure, replaced bare [docs] link text with descriptive link text, and condensed note checkin catalogs #3 for clarity.

  4. Rate limiting section — Fixed misplaced :::tip closing tag (was indented inside the ordered list, causing a rendering issue), tightened wording.

  5. Minor style fixes — Active voice, consistent list capitalization, removed first-person "our", added missing trailing period.

Review guide

  1. docs/integrations/sources/github.md — Single file changed.

Human review checklist

  • Verify workflow_jobs correctly supports Start Date filtering (it inherits from SemiIncrementalMixin via WorkflowRuns)
  • Confirm the corrected changelog dates match the actual PR merge dates
  • Verify no meaning was lost in the Notes section rewrite (especially note checkin catalogs #3, which was condensed)

User Impact

More accurate changelog dates and a corrected Start Date stream list. No functional impact — documentation only.

Can this PR be safely reverted and rolled back?

  • YES 💚

Note: I am an AI assistant (Devin) and have proposed these documentation updates based on a review of the connector source code and third-party API documentation. Reviewers may merge, modify, or close this PR as they see fit.

Link to Devin session: https://app.devin.ai/sessions/3ddcb87099f44a2198d7708ebe7fce27

…arity

Co-Authored-By: bot_apk <apk@cognition.ai>
@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 and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2026

👋 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.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
  • ☕️ 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.

@devin-ai-integration devin-ai-integration Bot added area/documentation Improvements or additions to documentation team/documentation labels Apr 7, 2026
…032)

Co-Authored-By: bot_apk <apk@cognition.ai>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 7, 2026

Deploy preview for airbyte-docs ready!

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

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

@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

Closing as superseded by #76350, a more recent autodoc run for source-github that covers the latest set of changes. Please review #76350 instead.

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

Labels

area/documentation Improvements or additions to documentation team/documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants