Skip to content

Update dev-containers to use CMake v3.31.6 #3145

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

Merged
merged 3 commits into from
Apr 7, 2025

Conversation

networkfusion
Copy link
Member

@networkfusion networkfusion commented Apr 6, 2025

Description

  • Update dev-container src to use Cmake 3.31.6.
  • Fix smoke test target name, FEATHER_S2 is now ESP32_S2_USB.
  • Bump container versions.

Motivation and Context

This is the latest cmake version compatible and will be used by the CI.

How Has This Been Tested?

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • Chores
    • Updated Docker container base images across various platforms to ensure improved stability and compatibility.
    • Upgraded the build process by moving to a newer version of a key build tool, enhancing the overall development experience.
  • Documentation
    • Corrected a minor typographical error in inline comments to improve clarity.

These enhancements help streamline container builds and contribute to a more robust and efficient development environment.

Copy link

coderabbitai bot commented Apr 6, 2025

Walkthrough

The pull request updates multiple Dockerfiles within the development container configuration. Each container’s base image version has been incremented, and the corresponding source files now set the CMAKE_VERSION argument to 3.31.6 instead of 3.27.6. Additionally, a minor comment typo in one of the source files has been corrected. These changes apply across All, AzureRTOS, ChibiOS, ESP32, FreeRTOS-NXP, and TI environments.

Changes

File(s) Change Summary
.devcontainer/.../Dockerfile.All, .devcontainer/.../Dockerfile.AzureRTOS,
.devcontainer/.../Dockerfile.ChibiOS, .devcontainer/.../Dockerfile.ESP32,
.devcontainer/.../Dockerfile.FreeRTOS-NXP, .devcontainer/.../Dockerfile.TI
Updated base images:
- All: v2.55 → v2.56
- AzureRTOS: v1.32 → v1.33
- ChibiOS: v1.33 → v1.34
- ESP32: v2.35 → v2.36
- FreeRTOS-NXP: v1.05 → v1.06
- TI: v1.26 → v1.27
.devcontainer/.../Dockerfile.All.SRC, .devcontainer/.../Dockerfile.AzureRTOS.SRC,
.devcontainer/.../Dockerfile.ChibiOS.SRC, .devcontainer/.../Dockerfile.ESP32.SRC,
.devcontainer/.../Dockerfile.FreeRTOS-NXP.SRC, .devcontainer/.../Dockerfile.TI.SRC
Updated ARG CMAKE_VERSION from 3.27.6 to 3.31.6; also corrected a typo in a comment in the All source file

Suggested labels

Type: enhancement, Area: Config-and-Build, Type: dependencies


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffa6f9f and 6025132.

📒 Files selected for processing (12)
  • .devcontainer/All/Dockerfile.All (1 hunks)
  • .devcontainer/All/Dockerfile.All.SRC (2 hunks)
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS (1 hunks)
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (1 hunks)
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS (1 hunks)
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC (1 hunks)
  • .devcontainer/ESP32/Dockerfile.ESP32 (1 hunks)
  • .devcontainer/ESP32/Dockerfile.ESP32.SRC (1 hunks)
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP (1 hunks)
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC (1 hunks)
  • .devcontainer/TI/Dockerfile.TI (1 hunks)
  • .devcontainer/TI/Dockerfile.TI.SRC (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (12)
  • .devcontainer/TI/Dockerfile.TI
  • .devcontainer/ESP32/Dockerfile.ESP32
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS
  • .devcontainer/All/Dockerfile.All
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC
  • .devcontainer/ESP32/Dockerfile.ESP32.SRC
  • .devcontainer/TI/Dockerfile.TI.SRC
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS
  • .devcontainer/All/Dockerfile.All.SRC
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)
  • GitHub Check: build-target (TI_CC1352R1_LAUNCHXL, Debug, All, 915)
  • GitHub Check: build-target (TI_CC1352R1_LAUNCHXL, Debug, TI, 915)
  • GitHub Check: build-target (NXP_MIMXRT1060_EVK, Debug, All)
  • GitHub Check: build-target (NXP_MIMXRT1060_EVK, Debug, FreeRTOS-NXP)
  • GitHub Check: build-target (ESP32_H2_THREAD, Debug, ESP32)
  • GitHub Check: build-target (ESP32_C6_THREAD, Debug, ESP32)
  • GitHub Check: build-target (ESP32_C3, Debug, ESP32)
  • GitHub Check: build-target (ESP32_S3, Debug, ESP32)
  • GitHub Check: build-target (ESP32_S2_USB, Debug, ESP32)
  • GitHub Check: build-target (ESP_WROVER_KIT, Debug, ESP32)
  • GitHub Check: build-target (M5Core2, Debug, ESP32)
  • GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, All)
  • GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, ChibiOS)
  • GitHub Check: build-target (SL_STK3701A, Debug, All)
  • GitHub Check: build-target (SL_STK3701A, Debug, AzureRTOS)

🪧 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 plan to trigger planning for file edits and PR creation.
  • @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.

@networkfusion networkfusion changed the title Update dev-container src to use cmake 3.31.6 Update dev-containers to use cmake 3.31.6 Apr 6, 2025
@networkfusion networkfusion marked this pull request as ready for review April 6, 2025 18:39
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

🧹 Nitpick comments (3)
.devcontainer/TI/Dockerfile.TI.SRC (1)

29-29: Typo in TI Tools Comment
There is a minor typo in the comment: “Cheack all versions here:” on line 29. Please update “Cheack” to “Check” to improve clarity.

.devcontainer/All/Dockerfile.All.SRC (1)

29-33: Minor Typo in TI Tools Comment
In the comment on line 29, "Cheack all versions here:" contains a typographical error. Please change “Cheack” to “Check” to maintain professionalism in documentation.

.github/workflows/devcontainer-smoketest.yaml (1)

22-22: Smoke Test Matrix Target Update & YAML Formatting
The smoke test matrix now includes the target ESP32_S2_USB—replacing FEATHER_S2—which aligns with the updated CI configuration. Additionally, YAMLlint flagged extra spaces after commas on this line; consider cleaning up the formatting for enhanced readability.

🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 22-22: too many spaces after comma

(commas)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75ce2fd and e60f56f.

📒 Files selected for processing (13)
  • .devcontainer/All/Dockerfile.All (1 hunks)
  • .devcontainer/All/Dockerfile.All.SRC (1 hunks)
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS (1 hunks)
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (1 hunks)
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS (1 hunks)
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC (1 hunks)
  • .devcontainer/ESP32/Dockerfile.ESP32 (1 hunks)
  • .devcontainer/ESP32/Dockerfile.ESP32.SRC (1 hunks)
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP (1 hunks)
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC (1 hunks)
  • .devcontainer/TI/Dockerfile.TI (1 hunks)
  • .devcontainer/TI/Dockerfile.TI.SRC (1 hunks)
  • .github/workflows/devcontainer-smoketest.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/devcontainer-smoketest.yaml

[warning] 22-22: too many spaces after comma

(commas)

⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)
  • GitHub Check: build-target (TI_CC1352R1_LAUNCHXL, Debug, All, 915)
  • GitHub Check: build-target (NXP_MIMXRT1060_EVK, Debug, All)
  • GitHub Check: build-target (ESP32_H2_THREAD, Debug, ESP32)
  • GitHub Check: build-target (ESP32_C6_THREAD, Debug, ESP32)
  • GitHub Check: build-target (ESP32_C3, Debug, ESP32)
  • GitHub Check: build-target (ESP32_S3, Debug, ESP32)
  • GitHub Check: build-target (ESP32_S2_USB, Debug, ESP32)
  • GitHub Check: build-target (ESP_WROVER_KIT, Debug, ESP32)
  • GitHub Check: build-target (M5Core2, Debug, ESP32)
  • GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, All)
  • GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, ChibiOS)
  • GitHub Check: build-target (SL_STK3701A, Debug, All)
  • GitHub Check: build-target (SL_STK3701A, Debug, AzureRTOS)
🔇 Additional comments (14)
.devcontainer/All/Dockerfile.All (1)

1-2: Base Image Update Verification in All Dockerfile

The FROM line has been updated from version v2.55 to v2.56, which is consistent with the overall container upgrade strategy. Ensure that any dependencies or tooling that rely on the previous version are compatible with this change.

.devcontainer/TI/Dockerfile.TI (1)

1-2: TI Dockerfile Base Image Update

The Dockerfile successfully updates the base image from v1.26 to v1.27. Please verify that the corresponding update to the CMake version (from 3.27.6 to 3.31.6) in the related .SRC Dockerfile is in place, ensuring full alignment with the PR objectives.

.devcontainer/ChibiOS/Dockerfile.ChibiOS (1)

1-2: ChibiOS Dockerfile Base Image Upgrade

The updated base image version (v1.34 instead of v1.33) appears correctly applied. As with other containers, confirm that the associated CMake version upgrade to 3.31.6 (likely in the .SRC counterpart) remains consistent with the overall update.

.devcontainer/AzureRTOS/Dockerfile.AzureRTOS (1)

1-2: AzureRTOS Dockerfile Base Image and CMake Version Alignment

The Dockerfile now uses the updated base image v1.33 (previously v1.32). Ensure that the upgrade of the CMake version to 3.31.6 is also reflected in the relevant Dockerfile.AzureRTOS.SRC or any associated configuration files, as per the PR objectives.

.devcontainer/ESP32/Dockerfile.ESP32 (1)

1-2: ESP32 Dockerfile Update for Base Image and CMake Version

The base image has been updated to v2.36 from v2.35, which is in line with the coordinated container updates. Please double-check that the specified CMake version is updated to 3.31.6 in its corresponding .SRC Dockerfile to maintain consistency.

.devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (2)

20-27: Update CMake Version and Install Script
The change correctly updates the CMake version to 3.31.6 and adapts the download URL accordingly. The installation commands remain clear and functional.


29-29: Verify Base Image Version Consistency
The PR objectives mention an update of the base image version (from v1.32 to v1.33). Please confirm that the intended change is reflected in this Dockerfile (or if it should be applied elsewhere) since only FROM ubuntu:latest AS devcontainer is visible here.

.devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC (1)

20-27: Consistent Update of CMake Version
The Dockerfile clearly updates ARG CMAKE_VERSION to 3.31.6 and regenerates the CMake script URL accordingly. The change is applied consistently in this file.

.devcontainer/TI/Dockerfile.TI.SRC (1)

20-27: Update of CMake Version
The TI Dockerfile now uses CMAKE_VERSION=3.31.6 and the associated URL is updated for the CMake installation. This change is correct and uniform with the other Dockerfiles.

.devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC (2)

20-27: CMake Version Updated Consistently
The update to ARG CMAKE_VERSION=3.31.6 and its use in constructing the download URL is applied correctly in this Dockerfile.


29-29: Verify Base Image Update for Devcontainer
The PR summary indicates an update of the base image (from v1.05 to v1.06) for the FreeRTOS-NXP container. However, the devcontainer stage is defined as FROM python:3.10 AS devcontainer. Please confirm that the intended base image update is correctly reflected here.

.devcontainer/All/Dockerfile.All.SRC (1)

20-27: Updated CMake Version
The Dockerfile has been updated to set ARG CMAKE_VERSION=3.31.6; the corresponding CMake script URL now reflects the new version. This update is consistent with the other container configurations.

.devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP (1)

1-1: Base Image Update Verified
The Dockerfile now uses the updated base image v1.06, which is consistent with the broader update across development containers.

.devcontainer/ESP32/Dockerfile.ESP32.SRC (1)

12-20: Updated CMake Version Argument
The ARG directive for CMAKE_VERSION has been updated to 3.31.6, and the download script URL correctly incorporates this version. This update is in line with the objective to use the latest CMake version across dev containers. Please verify that all downstream scripts and installations are compatible with this version.

@josesimoes josesimoes changed the title Update dev-containers to use cmake 3.31.6 Update dev-containers to use pin CMake to v3.31.6 Apr 7, 2025
@josesimoes josesimoes force-pushed the networkfusion/dev-containers-src-cmake branch from ffa6f9f to 6025132 Compare April 7, 2025 13:28
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

LGTM

@josesimoes josesimoes changed the title Update dev-containers to use pin CMake to v3.31.6 Update dev-containers to use CMake v3.31.6 Apr 7, 2025
@josesimoes josesimoes merged commit 9fc44db into main Apr 7, 2025
21 checks passed
@josesimoes josesimoes deleted the networkfusion/dev-containers-src-cmake branch April 7, 2025 13:37
@coderabbitai coderabbitai bot mentioned this pull request Apr 16, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants