fix: ensure SDM image maintains airbyte-ci compatibility

[ChristoGrab]

What

When we implemented the new publish flow for SDM in Dockerhub, the built image diverged from the existing structure of source-declarative-manifest images built via the base_images package in our monorepo. This had the unintentional side effect of breaking existing airbyte-ci commands for manifest-only connectors, which have set expectations about the image's entrypoint and directory structure.

Discrepancy

How

This PR modifies the built Dockerfile image to resemble the structure of the original SDM image by adding a main.py file at the project's root level and renaming _run.py to run.py within the built image.

Testing Steps Used

1. Published SDM version 6.7.0rc5 using the updated Dockerfile in this branch
2. Pulled the images for SDM versions 6.5.2(stable monorepo release) and 6.7.0rc5 from Dockerhub
3. Inspected the images using docker run --rm -it --entrypoint /bin/bash source-declarative-manifest:<version> for comparison
4. Set the base image for source-pokeapi locally to 6.7.0rc5
5. Ran airbyte-ci connectors --name=source-pokeapi build to verify the image builds locally
6. Ran all of the connector interfaces against the local image to verify the connector works as expected.
7. Created a cusom PokeAPI source in Airbyte Cloud and pinned the version of SDM to 6.7.0rc5 to verify the connector syncs on the platform

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in the Dockerfile involve modifications to the build process and entrypoint configuration. The structure of the integration code has been altered, with the removal of the COPY airbyte_cdk command. A new directory structure is created, including a source_declarative_manifest directory, along with a new main.py file that executes a function from this directory. The entrypoint and environment variable configurations have been updated to reflect these changes, streamlining the overall build process.

Changes

File	Change Summary
Dockerfile	- Removed COPY airbyte_cdk command. - Added commands to create source_declarative_manifest and main.py. - Created __init__.py in source_declarative_manifest. - Copied two files from airbyte_cdk into the new directory. - Added cleanup step to remove unnecessary files post-installation. - Updated entrypoint to main.py and modified AIRBYTE_ENTRYPOINT environment variable.

Possibly related PRs

• fix: update source-declarative-manifest entrypoint #84: This PR modifies the entrypoint configuration in the Dockerfile, aligning with the changes in the main PR that also updates the entrypoint to execute main.py.

Suggested labels

bug, ci

Suggested reviewers

• aaronsteers

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

Dockerfile (1)

16-28: Overall architecture looks solid 🎯

The approach of recreating the expected structure while maintaining a clean container image is clever. It solves the airbyte-ci compatibility issue while keeping things maintainable.

One architectural consideration: have you thought about maintaining these files in the repo instead of copying from the installed package? This could make updates more explicit and trackable. WDYT?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a8b1b2b and 9c78c09.

📒 Files selected for processing (1)

• Dockerfile (1 hunks)

🔇 Additional comments (2)

Dockerfile (2)

23-24: LGTM! Good practice for image size optimization 👍

The cleanup of build artifacts helps keep the image slim. Nice work!

---

27-28: Verify entrypoint compatibility with airbyte-ci

The entrypoint changes look aligned with the PR objectives. Just to be thorough, should we verify:

1. That the path /airbyte/integration_code/main.py is consistent across the codebase?
2. That this matches exactly what airbyte-ci expects?

Let's check for path consistency and usage:

[aaronsteers]

Approved 👍

One comment to request we log an issue for follow-on, and I think Code Rabbit should take care of logging that.