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

Define a regular crates-io release cycle #2936

Open
jamesmunns opened this issue May 13, 2024 · 2 comments
Open

Define a regular crates-io release cycle #2936

jamesmunns opened this issue May 13, 2024 · 2 comments

Comments

@jamesmunns
Copy link
Contributor

It would be good to commit to a more regular crates-io release cycle, in order to get more people away from patches when possible.

It might be good to set up some regular cadence, like every week or two, if there have been any changes.

I don't think we necessarily need to commit to a more stringent stability guarantee, it could be a (breaking) point release every time for the foreseeable future.

@jamesmunns
Copy link
Contributor Author

Chatted with @Dirbaio, there's loose interest, before we can do that, we need to make the following docs/process things happen:

  • Get an inventory of all crates in the embassy workspace, including intra-crate deps (so we know what order to release in)
  • Add a release team to embassy on GH, make sure all crates-io crates have permissions for that team
  • Add people to that team (who?)
  • Write a checklist for periodic releases, like reving version numbers, updating changelogs, tagging commits, etc.
  • Write in the docs somewhere what the planned cadence is (1/2/3/4/5/6 weeks)
  • Do a first release with "all hands on deck", update with any missed details

@jamesmunns
Copy link
Contributor Author

Crate Inventory

$ git log | head -n 1                             
commit b33ef0d7dd4eb9124626ca5242cab57906b3007c
$ find . | rg 'Cargo.toml$' | rg -v '/examples/' | rg -v '/tests/'
./embassy-net-ppp/Cargo.toml
./embassy-usb-driver/Cargo.toml
./embassy-stm32/Cargo.toml
./embassy-net-esp-hosted/Cargo.toml
./cyw43-pio/Cargo.toml
./embassy-time/Cargo.toml
./embassy-executor/Cargo.toml
./embassy-time-queue-driver/Cargo.toml
./embassy-boot-nrf/Cargo.toml
./embassy-net-driver-channel/Cargo.toml
./embassy-rp/Cargo.toml
./embassy-hal-internal/Cargo.toml
./embassy-sync/Cargo.toml
./embassy-usb/Cargo.toml
./embassy-nrf/Cargo.toml
./embassy-futures/Cargo.toml
./embassy-net-wiznet/Cargo.toml
./embassy-usb-logger/Cargo.toml
./embassy-usb-synopsys-otg/Cargo.toml
./embassy-net-driver/Cargo.toml
./embassy-net-tuntap/Cargo.toml
./embassy-usb-dfu/Cargo.toml
./embassy-boot-rp/Cargo.toml
./embassy-net-adin1110/Cargo.toml
./embassy-boot/Cargo.toml
./embassy-net-enc28j60/Cargo.toml
./embassy-time-driver/Cargo.toml
./embassy-embedded-hal/Cargo.toml
./embassy-boot-stm32/Cargo.toml
./cyw43/Cargo.toml
./embassy-net/Cargo.toml
./embassy-executor-macros/Cargo.toml
./embassy-stm32-wpan/Cargo.toml

Still todo, figuring out the inverted dep tree order.

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

No branches or pull requests

1 participant