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

168 lines
5.9 KiB
Markdown
Raw Normal View History

# Monthly Release
NOTE: This is a guide for GitLab developers.
2014-05-01 09:05:22 -04:00
# **15th - Code Freeze & Release Manager**
2014-05-01 09:05:22 -04:00
### **1. Stop merging in code, except for important bugfixes**
2014-05-01 09:05:22 -04:00
### **2. Release Manager**
A release manager is selected that coordinates the entire release of this version. 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.
2014-05-01 09:05:22 -04:00
# **18th - Releasing RC1**
The RC1 release comes with the task to update the installation and upgrade docs. Be mindful that there might already be merge requests for this on GitLab or GitHub.
2014-05-01 09:05:22 -04:00
### **1. Create an issue for RC1 release**
2014-05-01 09:05:22 -04:00
### **2. Update the installation guide**
1. Check if it references the correct branch `x-x-stable` (doesn't exist yet, but that is okay)
2. Check the [GitLab Shell version](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/tasks/gitlab/check.rake#L782)
3. Check the [Git version](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/tasks/gitlab/check.rake#L794)
4. There might be other changes. Ask around.
2013-05-27 03:21:01 -04:00
2014-05-01 09:05:22 -04:00
### **3. Create an update guide**
2013-05-27 03:21:01 -04:00
It's best to copy paste the previous guide and make changes where necessary. The typical steps are listed below with any points you should specifically look at.
2013-05-27 03:21:01 -04:00
#### 0. Any major changes?
List any major changes here, so the user is aware of them before starting to upgrade. For instance:
- Database updates
- Web server changes
- File structure changes
2013-05-27 03:21:01 -04:00
#### 1. Make backup
#### 2. Stop server
#### 3. Do users need to update dependencies like `git`?
- Check if the [GitLab Shell version](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/tasks/gitlab/check.rake#L782) changed since the last release.
- Check if the [Git version](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/tasks/gitlab/check.rake#L794) changed since the last release.
2013-05-27 03:21:01 -04:00
#### 4. Get latest code
#### 5. Does GitLab shell need to be updated?
#### 6. Install libs, migrations, etc.
#### 7. Any config files updated since last release?
Check if any of these changed since last release:
2013-05-27 03:21:01 -04:00
2013-12-30 08:27:18 -05:00
* https://gitlab.com/gitlab-org/gitlab-ce/commits/master/lib/support/nginx/gitlab
* https://gitlab.com/gitlab-org/gitlab-shell/commits/master/config.yml.example
* https://gitlab.com/gitlab-org/gitlab-ce/commits/master/config/gitlab.yml.example
* https://gitlab.com/gitlab-org/gitlab-ce/commits/master/config/unicorn.rb.example
* https://gitlab.com/gitlab-org/gitlab-ce/commits/master/config/database.yml.mysql
* https://gitlab.com/gitlab-org/gitlab-ce/commits/master/config/database.yml.postgresql
2013-05-27 03:21:01 -04:00
#### 8. Need to update init script?
Check if the init.d/gitlab script changed since last release: https://gitlab.com/gitlab-org/gitlab-ce/commits/master/lib/support/init.d/gitlab
2013-05-27 03:21:01 -04:00
#### 9. Start application
#### 10. Check application status
2014-05-01 09:05:22 -04:00
### **4. Code quality indicatiors**
Make sure the code quality indicators are green / good.
2013-05-27 03:21:01 -04:00
* [![build status](http://ci.gitlab.org/projects/1/status.png?ref=master)](http://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) on travis-ci.org (master branch)
* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq) this button can be yellow (small updates are available) but must not be red (a security fix or an important update is available)
* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)
2014-05-01 09:05:22 -04:00
### **5. Set VERSION**
Set VERSION tot x.x.0.rc1
2014-05-01 09:05:22 -04:00
### **6. Tag**
Create an annotated tag that points to the version change commit.
```
git tag -a vx.x.0.rc1 -m 'Version x.x.0.rc1'
```
2014-05-01 09:05:22 -04:00
### **7. Tweet**
Tweet about the RC release:
> GitLab x.x.x.rc1 is out. This is a release candidate intended for testing only. Please let us know if you find regressions.
2014-05-01 09:05:22 -04:00
### **8. Update Cloud**
Merge the RC1 code into Cloud. Once the build is green, deploy in the morning.
It is important to do this as soon as possible, so we can catch any errors before we release the full version.
# **22nd - Release CE and EE**
For GitLab EE, append -ee to the branches and tags.
`x-x-stable-ee`
`v.x.x.0-ee`
2014-05-01 09:05:22 -04:00
### **1. Create x-x-stable branch and push to the repositories**
2014-05-01 09:05:22 -04:00
```
git checkout master
git pull
git checkout -b x-x-stable
git push <remote> x-x-stable
```
### **2. Build the Omnibus packages**
[Follow this guide](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/release.md)
### **3. QA**
Use the omnibus packages to test using [this guide](https://dev.gitlab.org/gitlab/gitlab-ee/blob/master/doc/release/manual_testing.md)
2014-05-01 09:05:22 -04:00
### **4. Fix anything coming out of the QA**
### **5. Set VERSION to x.x.0**
### **6. Create annotated tag vx.x.0**
```
git tag -a vx.x.0 -m 'Version x.x.0'
```
### **7. Push VERSION + Tag to master, merge into x-x-stable**
```
git push origin master
```
Next, merge the VERSION into the x-x-stable branch.
### **8. Push to remotes**
For GitLab CE, push to dev, GitLab.com and GitHub.
For GitLab EE, push to the subscribers repo.
NOTE: You might not have the rights to push to master on dev. Ask Dmitriy.
### **9. Publish blog for new release**
* Mention what GitLab is on the second line: GitLab is open source software to collaborate on code.
* Select and thank the the Most Valuable Person (MVP) of this release.
* 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.
### **10. Tweet to blog**
Send out a tweet to share the good news with the world. List the features in short and link to the blog post.
2014-05-05 02:09:46 -04:00
# **23rd - Optional Patch Release**
# **25th - Release GitLab CI**