gitlab-org--gitlab-foss/doc/release/patch.md

# Things to do when doing a patch release

NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update).

## When to do a patch release

Do a patch release when there is a critical regression that needs to be addresses before the next monthly release.

Otherwise include it in the monthly release and note there was a regression fix in the release announcement.

## Release Procedure

### Preparation

1. Verify that the issue can be reproduced
1. Note in the 'GitLab X.X regressions' that you will create a patch
1. Create an issue on private GitLab development server
1. Name the issue "Release X.X.X CE and X.X.X EE", this will make searching easier
1. Fix the issue on a feature branch, do this on the private GitLab development server
1. If it is a security issue, then assign it to the release manager and apply a 'security' label
1. Consider creating and testing workarounds
1. After the branch is merged into master, cherry pick the commit(s) into the current stable branch
1. Make sure that the build has passed and all tests are passing
1. In a separate commit in the stable branch update the CHANGELOG
1. For EE, update the CHANGELOG-EE if it is EE specific fix. Otherwise, merge the stable CE branch and add to CHANGELOG-EE "Merge community edition changes for version X.X.X"

### Bump version 

Get release tools

```
git clone git@dev.gitlab.org:gitlab/release-tools.git
cd release-tools
```

Bump version in stable branch, create release tag and push to remotes:

```
bundle exec rake release["x.x.x"]
```

Or if you need to release only EE:

```
CE=false be rake release['x.x.x']
```

### Release

1. Apply the patch to GitLab Cloud and the private GitLab development server
1. [Build new packages with the latest version](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/release.md)
1. Cherry-pick the changelog update back into master
1. Create and publish a blog post
1. Send tweets about the release from `@gitlabhq`, tweet should include the most important feature that the release is addressing and link to the blog post
1. Note in the 'GitLab X.X regressions' issue that the patch was published (CE only)
Add patch release document. 2014-04-10 09:23:44 +00:00			`# Things to do when doing a patch release`
Add titles to doc pages. 2014-05-27 12:12:15 +00:00
Add patch release document. 2014-04-10 09:23:44 +00:00			`NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update).`

			`## When to do a patch release`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`Do a patch release when there is a critical regression that needs to be addresses before the next monthly release.`

Add patch release document. 2014-04-10 09:23:44 +00:00			`Otherwise include it in the monthly release and note there was a regression fix in the release announcement.`

			`## Release Procedure`

Use release tools in patch release Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2014-11-11 10:01:47 +00:00			`### Preparation`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`1. Verify that the issue can be reproduced`
Cherry-pick the changelog additions into master. 2014-05-27 12:56:52 +00:00			`1. Note in the 'GitLab X.X regressions' that you will create a patch`
Add patch release document. 2014-04-10 09:23:44 +00:00			`1. Create an issue on private GitLab development server`
			`1. Name the issue "Release X.X.X CE and X.X.X EE", this will make searching easier`
			`1. Fix the issue on a feature branch, do this on the private GitLab development server`
Establish ownership of security releases 2014-11-24 11:14:19 +00:00			`1. If it is a security issue, then assign it to the release manager and apply a 'security' label`
Update security document with the link to patch document. 2014-04-14 07:06:42 +00:00			`1. Consider creating and testing workarounds`
Add patch release document. 2014-04-10 09:23:44 +00:00			`1. After the branch is merged into master, cherry pick the commit(s) into the current stable branch`
Use release tools in patch release Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2014-11-11 10:01:47 +00:00			`1. Make sure that the build has passed and all tests are passing`
Cherry-pick the changelog additions into master. 2014-05-27 12:56:52 +00:00			`1. In a separate commit in the stable branch update the CHANGELOG`
EE changelog note. 2014-04-10 09:28:12 +00:00			`1. For EE, update the CHANGELOG-EE if it is EE specific fix. Otherwise, merge the stable CE branch and add to CHANGELOG-EE "Merge community edition changes for version X.X.X"`
Use release tools in patch release Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2014-11-11 10:01:47 +00:00
			`### Bump version`

			`Get release tools`

			```
			`git clone git@dev.gitlab.org:gitlab/release-tools.git`
			`cd release-tools`
			```

			`Bump version in stable branch, create release tag and push to remotes:`

			```
			`bundle exec rake release["x.x.x"]`
			```

			`Or if you need to release only EE:`

			```
			`CE=false be rake release['x.x.x']`
			```

			`### Release`

Add patch release document. 2014-04-10 09:23:44 +00:00			`1. Apply the patch to GitLab Cloud and the private GitLab development server`
Update patch release document. 2014-06-04 07:27:23 +00:00			`1. [Build new packages with the latest version](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/release.md)`
Cherry-pick the changelog additions into master. 2014-05-27 12:56:52 +00:00			`1. Cherry-pick the changelog update back into master`
Update patch manual to link to blog post. 2014-10-29 23:24:07 +00:00			`1. Create and publish a blog post`
			1. Send tweets about the release from `@gitlabhq`, tweet should include the most important feature that the release is addressing and link to the blog post
Simplify email procedure now that subscribers are on the newsletter list. 2014-07-21 08:47:38 +00:00			`1. Note in the 'GitLab X.X regressions' issue that the patch was published (CE only)`