Skip to content

docs(source-github): fix changelog date, add Projects Classic deprecation note, improve incremental sync docs#76075

Closed
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1775234348-docs-source-github
Closed

docs(source-github): fix changelog date, add Projects Classic deprecation note, improve incremental sync docs#76075
devin-ai-integration[bot] wants to merge 1 commit into
masterfrom
devin/1775234348-docs-source-github

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

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

Documentation Confidence Assessment

Overall Confidence: 3/5

Dimension Score Rationale
Code Comprehension 2/5 Python CDK connector with 1874-line streams.py, multiple custom stream classes, and mixed REST/GraphQL patterns.
API Documentation Quality 5/5 GitHub provides comprehensive official docs; metadata.yaml lists 8 external doc URLs covering API reference, auth, rate limits, OpenAPI spec, and status page.
Change Scope & Risk 5/5 Small corrections: changelog date fix, deprecation footnotes, and Notes section rewrite. 13 lines added, 32 removed.
Existing Doc Maturity 5/5 Mature 434-line doc with full coverage of prerequisites, setup, streams, limitations, and changelog.
Connector Sensitivity 2/5 Certified connector with ql=400, sl=300 — high-usage connector warranting caution.
Triggering Context 5/5 Triggered from a small merged PR (internal error class replacement, version bump to 2.1.16).

What I Verified vs. What I Inferred

  • Verified from code: Stream class hierarchy (SemiIncrementalMixin, IncrementalMixin) confirms the three incremental categories. workflow_runs and workflow_jobs both use SemiIncrementalMixin. Pure incremental streams (comments, commits, issues, review_comments) use IncrementalMixin.
  • Verified from API docs: Projects (classic) sunset date of August 23, 2024 for github.com and June 3, 2025 for GHES, sourced from GitHub's official changelog.
  • Verified from git log: PR #76038 was merged on 2026-04-03, not 2026-04-02.
  • Inferred: That the "Start Date doesn't apply" stream list can be safely removed from the Notes section because it already appears in the setup guide (step 7, lines 70–72). Reviewer should confirm this deduplication is acceptable.

Areas of Concern

  • The escaped \* footnote markers on the Projects (Classic) streams — verify these render as literal asterisks in Docusaurus rather than being interpreted as markdown emphasis.
  • The removed "Start Date doesn't apply" stream list was the only place this information appeared near the Supported Streams section. Readers may miss it if they don't read the setup guide.

What

Documentation improvements for the source-github connector, triggered by review of #76038 (v2.1.16).

Three issues identified via documentation-review-standards review:

  1. Incorrect changelog date for v2.1.16 — set to the date /bump-version ran, not when the PR merged.
  2. Missing deprecation context for Projects (Classic) streams — GitHub sunset Projects (classic) on August 23, 2024, but the docs listed these streams without any note.
  3. Confusing incremental sync notes — the old numbered-list format was hard to scan and mixed behavioral categories with unrelated start_date guidance.

How

  • Fixed the v2.1.16 changelog date from 2026-04-02 to 2026-04-03 to match the actual PR merge date.
  • Added \* markers to the three Projects (Classic) stream entries with a footnote explaining the upstream deprecation and GHES timeline.
  • Rewrote the "Notes" section as "Notes on incremental sync behavior" using a concise bulleted format that groups streams into three clear categories: pure incremental, workflow, and semi-incremental.
  • Moved the start_date warning into a :::note admonition for better visibility.

Review guide

  1. docs/integrations/sources/github.md — the only file changed.

Items to verify:

  • Does the escaped \* footnote marker render correctly in Docusaurus? (It should produce a literal asterisk.)
  • The old Notes section included a list of streams where Start Date doesn't apply (assignees, branches, collaborators, etc.). This list was removed here because it already appears in the setup guide (step 7, lines 70–72). Confirm this is acceptable or if the duplication should be preserved.
  • The Projects (Classic) sunset dates are sourced from GitHub's official changelog.

User Impact

Readers of the source-github documentation get:

  • A correct changelog date for v2.1.16.
  • Awareness that Projects (Classic) streams depend on a deprecated upstream feature.
  • Clearer explanation of how different incremental streams behave, which helps users anticipate API rate limit impact.

No negative side effects expected.

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/603e417eae8c4448b7a1cfcc7842d04f

…tion note, improve incremental sync docs

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 3, 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 3, 2026
@@ -141,38 +141,19 @@ This connector outputs the following incremental streams:
### Entity-Relationship Diagram (ERD)
<EntityRelationshipDiagram></EntityRelationshipDiagram>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
<EntityRelationshipDiagram></EntityRelationshipDiagram>
<EntityRelationshipDiagram></EntityRelationshipDiagram>

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

Deploy preview for airbyte-docs ready!

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

Built with commit 27ca97e.
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