You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/BRANCH_AND_RELEASE_PROCESS.md
+53Lines changed: 53 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,3 +86,56 @@ In the event of a breaking interface change, a `release-v[0-9]+` branch is creat
86
86
In scenarios where urgent issues arise, the `hotfix` branch comes into play. A hotfix branch is created off main or the relevant release branch to address critical issues that need immediate attention. After the hotfix is implemented and thoroughly tested, it is merged back into both the `main` and the `release-v[0-9]+` branches to ensure the fix is included in the current and future versions of the project.
87
87
88
88
This dual approach of leveraging both **GitHub Flow** and **Git Flow** ensures that the project can iterate quickly while maintaining high standards of code stability and release management.
89
+
90
+
### Creating a Release
91
+
92
+
Since the latest stable code is contained on `main` in a typical **GitHub Flow**, to create a release someone with write access to the repository needs to simply just `git tag` the release and then create a (draft) release using that tag in the [repository's release page](https://github.com/deepgram/deepgram-python-sdk/releases).
93
+
94
+
If you haven't done this before, these are the typicial commands to execute at the root of the repository assuming you are on your fork:
95
+
96
+
```bash
97
+
# get the latest everything and update your fork
98
+
git checkout main
99
+
git pull --rebase upstream main
100
+
git push
101
+
git fetch upstream --tags
102
+
git push origin --tags
103
+
104
+
# create a new tag following semver
105
+
git tag -m <version><version>
106
+
git push upstream <version>
107
+
```
108
+
109
+
If the release you want to create is `v3.9.0`, then this would look like:
110
+
111
+
```bash
112
+
# get the latest everything and update your fork
113
+
git checkout main
114
+
git pull --rebase upstream main
115
+
git push
116
+
git fetch upstream --tags
117
+
git push origin --tags
118
+
119
+
# create a new tag following semver
120
+
git tag -m v3.9.0 v3.9.0
121
+
git push upstream v3.9.0
122
+
```
123
+
124
+
#### Creating a Release from a Release Branch
125
+
126
+
While we don't have a formal requirement for supporting past releases (ie currently on `v3` but need a patch on `v2`), there are times when you need to provide a patch release for things like security fixes. To create that patch releases, you do something similar as you would have done on main, but on the `release-v[0-9]+/*` branch.
127
+
128
+
If this were the `release-v2` branch for version `v2.5.1` (note the `v2` matches the `release-v2`), this would look like (again, assuming you are on your fork):
0 commit comments