tooling: Rename firmware targets to micropython-* with deprecation errors.#386
Merged
tooling: Rename firmware targets to micropython-* with deprecation errors.#386
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Renames the project’s firmware/deploy Make targets to a micropython-* prefix to avoid ambiguity ahead of planned daplink-* targets, and adds explicit erroring “deprecated” legacy targets to force users to choose.
Changes:
- Renamed Makefile targets to
micropython-firmware,micropython-update,micropython-clean, andmicropython-deploy*. - Added deprecated legacy targets (
firmware,deploy, etc.) that fail with a clear “ambiguous” error message pointing to the explicit targets. - Updated docs, examples, USB deploy script messaging, and release workflow to use the new target names.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
Makefile |
Introduces micropython-* targets and adds legacy targets that error with guidance to the new names. |
CONTRIBUTING.md |
Updates prerequisites and firmware build/deploy command examples to the new target names and documents deprecation behavior. |
scripts/deploy_usb.py |
Updates the “build first” guidance to reference make micropython-firmware. |
lib/steami_config/examples/calibrate_temperature.py |
Updates example docstring instructions to use micropython-* targets. |
.github/workflows/release.yml |
Updates firmware build step to call make micropython-firmware. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
🎉 This PR is included in version 0.16.6 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #378
Summary
Rename all firmware/deploy targets to use the
micropython-prefix to disambiguate from the upcomingdaplink-targets (#377). The legacy short names now print an error message asking which firmware (MicroPython or DAPLink) was intended.New target names
make firmwaremake micropython-firmwaremake firmware-updatemake micropython-updatemake firmware-cleanmake micropython-cleanmake deploymake micropython-deploymake deploy-pyocdmake micropython-deploy-pyocdmake deploy-openocdmake micropython-deploy-openocdmake deploy-usbmake micropython-deploy-usbDeprecation behavior
Per request, the legacy names do not silently alias to the new ones. Instead, they print an explicit error:
This forces users to make an explicit choice once
daplink-*targets are added.Files updated
Makefile— renamed targets, added deprecation error patternCONTRIBUTING.md— updated command tables and prerequisitesscripts/deploy_usb.py— error messagelib/steami_config/examples/calibrate_temperature.py— docstring.github/workflows/release.yml— CI build stepTest plan
make helpshows the newmicropython-*targetsmake firmwareprints the deprecation errormake deployprints the deprecation errormake micropython-firmwarebuilds correctlymake test— 349 mock tests pass