Commit 2a8aa7429b6f489acd07c99e2e33a09c21c2ba01
Exists in
spb-stable
and in
2 other branches
Merge branch 'monthly_doc_update' into 'master'
Monthly release doc update
Showing
1 changed file
with
62 additions
and
19 deletions
Show diff stats
doc/release/monthly.md
... | ... | @@ -15,6 +15,8 @@ The RC1 release comes with the task to update the installation and upgrade docs. |
15 | 15 | |
16 | 16 | ### **1. Create an issue for RC1 release** |
17 | 17 | |
18 | +Consider naming the issue "Release x.x.x.rc1" to make it easier for later searches. | |
19 | + | |
18 | 20 | ### **2. Update the installation guide** |
19 | 21 | |
20 | 22 | 1. Check if it references the correct branch `x-x-stable` (doesn't exist yet, but that is okay) |
... | ... | @@ -82,7 +84,7 @@ Make sure the code quality indicators are green / good. |
82 | 84 | |
83 | 85 | ### **5. Set VERSION** |
84 | 86 | |
85 | -Set VERSION tot x.x.0.rc1 | |
87 | +Change version in VERSION to x.x.0.rc1 | |
86 | 88 | |
87 | 89 | |
88 | 90 | ### **6. Tag** |
... | ... | @@ -98,12 +100,34 @@ Tweet about the RC release: |
98 | 100 | |
99 | 101 | > GitLab x.x.x.rc1 is out. This is a release candidate intended for testing only. Please let us know if you find regressions. |
100 | 102 | |
101 | -### **8. Update Cloud** | |
103 | +### **8. Update GitLab.com** | |
102 | 104 | |
103 | -Merge the RC1 code into Cloud. Once the build is green, deploy in the morning. | |
105 | +Merge the RC1 code into GitLab.com. Once the build is green, deploy in the morning. | |
104 | 106 | |
105 | 107 | It is important to do this as soon as possible, so we can catch any errors before we release the full version. |
106 | 108 | |
109 | +# **21st - Preparation ** | |
110 | + | |
111 | +### **1. Prepare the blog post** | |
112 | + | |
113 | +* Check the changelog of CE and EE for important changes. Based on [release blog template](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/doc/release_blog_template.md) fill in the important information. | |
114 | +* Create a WIP MR for the blog post and cc the team so everyone can give feedback. | |
115 | +* Ask Dmitriy to add screenshots to the WIP MR. | |
116 | +* Decide with team who will be the MVP user. | |
117 | +* 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. | |
118 | + | |
119 | +### **2. Q&A** | |
120 | + | |
121 | +Create issue on dev.gitlab.org gitlab repository, named "GitLab X.X release" in order to keep track of the progress. | |
122 | + | |
123 | +Use the omnibus packages or cookbook to test using [this guide](https://dev.gitlab.org/gitlab/gitlab-ee/blob/master/doc/release/manual_testing.md). | |
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. | |
126 | + | |
127 | + | |
128 | +### **3. Fix anything coming out of the QA** | |
129 | + | |
130 | +Create an issue with description of a problem, if it is quick fix fix yourself otherwise contact the team for advice. | |
107 | 131 | |
108 | 132 | # **22nd - Release CE and EE** |
109 | 133 | |
... | ... | @@ -125,27 +149,31 @@ git push <remote> x-x-stable |
125 | 149 | ### **2. Build the Omnibus packages** |
126 | 150 | [Follow this guide](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/release.md) |
127 | 151 | |
128 | -### **3. QA** | |
129 | -Use the omnibus packages to test using [this guide](https://dev.gitlab.org/gitlab/gitlab-ee/blob/master/doc/release/manual_testing.md) | |
152 | +### **3. Set VERSION to x.x.x and push** | |
153 | + | |
154 | +Change the VERSION file in `master` branch of the CE repository and commit. | |
155 | +Cherry-pick into the `x-x-stable` branch of CE. | |
130 | 156 | |
157 | +Change the VERSION file in `master branch of the EE repository and commit. | |
158 | +Cherry-pick into the `x-x-stable-ee` branch of EE. | |
131 | 159 | |
132 | -### **4. Fix anything coming out of the QA** | |
160 | +### **4. Create annotated tag vx.x.x** | |
133 | 161 | |
134 | -### **5. Set VERSION to x.x.0** | |
162 | +In `x-x-stable` branch check for the sha1 of the commit with VERSION file changed. Tag that commit, | |
135 | 163 | |
136 | -### **6. Create annotated tag vx.x.0** | |
137 | 164 | ``` |
138 | -git tag -a vx.x.0 -m 'Version x.x.0' | |
165 | +git tag -a vx.x.0 -m 'Version x.x.0' xxxxx | |
139 | 166 | ``` |
140 | 167 | |
141 | -### **7. Push VERSION + Tag to master, merge into x-x-stable** | |
168 | +where `xxxxx` is sha1. | |
169 | + | |
170 | +### **5. Push the tag** | |
171 | + | |
142 | 172 | ``` |
143 | -git push origin master | |
173 | +git push origin vx.x.0 | |
144 | 174 | ``` |
145 | 175 | |
146 | -Next, merge the VERSION into the x-x-stable branch. | |
147 | - | |
148 | -### **8. Push to remotes** | |
176 | +### **6. Push to remotes** | |
149 | 177 | |
150 | 178 | For GitLab CE, push to dev, GitLab.com and GitHub. |
151 | 179 | |
... | ... | @@ -153,15 +181,30 @@ For GitLab EE, push to the subscribers repo. |
153 | 181 | |
154 | 182 | NOTE: You might not have the rights to push to master on dev. Ask Dmitriy. |
155 | 183 | |
156 | -### **9. Publish blog for new release** | |
157 | -* Mention what GitLab is on the second line: GitLab is open source software to collaborate on code. | |
158 | -* Select and thank the the Most Valuable Person (MVP) of this release. | |
159 | -* 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. | |
184 | +### **7. Publish blog for new release** | |
160 | 185 | |
161 | -### **10. Tweet to blog** | |
186 | +Merge the [blog merge request](#1-prepare-the-blog-post) in `www-gitlab-com` repository. | |
187 | + | |
188 | +### **8. Tweet to blog** | |
162 | 189 | |
163 | 190 | Send out a tweet to share the good news with the world. List the features in short and link to the blog post. |
164 | 191 | |
192 | +Proposed tweet for CE "GitLab X.X.X CE is released! It brings *** <link-to-blogpost>" | |
193 | + | |
194 | +Proposed tweet for EE "GitLab X.X.X EE is released! It brings *** <link-to-blogpost>" | |
195 | + | |
196 | +### **9. Send out newsletter** | |
197 | + | |
198 | +In mailchimp replicate the former release newsletters to customers / newsletter subscribers (these are two separate things) and modify them accordingly. | |
199 | + | |
200 | +Include a link to the blog post and keep it short. | |
201 | + | |
202 | +Proposed email for CE: "We have released a new version of GitLab Community Edition and its packages. See our blog post(<link>) for more information." | |
203 | + | |
165 | 204 | # **23rd - Optional Patch Release** |
166 | 205 | |
206 | +# **24th - Update GitLab.com** | |
207 | + | |
208 | +Merge the stable release into GitLab.com. Once the build is green deploy the next morning. | |
209 | + | |
167 | 210 | # **25th - Release GitLab CI** | ... | ... |