[gnome-software: 1/3] docs: Use variables in the RELEASE instructions




commit f1fa53040424a6095d2ee723cc54de2a87698c10
Author: Philip Withnall <pwithnall endlessos org>
Date:   Sat Jan 30 22:11:16 2021 +0000

    docs: Use variables in the RELEASE instructions
    
    This should clarify which version numbers to use where.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 RELEASE.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
---
diff --git a/RELEASE.md b/RELEASE.md
index 6f5c00b21..08a4f6dab 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -13,6 +13,10 @@ Making a release
 
 Adapted from the [GNOME release process](https://wiki.gnome.org/MaintainersCorner/Releasing).
 
+These instructions use the following variables:
+ - `new_version`: the version number of the release you are making, for example 3.38.1
+ - `previous_version`: the version number of the most-recently released version in the same release series, 
for example 3.38.0
+
 Make sure your repository is up to date and doesn’t contain local changes:
 ```
 git pull
@@ -23,7 +27,7 @@ Check the version in `meson.build` is correct for this release.
 
 Write release entries:
 ```
-gitlab-changelog GNOME/gnome-software 3.38.0..
+gitlab-changelog GNOME/gnome-software ${previous_version}..
 ```
 
 Edit this down to just the user visible changes, and list them in
@@ -41,7 +45,7 @@ appstream-util appdata-to-news ../data/appdata/org.gnome.Software.appdata.xml.in
 Commit the release:
 ```
 git add -p
-git commit -m "Release version 3.38.1"
+git commit -m "Release version ${new_version}"
 ```
 
 Build the release tarball:
@@ -51,8 +55,8 @@ ninja dist
 
 Tag, sign and push the release (see below for information about `git evtag`):
 ```
-git evtag sign 3.38.1
-git push --atomic origin master 3.38.1
+git evtag sign ${new_version}
+git push --atomic origin master ${new_version}
 ```
 
 Upload the release tarball:


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]