Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release branch policy #1003

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ Follow this list for items that must be completed for release of the `vscode-has
- Github actions will automatically release the extension to VSCode- and VSX-Marketplace.
- 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.

## Branching policy

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.
To simplify the release management, the following policy is in place:

* The branch `master` contains the current stable release
fendor marked this conversation as resolved.
Show resolved Hide resolved
* As such, its `package.json` must always have the form `major.EVEN_NUMBER.patch`
* Dependency version bumps are automatically performed by dependabot against `master`
* For each release, a tag must be created
* Pre-releases are located on a separate branch called `pre-release-<major.ODD_NUMBER>`
* Before a release, the branch is rebased on top of current master
fendor marked this conversation as resolved.
Show resolved Hide resolved
* For each pre-release, a tag must be created

## Release CI

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