Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ingest): add python deps for apk #11188

Merged
merged 3 commits into from
Sep 3, 2024
Merged

feat(ingest): add python deps for apk #11188

merged 3 commits into from
Sep 3, 2024

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Aug 15, 2024

Will help us support Alpine images in the future.

Also fixes the quotes around the uv install to avoid creating dummy files.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • New Features

    • Enhanced script support for package installation on Alpine Linux, improving compatibility across different systems.
  • Bug Fixes

    • Corrected the syntax for specifying the uv package version in installation commands to ensure proper interpretation by the shell.

Will help us support Alpine images in the future.
@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata devops PR or Issue related to DataHub backend & deployment smoke_test Contains changes related to smoke tests labels Aug 15, 2024
Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve modifications across several scripts and a Dockerfile, focusing primarily on the installation commands for Python packages and system dependencies. The updates include the use of quotes for version specifications and the addition of Alpine Linux compatibility in a dependency installation script, enhancing flexibility without altering the overall functionality.

Changes

File Change Summary
docker/datahub-ingestion-base/Dockerfile Modified the syntax for specifying the uv package version by adding quotes around uv>=0.1.10.
metadata-ingestion/scripts/install_deps.sh Added a conditional check for the apk command to support package installation on Alpine Linux while preserving previous commands for other environments.
smoke-test/smoke.sh Changed the pip installation command to include quotes around the uv package version specification for proper parsing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Dockerfile
    participant InstallScript
    participant SmokeTest

    User->>Dockerfile: Initiate build
    Dockerfile->>InstallScript: Install dependencies
    InstallScript->>Dockerfile: Return installed dependencies
    Dockerfile->>SmokeTest: Setup environment
    SmokeTest->>Dockerfile: Return environment setup confirmation
Loading

🐰 In the code and scripts we play,
With quotes and checks, we pave the way.
For Alpine's charm and Python's grace,
Our dependencies find their rightful place!
Hopping along, with joy we sing,
A smooth install is a wonderful thing! 🐇✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

@@ -19,7 +19,13 @@ else
xz-devel \
libxml2-devel \
libxslt-devel \
krb5-devel
krb5-devel
elif command -v apk; then
Copy link
Contributor

Choose a reason for hiding this comment

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

This works but I think it would be better to check for distribution vs apk/yum command as there are other distros which has yum but the package names are different. -> https://www.cyberciti.biz/faq/find-linux-distribution-name-version-number/

This is more an fyi

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think for apk it's fine since it's the alpine package keeper. Didn't know that yum could have issues - it hasn't been an issue thus far so I think I'll leave it as-is, but good to be aware of that

Copy link
Contributor

coderabbitai bot commented Aug 23, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@hsheth2
Copy link
Collaborator Author

hsheth2 commented Aug 23, 2024

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Aug 23, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d81161e and 272823a.

Files selected for processing (3)
  • docker/datahub-ingestion-base/Dockerfile (1 hunks)
  • metadata-ingestion/scripts/install_deps.sh (1 hunks)
  • smoke-test/smoke.sh (1 hunks)
Files skipped from review due to trivial changes (2)
  • docker/datahub-ingestion-base/Dockerfile
  • smoke-test/smoke.sh
Additional comments not posted (1)
metadata-ingestion/scripts/install_deps.sh (1)

23-28: Ensure compatibility with other package managers.

The addition of the apk block enhances support for Alpine Linux. However, consider the existing comment about checking for distribution names instead of commands to improve compatibility with other distros that might use yum with different package names.

Ensure that the package names are correct for Alpine Linux and consider potential differences in other distributions.

@hsheth2 hsheth2 added the merge-pending-ci A PR that has passed review and should be merged once CI is green. label Aug 26, 2024
@hsheth2 hsheth2 merged commit 96b075d into master Sep 3, 2024
66 of 67 checks passed
@hsheth2 hsheth2 deleted the uv-dep branch September 3, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment ingestion PR or Issue related to the ingestion of metadata merge-pending-ci A PR that has passed review and should be merged once CI is green. smoke_test Contains changes related to smoke tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants