Skip to content

Commit

Permalink
tweak release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mck1117 committed Dec 25, 2023
1 parent db1439e commit 2bfed0c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions firmware/release.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# 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
1. 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).
1. Create a release branch off master in the format `release_YYMMDD`, for example `release_230410` for a release in 10 April 2023. Run `git checkout -b release_YYMMDD`
1. Create a tag on that branch in the format `release_YYMMDD_nn` where `nn` is a sequence number (so we can release a patch off the same branch later and they sort correctly). Run `git tag release_YYMMDD_nn`
1. Push the branch and tags
1. Create a new release, upload all artifacts from the FW build
1. Create a new release, upload all artifacts from the FW build off the tag
* Title the release `MMMMM YYYY Release` (like `April 2023 Release`)

# How to Release a Patch
Expand All @@ -12,7 +12,7 @@ _patch releases should contain no new features or config changes, only bug fixes

1. Check out the previous release branch (created for the original release above)
1. Cherry pick the bugfix(es) you want from master (or make the fix by hand)
1. 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.
1. Create a tag in the format `release_YYMMDD_nn` where `nn` is incremented from the previous tag on that branch. For example, if the last tag was `release_230410_02`, create a tag `release_230410_03` for the new patch.
1. Push the branch & tag
1. Create a new release with artifacts from the FW build
1. Create a new release, upload all artifacts from the FW build off the tag
* Title the release `MMMMM YYYY Release Patch n` (like `April 2023 Release Patch 4`)

0 comments on commit 2bfed0c

Please sign in to comment.