esp-rs / esp-hal

no_std Hardware Abstraction Layers for ESP32 microcontrollers
https://docs.esp-rs.org/esp-hal/
Apache License 2.0
764 stars 214 forks source link

Improve release automation using xtask #2382

Open jessebraham opened 1 month ago

jessebraham commented 1 month ago

Currently, largely due to the sheer number of packages in this repository, releasing is a bit of a headache to put it mildly. Let's please discuss how we can automate this process to remove the possibility of human error as much as possible.

Some possible improvements:

@MabezDev @tom-borcin let's please discuss this tomorrow in our meeting.

AnthonyGrondin commented 4 weeks ago

My 2 cents;

I've been using the following tool: https://github.com/clog-tool/clog-lib for a while in one of my project and it's been going well. If this helps with the mentioned points above, that's good.

bjoernQ commented 2 weeks ago

I think the list of items is already quite complete - if we had all of this releasing would be a breeze :)

I have doubts about the first item however (the automatic part) but would love to get proved wrong

jessebraham commented 1 week ago

I don't know if I'm just slow or what, but I have tried cargo-semver-checks multiple times now and failed to ever get it working, constantly getting new horrifying errors, so unfortunately at this point I'm going to rule this out as a possibility. If anybody else has had success using this for embedded libraries I would love to hear how you got it working.

I will see if I can try to come up with some alternative approach.

jessebraham commented 1 week ago

I don't think the first item in the task list is reasonably possible at this point, this will still require manual review.