Commit f2b2f2c2dc1b2cf02bf9d2b8751bf04060391352
Exists in
spb-stable
and in
3 other branches
Merge branch 'add_patch_release_doc' into 'master'
Add patch release documentation for developers
Showing
2 changed files
with
26 additions
and
7 deletions
Show diff stats
... | ... | @@ -0,0 +1,25 @@ |
1 | +# Things to do when doing a patch release | |
2 | +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). | |
3 | + | |
4 | +## When to do a patch release | |
5 | + | |
6 | +Do a patch release when there is a critical regression that needs to be adresses before the next monthly release. | |
7 | +Otherwise include it in the monthly release and note there was a regression fix in the release announcement. | |
8 | + | |
9 | +## Release Procedure | |
10 | + | |
11 | +1. Verify that the issue can be repoduced | |
12 | +1. Create an issue on private GitLab development server | |
13 | +1. Name the issue "Release X.X.X CE and X.X.X EE", this will make searching easier | |
14 | +1. Fix the issue on a feature branch, do this on the private GitLab development server | |
15 | +1. Consider creating and testing workarounds | |
16 | +1. After the branch is merged into master, cherry pick the commit(s) into the current stable branch | |
17 | +1. In a separate commit in the stable branch, update the VERSION and CHANGELOG | |
18 | +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" | |
19 | +1. Create an annotated tag vX.X.X for CE and another patch release for EE | |
20 | +1. Make sure that the build has passed and no tests are failing | |
21 | +1. Push the code and the tags to all the CE and EE repositories | |
22 | +1. Apply the patch to GitLab Cloud and the private GitLab development server | |
23 | +1. Send tweets about the release from @gitlabhq, tweet should include the most important feature that the release is addressing as well as the link to the changelog | |
24 | +1. Build new packages with the latest version | |
25 | + | ... | ... |
doc/release/security.md
... | ... | @@ -13,14 +13,8 @@ Please report suspected security vulnerabilities in private to support@gitlab.co |
13 | 13 | |
14 | 14 | 1. Verify that the issue can be repoduced |
15 | 15 | 1. Acknowledge the issue to the researcher that disclosed it |
16 | -1. Fix the issue on a feature branch, do this on the private GitLab development server and update the VERSION and CHANGELOG in this branch | |
17 | -1. Consider creating and testing workarounds | |
16 | +1. Do the steps from [patch release document](doc/release/patch.md), starting with "Create an issue on private GitLab development server" | |
18 | 17 | 1. Create feature branches for the blog post on GitLab.com and link them from the code branch |
19 | -1. Merge the code feature branch into master | |
20 | -1. Cherry-pick the code into the latest stable branch | |
21 | -1. Create an annotated tag vX.X.X for CE and another patch release for EE | |
22 | -1. Push the code and the tags to all the CE and EE repositories | |
23 | -1. Apply the patch to GitLab Cloud and the private GitLab development server | |
24 | 18 | 1. Merge and publish the blog posts |
25 | 19 | 1. Send tweets about the release from @gitlabhq |
26 | 20 | 1. Send out an email to the subscribers mailing list on MailChimp | ... | ... |