Fix & improve docker multi platform builds #176
Conversation
WalkthroughThe recent updates streamline the Docker build process by enhancing platform specification and caching mechanisms. The Changes
Tip New Features and ImprovementsReview SettingsIntroduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments. AST-based InstructionsCodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation. Community-driven AST-based RulesWe are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information. New Static Analysis ToolsWe are continually expanding our support for static analysis tools. We have added support for Tone SettingsUsers can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
Revamped Settings PageWe have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to Miscellaneous
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (1)
Dockerfile (1)
Line range hint
52-52: Pin versions of packages inapt-get installand use--no-install-recommendsto ensure consistent and minimal builds.- apt-get install -y ca-certificates libasound2 ffmpeg sox ffmpeg + apt-get install -y --no-install-recommends ca-certificates=20210119 libasound2=1.2.4-1.1 ffmpeg=7:4.3.2-0+deb11u2 sox=14.4.2+git20200706-1
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/docker-build.yml (2 hunks)
- Dockerfile (3 hunks)
Additional Context Used
Hadolint (6)
Dockerfile (6)
7: Pin versions in apt get install. Instead of
apt-get install <package>useapt-get install <package>=<version>
7: Avoid additional packages by specifying
--no-install-recommends
27: Set the SHELL option -o pipefail before RUN with a pipe in it. If you are using /bin/sh in an alpine image or if your shell is symlinked to busybox then consider explicitly setting your SHELL to /bin/ash, or disable this check
44: Use WORKDIR to switch to a directory
52: Avoid additional packages by specifying
--no-install-recommends
52: Pin versions in apt get install. Instead of
apt-get install <package>useapt-get install <package>=<version>
Additional comments not posted (3)
Dockerfile (2)
39-39: Ensure theBUILDPLATFORMvariable is used consistently across all stages in the Dockerfile.
4-4: Ensure theBUILDPLATFORMvariable is defined or passed correctly to avoid build failures..github/workflows/docker-build.yml (1)
76-79: Ensure that the new caching mechanism (type=gha) and theprovenance: falsesetting are correctly configured and supported by your CI environment.
| # Pass in ARGs after FROM to use them in build stage | ||
| ARG TENSORFLOW_VERSION | ||
| ARG TARGETPLATFORM | ||
| FROM --platform=$BUILDPLATFORM golang:1.22.3-bookworm as buildenv | ||
|
|
||
| # Install zip utility along with other dependencies | ||
| RUN apt-get update && apt-get install -y \ |
There was a problem hiding this comment.
Use --no-install-recommends with apt-get install to avoid installing unnecessary packages.
- apt-get install -y curl git sudo zip
+ apt-get install -y --no-install-recommends curl git sudo zipCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| RUN apt-get update && apt-get install -y \ | |
| RUN apt-get update && apt-get install -y --no-install-recommends \ |
Pin versions of packages in apt-get install to ensure consistent builds.
- apt-get install -y curl git sudo zip
+ apt-get install -y curl=7.74.0-1.3+b1 git=1:2.30.2-1 sudo=1.9.5p2-3 zip=3.0-12Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| RUN apt-get update && apt-get install -y \ | |
| RUN apt-get update && apt-get install -y curl=7.74.0-1.3+b1 git=1:2.30.2-1 sudo=1.9.5p2-3 zip=3.0-12 |
|
|
||
| # Compile BirdNET-Go | ||
| COPY . BirdNET-Go | ||
| ARG TARGETPLATFORM | ||
| RUN --mount=type=cache,target=/go/pkg/mod \ |
There was a problem hiding this comment.
Use WORKDIR instead of cd for changing directories in Dockerfile to follow best practices.
- RUN --mount=type=cache,target=/go/pkg/mod --mount=type=cache,target=/root/.cache/go-build cd BirdNET-Go && make TARGETPLATFORM=${TARGETPLATFORM}
+ WORKDIR /BirdNET-Go
+ RUN --mount=type=cache,target=/go/pkg/mod --mount=type=cache,target=/root/.cache/go-build make TARGETPLATFORM=${TARGETPLATFORM}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| RUN --mount=type=cache,target=/go/pkg/mod \ | |
| WORKDIR /BirdNET-Go | |
| RUN --mount=type=cache,target=/go/pkg/mod --mount=type=cache,target=/root/.cache/go-build make TARGETPLATFORM=${TARGETPLATFORM} |
| && git -C tensorflow checkout | ||
|
|
||
| ARG TARGETPLATFORM | ||
|
|
||
| # Determine PLATFORM based on TARGETPLATFORM | ||
| RUN PLATFORM='unknown'; \ |
There was a problem hiding this comment.
Set the SHELL option -o pipefail before using pipes in RUN commands to ensure that errors in a pipeline are not masked.
+ SHELL ["/bin/bash", "-o", "pipefail"]
RUN curl -L ...Committable suggestion was skipped due low confidence.
Fixes missing x86 build mentioned in #175
Followed this guide to make improvements to the cross compilation process:
BUILDPLATFORMin dockerfile to get better docker caching and build speeds, since the platform of the computer used to build the image is used as much as possible, limiting the need for emulation.With the utilization of BUILDPLATFORM, the docker caching works way better for different platforms. Eliminating the need for separate build jobs added in #165. Meaning that only one job will be used again, that builds all the different platforms. Speed is even better now when rebuilding without any changes in github actions, around 20s.
In addition, removes the extra unknown platform by setting
provenance: falsebased on answers in: docker/build-push-action#820