Finalise the Gerrit v3.6.0 release notes
Add links to the Gerrit v3.6.0 as the lastest release
and clarify the upgrade path from v3.5.2, including the
offline and online upgrade options.
Tidy up remaining formatting issues with notes.
Change-Id: I819566e7e12a1363f994e0474c9ba0aa52ce91de
diff --git a/_data/topnav.yml b/_data/topnav.yml
index 301f59b..b3c6cd4 100644
--- a/_data/topnav.yml
+++ b/_data/topnav.yml
@@ -20,7 +20,7 @@
- title: Members
url: /members.html
- title: Contributing
- external_url: https://gerrit-documentation.storage.googleapis.com/Documentation/3.5.1/dev-community.html#how-to-contribute
+ external_url: https://gerrit-documentation.storage.googleapis.com/Documentation/3.6.0/dev-community.html#how-to-contribute
- title: Fixing a bug
url: /bug-fixing.html
- title: Presentations
@@ -48,7 +48,7 @@
- title: Docs
folderitems:
- title: Latest
- external_url: https://gerrit-documentation.storage.googleapis.com/Documentation/3.5.1/index.html
+ external_url: https://gerrit-documentation.storage.googleapis.com/Documentation/3.6.0/index.html
- title: Designs
url: /design-docs-index.html
- title: Wiki
diff --git a/index.md b/index.md
index d85db6e..47e88ea 100644
--- a/index.md
+++ b/index.md
@@ -68,9 +68,9 @@
<div class="panel-body">
<h4>Download</h4>
<p>Our latest release is:<br>
- <b><a href="3.5.html">3.5.1</a></b>
+ <b><a href="3.6.html">3.6.0</a></b>
</p>
- <a href="https://gerrit-releases.storage.googleapis.com/gerrit-3.5.1.war" class="btn btn-primary">Download</a>
+ <a href="https://gerrit-releases.storage.googleapis.com/gerrit-3.6.0.war" class="btn btn-primary">Download</a>
</div>
</div>
</div>
@@ -113,16 +113,16 @@
</tr>
</table>
-Schedule [git gc](https://gerrit-documentation.storage.googleapis.com/Documentation/3.5.1/config-gerrit.html#gc)
+Schedule [git gc](https://gerrit-documentation.storage.googleapis.com/Documentation/3.6.0/config-gerrit.html#gc)
over all managed repositories and
-[replicate](https://gerrit.googlesource.com/plugins/replication/+doc/v3.5.1/src/main/resources/Documentation/config.md)
+[replicate](https://gerrit.googlesource.com/plugins/replication/+doc/v3.6.0/src/main/resources/Documentation/config.md)
to geographical mirrors for latency reduction and backup servers for hot
spare redundancy.
## Extensible through plugins
Gerrit Code Review can be extended and further customized by installing
-[server-side plugins](https://gerrit-documentation.storage.googleapis.com/Documentation/3.5.1/config-plugins.html).
+[server-side plugins](https://gerrit-documentation.storage.googleapis.com/Documentation/3.6.0/config-plugins.html).
Source code for additional plugins can be found through the
[project listing](https://gerrit.googlesource.com/plugins/).
diff --git a/pages/site/releases/3.6.md b/pages/site/releases/3.6.md
index 5f479c4..b717492 100644
--- a/pages/site/releases/3.6.md
+++ b/pages/site/releases/3.6.md
@@ -1,12 +1,12 @@
---
-title: "Gerrit 3.6.0 (in development)"
+title: "Gerrit 3.6.0"
permalink: 3.6.html
hide_sidebar: true
hide_navtoggle: true
toc: true
---
-Download: **[3.6.0-rc5](https://gerrit-releases.storage.googleapis.com/gerrit-3.6.0-rc5.war)**
+Download: **[3.6.0](https://gerrit-releases.storage.googleapis.com/gerrit-3.6.0.war)**
Documentation: **[3.6.0](https://gerrit-documentation.storage.googleapis.com/Documentation/3.6.0/index.html)**
@@ -39,9 +39,9 @@
- `message` predicate to support regular expression on the commit message as a
condition.
-*NOTE*: With the new submit requirements, submit records are no longer emitted.
-This means that any queries with the label formats (`label:Code-Review=NEED` or `label:Code-Review=OK`) will
-no longer match with changes. See more details in [Change 330203](https://gerrit-review.googlesource.com/330203).
+> **NOTE**: With the new submit requirements, submit records are no longer emitted.
+> This means that any queries with the label formats (`label:Code-Review=NEED` or `label:Code-Review=OK`) will
+> no longer match with changes. See more details in [Change 330203](https://gerrit-review.googlesource.com/330203).
## Important notes
@@ -56,25 +56,41 @@
- [Change 323897](https://gerrit-review.googlesource.com/c/gerrit/+/323897):
The review score is only read from the latest patch-set
-> NOTE: Because of the above incompatibilities, it isn't currently possible to upgrade
-> to Gerrit v3.6.0 and preserve the same scoring on changes as it was displayed on the
-> UI on earlier releases. A new Gerrit v3.5.2 is going to be released which will include
-> some backward compatibility fix for mitigating the issues.
+> NOTE: Because of the above incompatibilities, upgrade is supported only from
+> Gerrit v3.5.2 onwards, because of the need of the extra `copy-approvals` tool
+> and the backward compatibility fix on UUID suffixed labels.
+> Failing to run the `copy-approvals` tool in v3.5.2 would leave the changes
+> with a potentially stale approval score once the site is migrated to v3.6.
The `changes` index version has been increased to version 77. By default the
index is automatically rebuilt upon the Gerrit startup after the
upgrade.
-To run offline reindexing of the changes (optional when upgrading from v3.2.x
-or later):
+### Offline upgrade
+
+Upgrade to [Gerrit v3.5.2](../3.5.html#352) or later and make sure that the `copy-approvals`
+site program has been run at least once.
+
+```sh
+ java -jar gerrit.war copy-approvals -d site_path
+```
+
+Download the [Gerrit v3.6.0 war](https://gerrit-releases.storage.googleapis.com/gerrit-3.6.0.war) and
+run the `init` program:
+
+```sh
+ java -jar gerrit-3.6.0.war init -d site_path
+```
+
+Run offline reindexing of the changes:
```sh
java -jar gerrit.war reindex --index changes -d site_path
```
-### Zero-downtime upgrade
+### Online upgrade with zero-downtime
-Gerrit v3.6.x supports zero-downtime upgrade from Gerrit v3.2.x or later when
+Gerrit v3.6.x supports zero-downtime upgrade from Gerrit v3.5.2 or later when
configured using a [high-availability configuration](https://gerrit.googlesource.com/plugins/high-availability/+/refs/heads/master/README.md),
and the Git repositories are stored in a shared filesystem such as NFS or
similar.
@@ -85,15 +101,17 @@
The zero-downtime upgrade consists of the following steps:
-1. Have Gerrit servers running v3.2.x or later, in high-availability
+1. Have Gerrit servers running v3.5.2 or later, in high-availability
configuration, healthy and able to handle the incoming traffic properly.
-2. Set the Gerrit server unhealthy.
-3. Shutdown the Gerrit server, update gerrit.war and plugins to v3.6.x and start
+2. Run the `copy-approvals` SSH command against one of the Gerrit servers
+ and wait for completion on all changes for all projects.
+3. Set the Gerrit server unhealthy.
+4. Shutdown the Gerrit server, update gerrit.war and plugins to v3.6.x and start
Gerrit again.
-4. Verify that the Gerrit server is working properly (e.g. run automated smoke
+5. Verify that the Gerrit server is working properly (e.g. run automated smoke
tests) and then make it healthy again.
-5. Wait for the Gerrit server to start serving traffic normally.
-6. Repeat steps 2. to 5. for all the other Gerrit servers.
+6. Wait for the Gerrit server to start serving traffic normally.
+7. Repeat steps 3. to 6. for all the other Gerrit servers.
### Breaking changes
