|
| 1 | +# How to make a hotfix release |
| 2 | + |
| 3 | +This document describes how to generate a hotfix release for backplane-cli. |
| 4 | + |
| 5 | +### When to make a hotfix release |
| 6 | + |
| 7 | +- A critical bug has been found |
| 8 | +- Security vulnerabilities have been encountered |
| 9 | +- Something broke in the last/latest release |
| 10 | + |
| 11 | +### Hotfix release process technical guidelines |
| 12 | + |
| 13 | +Please make sure to adhere to these following guidelines below for the hotfix release process : |
| 14 | + |
| 15 | +#### 1. Create an OSD card |
| 16 | + |
| 17 | +- Create an OSD card with title : **Backplane Hotfix Release for <$reason>** |
| 18 | +- In the description of the card , mention details about the intention/reason behind this hotfix. |
| 19 | +- Set the Priority of this card as High. |
| 20 | +- Add backplane-hotfix label to it. |
| 21 | + |
| 22 | +#### 2. Create pull request |
| 23 | + |
| 24 | +- Create a branch called **hotfix-$OSD-card-number** in your code repository. |
| 25 | + |
| 26 | +**NOTE** : We strongly recommend that all the changes are well tested and validated before commiting them. |
| 27 | + |
| 28 | +- ##### If the hotfix is on reverting a commit : |
| 29 | + 1. Use ```git log``` to get the commit hash of the targeted commit. |
| 30 | + 1. Once you get the commit hash , use git revert with -m flag. |
| 31 | + In git revert -m, the -m option specifies the parent number. When you view a merge commit in the output of git log, you will see its parents listed on the line that begins with **Merge:** |
| 32 | + 1. Execute ```git revert -m <$parent number> <$commit-hash> ``` |
| 33 | + 1. ```git push -u origin {hotfix-branch}``` |
| 34 | + |
| 35 | + Alternatively, you can get backplane maintainers to use GitHub's UI to revert a commit directly from the merged PR, which simplifies the process and avoids potential errors in command execution. |
| 36 | + |
| 37 | +- ##### If there are code changes to be made : |
| 38 | + 1. Make applicable code changes. |
| 39 | + 1. Raise PR for the same following the usual PR process |
| 40 | + |
| 41 | +Once you raise the PR, mention the OSD card created in step1 in the description of the PR. |
| 42 | + |
| 43 | +#### 3. Reach out to the backplane-team |
| 44 | + |
| 45 | +Once you create the PR : |
| 46 | + |
| 47 | +1. Reach out to **@backplane-team** in #sd-ims-backplane slack channel asking for review and merge. |
| 48 | +1. Once the PR is merged, ask **@Backplane-cli** to cut a new backplane release. |
| 49 | + |
| 50 | +#### 4. How to announce hotfix release |
| 51 | + |
| 52 | +Send an email to applicable stakeholders . Include details on the purpose behind the release. |
0 commit comments