5.x-rc.md 4.34 KB
Newer Older
totten's avatar
totten committed
1
2
# CiviCRM v5.x.0: Publish a release candidate

3
## Prerequisites
totten's avatar
totten committed
4

5
See [Prerequisites](any-prereq.md)
totten's avatar
totten committed
6
7
8
9
10

## 1: Sanity checks

* Note the original branch, such as `master`.
* Note the intended version, such as `5.1` or `5.3`. (In the rest of this document, we'll refer to `5.X`, but `5.X` should be adjusted to circumstance.)
totten's avatar
totten committed
11
* In `civicrm-core.git` repo, check that the code in `master` correctly references `5.X.alpha1`:
totten's avatar
totten committed
12
13
14
    * https://github.com/civicrm/civicrm-core/blob/master/xml/version.xml
    * https://github.com/civicrm/civicrm-core/blob/master/sql/civicrm_generated.mysql
    * https://github.com/civicrm/civicrm-core/tree/master/CRM/Upgrade/Incremental
totten's avatar
totten committed
15
* In Jenkins, review the scheduled tests for `master` and determine if anything should block the RC.
totten's avatar
totten committed
16
17
    * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
    * https://test.civicrm.org/job/CiviCRM-Ext-Matrix/
totten's avatar
totten committed
18
    * https://test.civicrm.org/job/CiviCRM-E2E-Matrix/
totten's avatar
totten committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

## 2: Bump version number on `master` to `5.X.beta1`

```bash
cd ~/src/master
git checkout master
git pull --ff-only origin master
./tools/bin/scripts/set-version.php 5.X.beta1 --commit
git push origin master
```

## 3: Make a branch

For each git repo, we want to create a new branch for 5.X. This follows a naming convention:

| repo | original branch | new branch |
|------|-----------------|------------|
|civicrm-core|master|5.X|
|civicrm-packages|master|5.X|
|civicrm-backdrop|1.x-master|1.x-5.X|
|civicrm-drupal|6.x-master|6.x-5.X|
|civicrm-drupal|7.x-master|7.x-5.X|
totten's avatar
totten committed
41
|civicrm-drupal-8|master|5.X|
totten's avatar
totten committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|civicrm-joomla|master|5.X|
|civicrm-wordpress|master|5.X|

The commands `git scan branch` and `git scan push` will do this – if you have a copy of each repo.

A safe way to make a clean copy of every repo is to create a new `dist` build (`civibuild create dist`). On `latest.civicrm.org`, there's already a copy in `~/src/master`. Either way, you should make sure it's up-to-date on all relevant branches -- then make new branches:

```bash
## Ensure that you have a clean, up-to-date copy of the `master` branch.
cd ~/src/master
git scan foreach -c 'pwd; git branch; echo'
git scan up
 
## Fixme: for now you need to manually add the extra drupal branches
cd drupal
git checkout 6.x-master && git pull origin 6.x-master
git checkout 8.x-master && git pull origin 8.x-master
git checkout 7.x-master && git pull origin 7.x-master
cd ..
 
## Make branches (preview)
git scan branch 5.X master -p -n -T
 
## Make branches (for real)
git scan branch 5.X master -p
 
## Push the branches (preview)
git scan push -p origin 5.X -n -T
 
## Push the branches (for real)
git scan push -p origin 5.X
```

You might want to spot-check a few URLs to ensure the branches were published, e.g.

totten's avatar
totten committed
77
78
79
80
* https://github.com/civicrm/civicrm-backdrop/tree/1.x-5.X
* https://github.com/civicrm/civicrm-core/tree/5.X
* https://github.com/civicrm/civicrm-drupal/tree/6.x-5.X
* https://github.com/civicrm/civicrm-drupal/tree/7.x-5.X
totten's avatar
totten committed
81
* https://github.com/civicrm/civicrm-drupal-8/tree/5.X
totten's avatar
totten committed
82
83
84
* https://github.com/civicrm/civicrm-joomla/tree/5.X
* https://github.com/civicrm/civicrm-packages/tree/5.X
* https://github.com/civicrm/civicrm-wordpress/tree/5.X
totten's avatar
totten committed
85
86
87

## 4: Setup automated processes

totten's avatar
totten committed
88
89
90
91
* Go to https://test.civicrm.org/job/CiviCRM-Core-Matrix/configure
    * In the list of `CIVIVER`s, remove any old RC's. Add the current RC. (ex: `4.6 5.X master`)
* Go to https://test.civicrm.org/job/CiviCRM-Ext-Matrix/configure
    * In the list of `CIVIVER`s, remove any old RC's. Add the current RC. (ex: `4.6 5.X master`)
totten's avatar
totten committed
92
93
* Go to https://test.civicrm.org/job/CiviCRM-E2E-Matrix/configure
    * In the list of `CIVIVER`s, remove any old RC's. Add the current RC. (ex: `4.6 5.X master`)
94
* Go to https://test.civicrm.org/job/CiviCRM-Publish-Schedule/configure
totten's avatar
totten committed
95
    * In the list of `branchNames`, remove any old RC's. Add the current RC. (ex: `master 4.6 5.X`)
totten's avatar
totten committed
96
97
98
   
## 5: Publish tarballs

totten's avatar
totten committed
99
100
101
102
103
* Go to https://test.civicrm.org/job/CiviCRM-Publish/
* Check to see if the new branch is being built automatically. If not:
    * Login (if you haven't already)
    * Click "Build with parameters"
    * For the branch name, enter your chosen `5.X`.
totten's avatar
totten committed
104

105
## 6: Bump version number on `master` to  `5.Y.alpha1`
totten's avatar
totten committed
106
107
108
109
110
111
112
113
114
115

The original branch, "master", should continue development with the next version, e.g. "5.Y".

```bash
cd ~/src/master
git checkout master
git pull --ff-only origin master
./tools/bin/scripts/set-version.php 5.Y.alpha1 --commit
git push origin master
```