FOME-Tech
/
fome-fw
mirror of https://github.com/FOME-Tech/fome-fw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
fome-fw/firmware/release.md

1.1 KiB
Raw Blame History

How to Release

  1. Create a release branch off master in the format release_YYMM, for example release_2304 for a release in April 2023
  2. Create a tag on that branch in the format release_YYMM_nn where nn is a sequence number (so we can release a patch off the same branch later and they sort correctly).
  3. Push the branch and tags
  4. Create a new release, upload all artifacts from the FW build
    • Title the release MMMMM YYYY Release (like April 2023 Release)

How to Release a Patch

patch releases should contain no new features or config changes, only bug fixes that actually matter

  1. Check out the previous release branch (created for the original release above)
  2. Cherry pick the bugfix(es) you want from master (or make the fix by hand)
  3. Create a tag in the format release_YYMM_nn where nn is incremented from the previous tag on that branch. For example, if the last tag was release_2304_02, create a tag release_2304_03 for the new patch.
  4. Push the branch & tag
  5. Create a new release with artifacts from the FW build
    • Title the release MMMMM YYYY Release Patch n (like April 2023 Release Patch 4)