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

Development: Fix Dockerfile syntax - unify AS casing and use ENV key=value format #10459

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

egekocabas
Copy link
Member

@egekocabas egekocabas commented Mar 10, 2025

Checklist

General

Motivation and Context

This PR ensures Dockerfile best practices by:

  • Standardizing the casing of AS in FROM ... AS statements for consistency
  • Replacing the deprecated legacy ENV key value format with ENV key=value

References:

Description

  • Updated all FROM ... AS statements to use uppercase AS.
  • Refactored ENV instructions to use the key=value format instead of the legacy key value format.

Summary by CodeRabbit

  • Style
    • Updated the container build instructions for consistent alias naming.
    • Reformatted environment variable declarations for a cleaner, uniform presentation.

@egekocabas egekocabas marked this pull request as ready for review March 10, 2025 22:37
@egekocabas egekocabas requested a review from a team as a code owner March 10, 2025 22:37
Copy link

coderabbitai bot commented Mar 10, 2025

Walkthrough

The pull request refactors the Dockerfile's syntax for improved consistency. It updates the FROM statements to use uppercase "AS" for naming build stages and reformats environment variable declarations to use an equals sign (e.g., ENV LC_ALL=en_US.UTF-8) instead of a space. These changes are purely stylistic and do not affect functionality.

Changes

File(s) Change Summary
docker/artemis/Dockerfile Refactored build stage aliasing in FROM statements to uppercase "AS" and standardized ENV formatting.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06f2da4 and 3e44eb8.

📒 Files selected for processing (1)
  • docker/artemis/Dockerfile (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (5)
docker/artemis/Dockerfile (5)

25-25: Consistent 'AS' usage for the builder stage.
The change updates the stage naming to use uppercase AS (i.e., FROM --platform=$BUILDPLATFORM docker.io/library/eclipse-temurin:21-jdk AS builder), which aligns with Docker best practices for consistency and readability.


69-69: Consistent 'AS' usage for the external builder stage.
The updated statement (FROM docker.io/library/alpine:3 AS external_builder) now standardizes the casing of AS, promoting uniformity across all build stages.


81-81: Consistent 'AS' usage for the war file stage.
The change to FROM ${WAR_FILE_STAGE} AS war_file maintains the uniform use of uppercase AS across all stage specifications, ensuring clear and standardized stage naming.


86-86: Consistent 'AS' usage for the runtime stage.
The runtime stage declaration (FROM docker.io/library/eclipse-temurin:21-jdk AS runtime) now adheres to the uppercase AS convention, which improves clarity and consistency in the Dockerfile.


106-108: Updated ENV syntax to key=value format.
The environment variable declarations have been refactored from the legacy space-separated format to the recommended key=value format (e.g., ENV LC_ALL=en_US.UTF-8), enhancing readability and adherence to modern Dockerfile practices.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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 or @coderabbitai title 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
Contributor

@StefanNemeth StefanNemeth left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

3 participants