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

fix(Dockerfile): use tini from package manager #2533

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Conversation

steebchen
Copy link
Contributor

@steebchen steebchen commented Oct 14, 2024

Description

Simplified Dockerfile by installing tini directly
via package manager. Removed manual download and
permission setting steps.

Related issue

Tests

  • Yes
  • No, because they aren't needed
  • No, because I need help

Added to documentation?

  • README.md
  • Dojo Book
  • No documentation needed

Checklist

  • I've formatted my code (scripts/prettier.sh, scripts/rust_fmt.sh, scripts/cairo_fmt.sh)
  • I've linted my code (scripts/clippy.sh, scripts/docs.sh)
  • I've commented my code
  • I've requested a review after addressing the comments

Summary by CodeRabbit

  • Chores
    • Updated the Dockerfile to streamline the installation process by including the tini package.
    • Changed the ENTRYPOINT to use an absolute path for improved reliability.
    • Added a command to verify the version of tini.

Copy link

coderabbitai bot commented Oct 14, 2024

Walkthrough

Ohayo, sensei! The Dockerfile has been updated to streamline the installation of the tini package. The installation command has been modified to include tini, and the ENTRYPOINT has been changed to use an absolute path instead of a relative one. A command to verify the tini version has been added, while the previous environment variable and download command for tini have been removed. The rest of the Dockerfile remains unchanged.

Changes

File Change Summary
Dockerfile - Added tini to the installation command.
- Changed ENTRYPOINT to absolute path.
- Added command to verify tini version.
- Removed TINI_VERSION and associated ADD command.

Possibly related PRs

Suggested reviewers

  • glihm

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1a0d2a0 and 2a8e44d.

📒 Files selected for processing (1)
  • Dockerfile (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Dockerfile

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>, please review it.
    • 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 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.

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.

Copy link

@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

🧹 Outside diff range and nitpick comments (2)
Dockerfile (2)

19-19: Ohayo again, sensei! Good move on using the absolute path.

The update to use the absolute path /usr/bin/tini in the ENTRYPOINT is a solid improvement. It reduces ambiguity and aligns with the standard location for binaries installed via the package manager.

As a tiny suggestion, consider adding a comment explaining why tini is used as the entrypoint. It could help future maintainers understand the purpose of this setup.


21-21: Ohayo once more, sensei! Excellent addition of the version check.

Adding the tini version check is a smart move. It provides a quick way to verify the correct installation and version of tini, which can be super helpful for debugging.

To make this even more useful, consider capturing the output of the version check. Here's a suggestion:

-RUN /usr/bin/tini --version
+RUN echo "Tini version: $(/usr/bin/tini --version)"

This way, the version information will be clearly visible in the build logs, making it easier to track which version of tini is included in each Docker image build.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7035d54 and 1a0d2a0.

📒 Files selected for processing (1)
  • Dockerfile (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
Dockerfile (2)

3-3: Ohayo, sensei! Nice simplification of the tini installation.

The addition of tini to the package installation list streamlines the Dockerfile and aligns perfectly with the PR objective. This change eliminates the need for manual download and permission setting steps. Well done!


Line range hint 3-21: Ohayo, sensei! Overall, these changes are a dojo-level improvement!

The modifications to this Dockerfile achieve the goal of simplifying tini installation and usage. By leveraging the package manager, you've reduced potential points of failure and improved maintainability. The consistent use of absolute paths and the addition of a version check enhance the robustness of the setup.

These changes align well with Docker best practices and should make the image more reliable and easier to maintain. Great work on streamlining the process!

Simplified Dockerfile by installing tini directly
via package manager. Removed manual download and
permission setting steps.
Copy link

codecov bot commented Oct 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.30%. Comparing base (7035d54) to head (2a8e44d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2533   +/-   ##
=======================================
  Coverage   69.30%   69.30%           
=======================================
  Files         388      388           
  Lines       50033    50033           
=======================================
  Hits        34673    34673           
  Misses      15360    15360           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@kariy kariy left a comment

Choose a reason for hiding this comment

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

LGTM

@steebchen steebchen merged commit 86b3a85 into main Oct 14, 2024
16 checks passed
@steebchen steebchen deleted the fix-docker-tini branch October 14, 2024 15:27
ENV TINI_VERSION v0.19.0
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
RUN chmod +x /tini
COPY --from=builder /usr/bin/tini /tini
Copy link
Contributor Author

@steebchen steebchen Oct 14, 2024

Choose a reason for hiding this comment

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

copied to /tini instead of /usr/bin/tini for backwards-compatibility

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.

2 participants