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 Mbed TLS clone step #3000

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Aug 2, 2024

Description

  • Need to update Mbed TLS submodules following clone.
  • Reorder command for clarity.

Motivation and Context

  • Fix images using Mbed TLS.

How Has This Been Tested?

  • Smoke tests in github actions.

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

  • New Features

    • Improved initialization of Git submodules for multiple projects, ensuring all dependencies are correctly set up during the build process.
    • Enhanced cloning order of repositories to prioritize critical dependencies for better project setup.
  • Bug Fixes

    • Adjustments to order of operations in Dockerfiles to prevent issues related to missing submodules during builds.

- Need to update submodule following clone.
Copy link

coderabbitai bot commented Aug 2, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

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 across multiple Dockerfiles and scripts primarily focus on reorganizing the order of repository cloning and ensuring that all necessary git submodules for the mbedtls repository are properly initialized and updated. This restructuring enhances the build process for various projects by ensuring that all dependencies are available and correctly configured, thereby improving reliability during setup.

Changes

Files Change Summary
.devcontainer/All/Dockerfile.All.SRC Reordered cloning of repositories; added command to initialize submodules for mbedtls.
.devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC Modified cloning sequence; added initialization for mbedtls submodules.
.devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC Reordered cloning commands; added command to initialize submodules for mbedtls.
.devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC Altered cloning order to prioritize fatfs and lwip before mbedtls; added submodule initialization.
.devcontainer/All/scripts/git-pull-repos.sh Added command to initialize mbedtls submodules after pulling the latest changes from the repository.

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7f9c23c and db82046.

Files selected for processing (5)
  • .devcontainer/All/Dockerfile.All.SRC (1 hunks)
  • .devcontainer/All/scripts/git-pull-repos.sh (1 hunks)
  • .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (1 hunks)
  • .devcontainer/ChibiOS/Dockerfile.ChibiOS.SRC (1 hunks)
  • .devcontainer/FreeRTOS-NXP/Dockerfile.FreeRTOS-NXP.SRC (1 hunks)
Additional comments not posted (7)
.devcontainer/All/scripts/git-pull-repos.sh (1)

19-19: Good addition to ensure submodules are initialized and updated.

The addition of git submodule update --init ensures that all necessary submodules for the mbedtls repository are properly initialized and updated, which is crucial for maintaining the integrity of the repository.

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

58-62: Reordering of git clone commands improves clarity.

The reordering of the git clone commands for fatfs and lwip before mbedtls enhances the readability and organization of the Dockerfile.


62-62: Good addition to ensure submodules are initialized and updated.

The addition of git submodule update --init --recursive ensures that all necessary submodules for the mbedtls repository are properly initialized and updated, which is crucial for maintaining the integrity of the repository.

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

68-71: Reordering of git clone commands improves clarity.

The reordering of the git clone commands for fatfs, littlefs, and lwip before mbedtls enhances the readability and organization of the Dockerfile.


72-73: Good addition to ensure submodules are initialized and updated.

The addition of git submodule update --init --recursive ensures that all necessary submodules for the mbedtls repository are properly initialized and updated, which is crucial for maintaining the integrity of the repository.

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

70-74: LGTM! The changes improve clarity and ensure proper initialization of submodules.

The reordering of the cloning commands and the addition of submodule initialization for mbedtls enhance the setup process.

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

81-85: LGTM! The changes improve clarity and ensure proper initialization of submodules.

The reordering of the cloning commands and the addition of submodule initialization for mbedtls enhance the setup process.

@josesimoes
Copy link
Member Author

ESP32 builds failing as expected. Fixed in #2999.

@josesimoes josesimoes merged commit 2660092 into nanoframework:main Aug 2, 2024
13 of 20 checks passed
@josesimoes josesimoes deleted the fix-mbedlts-clone branch August 2, 2024 10:33
TerryFogg pushed a commit to TerryFogg/nf-interpreter that referenced this pull request Dec 3, 2024
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.

2 participants