Use the new section title style in Asciidoctor.
We previous use the section title style like:
Section level 1
===============
Section level 2
---------------
Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:
= Section level 1
== Section level 2
So we switched to this style.
Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.
Change-Id: I811dd7238735d98f662767c17086152cd69aea02
diff --git a/Documentation/dev-release.txt b/Documentation/dev-release.txt
index ba52865..72247cf 100644
--- a/Documentation/dev-release.txt
+++ b/Documentation/dev-release.txt
@@ -1,5 +1,4 @@
-Making a Gerrit Release
-=======================
+= Making a Gerrit Release
[NOTE]
========================================================================
@@ -16,16 +15,14 @@
tasks.
-Gerrit Release Type
--------------------
+== Gerrit Release Type
Here are some guidelines on release approaches depending on the
type of release you want to make (`stable-fix`, `stable`, `RC0`,
`RC1`...).
[[stable]]
-Stable
-~~~~~~
+=== Stable
A `stable` release is generally built from the `master` branch and may
need to undergo some stabilization before releasing the final release.
@@ -51,8 +48,7 @@
* Finally create the `stable` release (no `RC`)
-Stable-Fix
-~~~~~~~~~~
+=== Stable-Fix
`stable-fix` releases should likely only contain bug fixes and doc
updates.
@@ -64,8 +60,7 @@
[[security]]
-Security-Fix
-~~~~~~~~~~~~
+=== Security-Fix
`security-fix` releases should only contain bug fixes for security
issues.
@@ -82,8 +77,7 @@
`gerrit` project.
-Create the Actual Release
--------------------------
+== Create the Actual Release
To create a Gerrit release the following steps have to be done:
@@ -102,8 +96,7 @@
[[subproject]]
-Release Subprojects
-~~~~~~~~~~~~~~~~~~~
+=== Release Subprojects
The subprojects to be released are:
@@ -128,8 +121,7 @@
[[build-gerrit]]
-Build Gerrit
-~~~~~~~~~~~~
+=== Build Gerrit
* Build the Gerrit WAR and API JARs
+
@@ -142,13 +134,11 @@
* Test the new Gerrit version
[[publish-gerrit]]
-Publish the Gerrit Release
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Publish the Gerrit Release
[[extension-and-plugin-api]]
-Publish the Extension and Plugin API Jars
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Publish the Extension and Plugin API Jars
* Make sure you have done the
link:dev-release-deploy-config.html#deploy-configuration-settings-xml[
@@ -162,16 +152,14 @@
[[publish-gerrit-war]]
-Publish the Gerrit WAR (with Core Plugins)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Publish the Gerrit WAR (with Core Plugins)
* The WAR file to upload is `buck-out/gen/release.war`
* Upload WAR to the storage bucket via `https://cloud.google.com/console` (manual via web browser)
[[push-stable]]
-Push the Stable Branch
-^^^^^^^^^^^^^^^^^^^^^^
+==== Push the Stable Branch
* create the stable branch `stable-2.5` in the `gerrit` project
+
@@ -183,8 +171,7 @@
[[push-tag]]
-Push the Release Tag
-^^^^^^^^^^^^^^^^^^^^
+==== Push the Release Tag
* Push the new Release Tag
+
@@ -202,8 +189,7 @@
[[upload-documentation]]
-Upload the Documentation
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Upload the Documentation
Build the release notes:
@@ -221,8 +207,7 @@
Description text
[[update-issues]]
-Update the Issues
-^^^^^^^^^^^^^^^^^
+==== Update the Issues
====
How do the issues get updated? Do you run a script to do
@@ -242,8 +227,7 @@
[[announce]]
-Announce on Mailing List
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Announce on Mailing List
* Send an email to the mailing list to announce the release, consider
including some or all of the following in the email:
@@ -295,8 +279,7 @@
[[increase-version]]
-Increase Gerrit Version for Current Development
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Increase Gerrit Version for Current Development
All new development that is done in the `master` branch will be
included in the next Gerrit release. Update the Gerrit version in the
@@ -305,8 +288,7 @@
[[merge-stable]]
-Merge `stable` into `master`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Merge `stable` into `master`
After every release, stable should be merged to master to ensure that
none of the changes/fixes ever get lost.
