Skip to content

Conversation

@aaronsteers
Copy link
Collaborator

What

Updates the Terraform provider documentation to prepare for the 1.0 release. This consolidates and supersedes the work from PRs #71791 and #71792.

Related: #65097, #71791, #71792

How

  • Added new "Terraform version 1.0 and later" section with step-by-step guide using generic airbyte_source and airbyte_destination resources
  • Uses definition_id and jsonencode configuration approach (the 1.0 pattern)
  • Added token_url parameter for Airbyte Cloud authentication
  • Reorganized existing strongly/weakly typed content under "Terraform versions before 1.0" section
  • Updated step headings with "(pre-1.0)" suffix to distinguish legacy approach
  • Added links to the Airbyte Terraform Modules page
  • Minor wording improvements throughout

Review guide

  1. docs/developers/terraform-documentation.md - Single file with all changes

Key areas to verify:

  • Lines 38-213: New 1.0+ tutorial section
  • Lines 214-492: Reorganized pre-1.0 content

User Impact

Users will have updated documentation explaining how to use the Terraform provider version 1.0+ with generic resources. The legacy approach is preserved for users on older provider versions.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Requested by: @aaronsteers (AJ Steers)
Devin session: https://app.devin.ai/sessions/cc271c1f7838462bacd6f29613b23df4

Human Review Checklist

  • Verify https://airbytehq.github.io/airbyte-terraform-modules/ is live or will be before merge
  • Verify the token_url endpoint (https://api.airbyte.com/v1/applications/token) is correct for Airbyte Cloud OAuth2
  • Confirm definition IDs are correct: Stripe (e094cb9a-26de-4645-8761-65c0c425d1de) and BigQuery (22f6c74f-5699-40ff-833c-4a879ea40133)
  • Confirm code samples work with the actual Terraform provider v1.0.0-rc2

- Add new 'Terraform version 1.0 and later' section with generic airbyte_source and airbyte_destination resources
- Use definition_id and jsonencode configuration approach for 1.0+
- Add token_url parameter for Airbyte Cloud authentication
- Reorganize existing content under 'Terraform versions before 1.0' section
- Link to Airbyte Terraform Modules page for code snippets
- Fix minor formatting issues

Consolidates work from PRs #71791 and #71792.

Co-Authored-By: AJ Steers <aj@airbyte.io>
@devin-ai-integration
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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 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.
  • ❇️ AI Testing and Review:
    • /ai-docs-review - Provides AI-powered documentation recommendations for PRs with connector changes.
    • /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.
    • /bump-progressive-rollout-version - Bumps connector version with an RC suffix (2.16.10-rc.1) for progressive rollouts (enableProgressiveRollout: true).
      • Example: /bump-progressive-rollout-version changelog="Add new feature for progressive rollout"
  • ☕️ 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 bump=patch changelog='foo' - Bump the Bulk CDK's version. bump 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.
  • ⚙️ 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
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Deploy preview for airbyte-docs ready!

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

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

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