Skip to content

tooling: Rename firmware targets to micropython-* with deprecation errors.#386

Merged
nedseb merged 2 commits intomainfrom
tooling/rename-firmware-targets
Apr 13, 2026
Merged

tooling: Rename firmware targets to micropython-* with deprecation errors.#386
nedseb merged 2 commits intomainfrom
tooling/rename-firmware-targets

Conversation

@nedseb
Copy link
Copy Markdown
Contributor

@nedseb nedseb commented Apr 13, 2026

Closes #378

Summary

Rename all firmware/deploy targets to use the micropython- prefix to disambiguate from the upcoming daplink- targets (#377). The legacy short names now print an error message asking which firmware (MicroPython or DAPLink) was intended.

New target names

Old New
make firmware make micropython-firmware
make firmware-update make micropython-update
make firmware-clean make micropython-clean
make deploy make micropython-deploy
make deploy-pyocd make micropython-deploy-pyocd
make deploy-openocd make micropython-deploy-openocd
make deploy-usb make micropython-deploy-usb

Deprecation behavior

Per request, the legacy names do not silently alias to the new ones. Instead, they print an explicit error:

$ make firmware
Error: 'make firmware' is ambiguous. Use one of:
  make micropython-firmware   (MicroPython firmware)
  make daplink-firmware       (DAPLink firmware, see #377)
make: *** [Makefile:154: firmware] Error 1

This forces users to make an explicit choice once daplink-* targets are added.

Files updated

  • Makefile — renamed targets, added deprecation error pattern
  • CONTRIBUTING.md — updated command tables and prerequisites
  • scripts/deploy_usb.py — error message
  • lib/steami_config/examples/calibrate_temperature.py — docstring
  • .github/workflows/release.yml — CI build step

Test plan

  • make help shows the new micropython-* targets
  • make firmware prints the deprecation error
  • make deploy prints the deprecation error
  • make micropython-firmware builds correctly
  • make test — 349 mock tests pass

Copilot AI review requested due to automatic review settings April 13, 2026 03:11
Copy link
Copy Markdown
Contributor

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

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, and micropython-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.

@nedseb nedseb merged commit 60f5b24 into main Apr 13, 2026
9 checks passed
@nedseb nedseb deleted the tooling/rename-firmware-targets branch April 13, 2026 03:17
@semantic-release-updater
Copy link
Copy Markdown

🎉 This PR is included in version 0.16.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tooling: Rename firmware targets to micropython-* for consistency.

2 participants