diff options
| author | xengineering <me@xengineering.eu> | 2025-05-24 14:48:52 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-05-24 14:48:52 +0200 |
| commit | 771f8b220bc5fca716c7609a7ce995dcf4839992 (patch) | |
| tree | 142d616341eb7dd432bb89f6028e61fa6a2bbbd6 | |
| parent | 14f710c75a0a046ba4ffe9af40d9852497e5e1f4 (diff) | |
| download | iot-contact-771f8b220bc5fca716c7609a7ce995dcf4839992.tar iot-contact-771f8b220bc5fca716c7609a7ce995dcf4839992.tar.zst iot-contact-771f8b220bc5fca716c7609a7ce995dcf4839992.zip | |
Add RELEASE.md
To allow features like PCB version detection the version encoding
requires manual intervention. A release checklist like this allows to
reliably execute such tasks.
| -rw-r--r-- | RELEASE.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..80f0879 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,10 @@ +This is a mandatory release checklist. + +- select a version string with pattern `v<major>.<minor>.<patch>` optionally + with a `-pre<count>` suffix (e.g. `v1.2.45-pre67`) +- reserve resistor combination in `pcb/versions.tsv` by adding version string +- set values of `R1` and `R2` in root schematic according to `pcb/versions.tsv` +- write version string to PCB silk screen +- commit all changes +- execute all automated and manual tests +- create release tag |