BigW Consortium Gitlab

monthly.md 9.89 KB
Newer Older
1
# Monthly Release
2

3 4
NOTE: This is a guide used by the GitLab the company to release GitLab.
As an end user you do not need to use this guide.
5

6
The process starts 7 working days before the release.
7 8 9
The release manager doesn't have to perform all the work but must ensure someone is assigned.
The current release manager must schedule the appointment of the next release manager.
The new release manager should create overall issue to track the progress.
10
The release manager should be the only person pushing/merging commits to the x-y-stable branches.
11

12
## Release Manager
13

14 15
A release manager is selected that coordinates all releases the coming month,
including the patch releases for previous releases.
16 17
The release manager has to make sure all the steps below are done and delegated where necessary.
This person should also make sure this document is kept up to date and issues are created and updated.
18

19
## Take vacations into account
20

21
The time is measured in weekdays to compensate for weekends.
22 23 24
Do everything on time to prevent problems due to rush jobs or too little testing time.
Make sure that you take into account any vacations of maintainers.
If the release is falling behind immediately warn the team.
25 26

## Create an overall issue and follow it
Valery Sizov committed
27

28
Create issue for GitLab CE project(internal). Name it "Release x.x.x" for easier searching.
29
Replace the dates with actual dates based on the number of workdays before the release.
30
All steps from issue template are explained below
31 32

```
33
Xth: (7 working days before the 22nd)
34

35
- [ ] Triage the omnibus-gitlab milestone
36

37
Xth: (6 working days before the 22nd)
38

39
- [ ] Merge CE master in to EE master via merge request (#LINK)
40
- [ ] Determine QA person and notify this person
41
- [ ] Check the tasks in [how to rc1 guide](https://dev.gitlab.org/gitlab/gitlabhq/blob/master/doc/release/howto_rc1.md) and delegate tasks if necessary
42
- [ ] Create CE, EE, CI RC1 versions (#LINK)
43
- [ ] Build RC1 packages (EE first) (#LINK)
44

45
Xth: (5 working days before the 22nd)
46

47
- [ ] Do QA and fix anything coming out of it (#LINK)
48
- [ ] Close the omnibus-gitlab milestone
49
- [ ] Prepare the blog post (#LINK)
50

51
Xth: (4 working days before the 22nd)
52

53
- [ ] Update GitLab.com with rc1 (#LINK) (https://dev.gitlab.org/cookbooks/chef-repo/blob/master/doc/administration.md#deploy-the-package)
54
- [ ] Update ci.gitLab.com with rc1 (#LINK) (https://dev.gitlab.org/cookbooks/chef-repo/blob/master/doc/administration.md#deploy-the-package)
55
- [ ] Create regression issues (CE, CI) (#LINK)
56 57 58
- [ ] Tweet about rc1 (#LINK), proposed text: 

> GitLab x.x.0.rc1 is available https://packages.gitlab.com/gitlab/unstable Use at your own risk. Please link regressions issues from LINK_TO_REGRESSION_ISSUE
59

60
Xth: (3 working days before the 22nd)
61

62
- [ ] Merge CE stable branch into EE stable branch
63

64
Xth: (2 working days before the 22nd)
65

Jacob Vosmaer committed
66
- [ ] Check that everyone is mentioned on the blog post using `@all` (the reviewer should have done this one working day ago)
67
- [ ] Check that MVP is added to the mvp page (source/mvp/index.html in www-gitlab-com)
68

69
Xth: (1 working day before the 22nd)
70

71
- [ ] Merge CE stable into EE stable
72
- [ ] Create CE, EE, CI release candidates (#LINK) (hopefully final ones with the same commit as the release tomorrow) 
73 74 75
- [ ] Create Omnibus tags and build packages for the latest release candidates
- [ ] Update GitLab.com with the latest RC (#LINK)
- [ ] Update ci.gitLab.com with the latest RC (#LINK)
76

77
22nd before 1200 CET:
78

79
Release before 1200 CET / 2AM PST, to make sure the majority of our users
80 81
get the new version on the 22nd and there is sufficient time in the European
workday to quickly fix any issues.
82

83 84
- [ ] Merge CE stable into EE stable (#LINK)
- [ ] Create the 'x.y.0' tag with the [release tools](https://dev.gitlab.org/gitlab/release-tools) (#LINK)
Valery Sizov committed
85
- [ ] Create the 'x.y.0' version on version.gitlab.com
86 87
- [ ] Try to do before 1100 CET: Create and push omnibus tags for x.y.0 (will auto-release the packages) (#LINK)
- [ ] Try to do before 1200 CET: Publish the release blog post (#LINK)
88
- [ ] Tweet about the release (blog post) (#LINK)
89
- [ ] Schedule a second tweet of the release announcement with the same text at 1800 CET / 8AM PST
90 91
```

92
- - -
93

94
## Update changelog
95

96 97
Any changes not yet added to the changelog are added by lead developer and in that merge request the complete team is
asked if there is anything missing.
98

99
There are three changelogs that need to be updated: CE, EE and CI.
100

101
## Create RC1 (CE, EE, CI)
102

103
[Follow this How-to guide](howto_rc1.md) to create RC1.
Valery Sizov committed
104

105 106
## Prepare CHANGELOG for next release

107
Once the stable branches have been created, update the CHANGELOG in `master` with the upcoming version, usually X.X.X.pre.
108

109 110
On creating the stable branches, notify the core team and developers.

111 112 113 114
## QA

Create issue on dev.gitlab.org `gitlab` repository, named "GitLab X.X QA" in order to keep track of the progress.

115
Use the omnibus packages created for RC1 of Enterprise Edition using [this guide](https://dev.gitlab.org/gitlab/gitlab-ee/blob/master/doc/release/manual_testing.md).
116 117 118 119 120 121 122 123 124 125

**NOTE** Upgrader can only be tested when tags are pushed to all repositories. Do not forget to confirm it is working before releasing. Note that in the issue.

#### Fix anything coming out of the QA

Create an issue with description of a problem, if it is quick fix fix it yourself otherwise contact the team for advice.

**NOTE** If there is a problem that cannot be fixed in a timely manner, reverting the feature is an option! If the feature is reverted,
create an issue about it in order to discuss the next steps after the release.

126
## Update GitLab.com with RC1
127

128
Use the omnibus EE packages created for RC1.
129
If there are big database migrations consider testing them with the production db on a VM.
130
Try to deploy in the morning.
131 132
It is important to do this as soon as possible, so we can catch any errors before we release the full version.

133
## Create a regressions issue
134 135 136 137 138 139 140 141

On [the GitLab CE issue tracker on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/issues/) create an issue titled "GitLab X.X regressions" add the following text:

This is a meta issue to discuss possible regressions in this monthly release and any patch versions.
Please do not raise issues directly in this issue but link to issues that might warrant a patch release.
The decision to create a patch release or not is with the release manager who is assigned to this issue.
The release manager will comment here about the plans for patch releases.

142
Assign the issue to the release manager and at mention all members of gitlab core team. If there are any known bugs in the release add them immediately.
143

144
## Tweet about RC1
145 146 147

Tweet about the RC release:

Sytse Sijbrandij committed
148
> GitLab x.x.0.rc1 is out. This release candidate is only suitable for testing. Please link regressions issues from LINK_TO_REGRESSION_ISSUE
149

150
## Prepare the blog post
151

152 153
1. The blog post template for this release should already exist and might have comments that were added during the month.
1. Fill out as much of the blog post template as you can.
154 155 156 157 158
1. Make sure the blog post contains information about the GitLab CI release.
1. Check the changelog of CE and EE for important changes.
1. Also check the CI changelog
1. Add a proposed tweet text to the blog post WIP MR description.
1. Create a WIP MR for the blog post
159
1. Make sure merge request title starts with `WIP` so it can not be accidently merged until ready.
160 161
1. Ask Dmitriy (or a team member with OS X) to add screenshots to the WIP MR.
1. Decide with core team who will be the MVP user.
162 163 164 165 166
1. Create WIP MR for adding MVP to MVP page on website
1. Add a note if there are security fixes: This release fixes an important security issue and we advise everyone to upgrade as soon as possible.
1. Create a merge request on [GitLab.com](https://gitlab.com/gitlab-com/www-gitlab-com/tree/master)
1. Assign to one reviewer who will fix spelling issues by editing the branch (either with a git client or by using the online editor)
1. Comment to the reviewer: '@person Please mention the whole team as soon as you are done (3 workdays before release at the latest)'
167
1. Create a new merge request with complete copy of the [release blog template](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/doc/release_blog_template.md) for the next release using the branch name `release-x-x-x`.
168

169
## Create CE, EE, CI stable versions
170

171
Get release tools
172

173
```
174 175
git clone git@dev.gitlab.org:gitlab/release-tools.git
cd release-tools
176 177
```

178
Bump version, create release tag and push to remotes:
179 180

```
181
bundle exec rake release["x.x.0"]
182 183
```

184
This will create correct version and tag and push to all CE, EE and CI remotes.
185

186
Update [installation.md](/doc/install/installation.md) to the newest version in master.
187 188


189
## Create Omnibus tags and build packages
190 191 192

Follow the [release doc in the Omnibus repository](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/release.md).
This can happen before tagging because Omnibus uses tags in its own repo and SHA1's to refer to the GitLab codebase.
Jacob Vosmaer committed
193

194 195 196
## Update GitLab.com with the stable version

- Deploy the package (should not need downtime because of the small difference with RC1)
197
- Deploy the package for gitlab.com/ci
198

199
## Release CE, EE and CI
200

201
__1. Publish packages for new release__
202 203 204

Update `downloads/index.html` and `downloads/archive/index.html` in `www-gitlab-com` repository.

205
__2. Publish blog for new release__
206

207
Doublecheck the everyone has been mentioned in the blog post.
208 209
Merge the [blog merge request](#1-prepare-the-blog-post) in `www-gitlab-com` repository.

210
__3. Tweet to blog__
211

Sytse Sijbrandij committed
212 213
Send out a tweet to share the good news with the world.
List the most important features and link to the blog post.
214

215
Proposed tweet "Release of GitLab X.X & CI Y.Y! FEATURE, FEATURE and FEATURE <link-to-blog-post> #gitlab"
216 217

Consider creating a post on Hacker News.
218

219 220 221
## Release new AMIs

[Follow this guide](https://dev.gitlab.org/gitlab/AMI/blob/master/README.md)
222 223 224

## Create a WIP blogpost for the next release

225
Create a WIP blogpost using [release blog template](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/doc/release_blog_template.md).