Skip to content

Conversation

@Olverine
Copy link

Description

The bin2array.cmake file in the examples directory calculates md5 checksums of binary files using the program md5sum. The execution of the external md5sum command will only work on certain systems. CMake has a built-in, cross-platform MD5 function.

This method works on any system and is not dependent on external command execution

Related

Testing

I have tested this on Ubuntu and Windows.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

This method works on any system and is not dependent on external command execution
@github-actions
Copy link

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Cross platform MD5 hash computation for binary files":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello Olverine, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against e930955

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves cross-platform compatibility of the build system by replacing the platform-specific md5sum command with CMake's built-in MD5 computation function. The bin2array.cmake utility is used across multiple example projects (ESP32, STM32, Raspberry Pi, Pi Pico, Zephyr) to embed binary firmware files as C arrays with MD5 checksums, making this change broadly beneficial for Windows and other platforms where md5sum may not be available.

Key changes:

  • Replaced execute_process(COMMAND md5sum ...) with file(MD5 ...) for MD5 hash computation
  • Removed regex parsing step that was previously needed to extract the hash from md5sum output

@github-actions github-actions bot changed the title fix(build) Cross platform MD5 hash computation for binary files fix(build) Cross platform MD5 hash computation for binary files (ESF-263) Dec 17, 2025
@Dzarda7
Copy link
Collaborator

Dzarda7 commented Dec 17, 2025

Hello @Olverine, thanks a lot for noticing and fixing. Never thought about that. Great small improvement to the library! As you can see in contribution guide we use conventional commit messages. So can you only modify it to be something like fix(examples): Use cross platform MD5 hash computation? After that we can merge it. Thanks.

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