Commit aedb486d authored by totten's avatar totten
Browse files

Update 5.x-patch.md

parent 9d607bec
...@@ -4,28 +4,58 @@ ...@@ -4,28 +4,58 @@
See [Prerequisites](any-prereq.md) See [Prerequisites](any-prereq.md)
## 1: (If you haven't already) Set the final version to `5.X.Y` ## 1A: Repo updates (PR flow; typical)
Prepare patches for the `5.X` branch via PR.
In tandem with the PRs, prepare the [draft release notes](https://docs.google.com/spreadsheets/d/1uJAiVf0IsBfY5PUarKTeztC8z6qMmtFnfLk8Gd4cJbQ/edit?usp=sharing).
After all the substantive PRs have been merged, prepare a new PR to bump-up the version number and copy-in the release-notes:
```bash ```bash
cd ~/src/master cd ~/src/master
git checkout 5.X git checkout origin/5.X -b 5.X-bumpY
git pull --ff-only origin 5.X
# Set the final version to `5.X.Y`
cat xml/version.xml
./tools/bin/scripts/set-version.php 5.X.Y --commit ./tools/bin/scripts/set-version.php 5.X.Y --commit
git push origin 5.X
# Add the release notes
vi release-notes.md release-notes/5.X.Y.md
git add release-notes.md release-notes/5.X.Y.md
git commit
``` ```
## 2: (If you haven't already) Backport patches to `5.X` branch Submit `5.X-bumpY` as a new PR.
Use the Github GUI for final copy-editing of the notes.
e.g. ## 1B: Repo updates (Abridged flow)
Plan the patchset and [generate release notes](https://docs.google.com/spreadsheets/d/1uJAiVf0IsBfY5PUarKTeztC8z6qMmtFnfLk8Gd4cJbQ/edit?usp=sharing). Then update the corresponding `5.X` branch:
```bash ```bash
cd ~/src/master cd ~/src/master
git checkout 5.X git checkout 5.X
# Cherry-pick any patches
git cherry-pick abcd1234abcd1234 git cherry-pick abcd1234abcd1234
git push origin 5.X git push origin 5.X
# Set the final version to `5.X.Y`
cat xml/version.xml
./tools/bin/scripts/set-version.php 5.X.Y --commit
# Add the release notes
vi release-notes.md release-notes/5.X.Y.md
git add release-notes.md release-notes/5.X.Y.md
git commit
# Push
git push origin 5.X
``` ```
## 3: Sanity checks ## 2: Sanity checks
* Check open PRs for `5.X`: https://github.com/civicrm/civicrm-core/pulls * Check open PRs for `5.X`: https://github.com/civicrm/civicrm-core/pulls
* Check release notes: https://github.com/civicrm/civicrm-core/blob/5.X/release-notes.md * Check release notes: https://github.com/civicrm/civicrm-core/blob/5.X/release-notes.md
...@@ -37,7 +67,7 @@ git push origin 5.X ...@@ -37,7 +67,7 @@ git push origin 5.X
* Current git repos: `civi-git-table --fetch 5.X.Y 5.X` * Current git repos: `civi-git-table --fetch 5.X.Y 5.X`
* Draft tarball: https://download.civicrm.org/latest/branch/5.X/LATEST/civicrm-X.Y.Z-drupal-LATEST.tar.gz/inspect * Draft tarball: https://download.civicrm.org/latest/branch/5.X/LATEST/civicrm-X.Y.Z-drupal-LATEST.tar.gz/inspect
## 4: Prepare and identify the final tarballs ## 3: Prepare and identify the final tarballs
In Jenkins, ensure that the final tarballs have been prepared. Run the job manually if you're impatient. In Jenkins, ensure that the final tarballs have been prepared. Run the job manually if you're impatient.
...@@ -51,7 +81,7 @@ gsutil ls gs://civicrm-build/5.2/*json ...@@ -51,7 +81,7 @@ gsutil ls gs://civicrm-build/5.2/*json
For example, we might pick `gs://civicrm-build/5.2/civicrm-5.2.1-201705030600.json`. For example, we might pick `gs://civicrm-build/5.2/civicrm-5.2.1-201705030600.json`.
## 5: Publish ## 4: Publish
You can do the full process in one command: You can do the full process in one command:
...@@ -90,7 +120,7 @@ To ensure the various tags were published and match the branches, use `civi-git- ...@@ -90,7 +120,7 @@ To ensure the various tags were published and match the branches, use `civi-git-
civi-git-table --fetch 5.16.0 5.16.1 5.16 civi-git-table --fetch 5.16.0 5.16.1 5.16
``` ```
## 6: Update `versions.json` ## 5: Update `versions.json`
Services such as the `civicrm.org` download page and the in-app version Services such as the `civicrm.org` download page and the in-app version
check depend on a file named `versions.json`. Update this. check depend on a file named `versions.json`. Update this.
...@@ -125,7 +155,7 @@ And ...@@ -125,7 +155,7 @@ And
popd popd
``` ```
## 7: Make new versions visible on download sites ## 6: Make new versions visible on download sites
Log into https://civicrm.org/user and clear the page-cache in https://civicrm.org/admin/config/development/performance Log into https://civicrm.org/user and clear the page-cache in https://civicrm.org/admin/config/development/performance
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment