Skip to content

Commit f54fee6

Browse files
authored
Add release branch policy (#1003)
* Add release branch policy * Invert the policy as discussed
1 parent fcae294 commit f54fee6

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/Release.md

+13
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ Follow this list for items that must be completed for release of the `vscode-has
1616
- Github actions will automatically release the extension to VSCode- and VSX-Marketplace.
1717
- If you want to create a pre-release, create a [pre-release in Github](https://github.com/haskell/vscode-haskell/releases). The github action will perform the appropriate actions automatically and publish the pre-release of the extension to VSCode- and VSX-Marketplace.
1818

19+
## Branching policy
20+
21+
Sometimes there is a release (stable) and pre-release (unstable) at the same time and we need to do a release for the stable release and sometimes we need to do a release for the pre-release series.
22+
To simplify the release management, the following policy is in place:
23+
24+
* The branch `master` contains the current pre-release
25+
* As such, its `package.json` must always have the form `major.ODD_NUMBER.patch`
26+
* Dependency version bumps are automatically performed by dependabot against `master`
27+
* For each release, a tag must be created
28+
* Stable releases are located on a separate branch called `release-<major.EVEN_NUMBER>`
29+
* Before a release, the branch is rebased on top of current master
30+
* For each stable release, a tag must be created of the form `major.EVEN_NUMBER.patch`
31+
1932
## Release CI
2033

2134
The release CI has access tokens for VSX Marketplace and the VSCode Marketplace.

0 commit comments

Comments
 (0)