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: CONTRIBUTING.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -191,7 +191,14 @@ GitLens version changes are bucketed into two types:
191
191
192
192
#### Preparing a Normal Release
193
193
194
-
Use the [prep-release](scripts/prep-release.js) script to prepare a new release. The script updates the [package.json](package.json) and [CHANGELOG.md](CHANGELOG.md) appropriately, commits the changes as `Bumps to v{major}.{minor}.{patch}`, and creates a `v{major}.{minor}.{patch}` tag which when pushed will trigger the CI to publish a release.
194
+
Before publishing a new release, do the following:
195
+
196
+
1. Create a GitHub milestone for any potential patch releases, named `{major}.{minor}-patch` with a description of `Work intended for any patch releases before the {major}.{minor} release`
197
+
2. Create a GitHub milestone for the next release, `{major}.{minor+1}` with a description of `Work intended for the {release-month} {release-year} release` and a set the appropriate due date
198
+
3. Ensure all items in the `{major}.{minor}` GitHub milestone are closed and verified or moved into one of the above milestones
199
+
4. Close the `{major}.{minor}` and `{major}.{minor-1}-patch` GitHub milestones
200
+
201
+
Then, use the [prep-release](scripts/prep-release.js) script to prepare a new release. The script updates the [package.json](package.json) and [CHANGELOG.md](CHANGELOG.md) appropriately, commits the changes as `Bumps to v{major}.{minor}.{patch}`, and creates a `v{major}.{minor}.{patch}` tag which when pushed will trigger the CI to publish a release.
195
202
196
203
1. Ensure you are on the `main` branch and have a clean working tree
197
204
2. Ensure the [CHANGELOG.md](CHANGELOG.md) has been updated with the release notes
@@ -205,10 +212,13 @@ If the action fails and retries are unsuccessful, the VSIX can be built locally
205
212
206
213
#### Preparing a Patch Release
207
214
208
-
1. Create, if needed, a `release/{major}.{minor}` branch from the latest `v{major}.{minor}.{patch}` tag
209
-
2. Cherry-pick the desired commits from `main` into the `release/{major}.{minor}` branch
210
-
3. Follow steps 2-5 in [Preparing a Normal Release](#preparing-a-normal-release) above
211
-
4. Manually update the [CHANGELOG.md](CHANGELOG.md) on `main` with the patch release notes
215
+
Before publishing a new release, do the following:
216
+
217
+
1. Ensure all items in the `{major}.{minor}-patch` GitHub milestone are closed and verified
218
+
2. Create, if needed, a `release/{major}.{minor}` branch from the latest `v{major}.{minor}.{patch}` tag
219
+
3. Cherry-pick the desired commits from `main` into the `release/{major}.{minor}` branch
220
+
4. Follow steps 2-5 in [Preparing a Normal Release](#preparing-a-normal-release) above
221
+
5. Manually update the [CHANGELOG.md](CHANGELOG.md) on `main` with the patch release notes
212
222
213
223
Note: All patch releases for the same `{major}.{minor}` version use the same `release/{major}.{minor}` branch
0 commit comments