Anastasia Klimchuk submitted this change.
VERSION: Change name pattern to match tag name from now on
This patch updated the VERSION file itself, and the document on
release process.
Change-Id: I2bd2e57e42c29ea5a9d8bc334b86c6fa5c4b46a4
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/84811
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
---
M VERSION
M doc/dev_guide/release_process.rst
2 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/VERSION b/VERSION
index 4a06232..bd033f4 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.5.0-devel
+v1.5.0-devel
diff --git a/doc/dev_guide/release_process.rst b/doc/dev_guide/release_process.rst
index 749779e..15eaf6c 100644
--- a/doc/dev_guide/release_process.rst
+++ b/doc/dev_guide/release_process.rst
@@ -24,14 +24,13 @@
* Double-check and merge all the patches that are fully ready (see also :ref:`merge-checklist`)
-* Update VERSION file to first release candidate. Check the git history of VERSION file for a version name pattern.
+* Update VERSION file to first release candidate. The name pattern is: ``v{version_number}-rc{rc_number}``.
- * As an example at the time of writing, the version name of the first release candidate was ``1.4.0-rc1``.
+ * As an example, the version name of the first release candidate can be ``v1.4.0-rc1``.
* To update the VERSION file, push a patch to Gerrit, and another maintainer should review and approve.
-* After submitting the change to the VERSION file, tag this commit.
- You can check `flashrom tags in Gerrit <https://review.coreboot.org/admin/repos/flashrom,tags,25>`_
- for tag name pattern. As an example at the time of writing, the tag name was ``v1.4.0-rc1``.
+* After submitting the change to the VERSION file, tag this commit. Tag name should be the same as
+ version name, for example above ``v1.4.0-rc1``.
* Write an announcement on the mailing list. Be very clear about:
@@ -74,13 +73,19 @@
* Submit the release notes, and in the same patch restart :doc:`/release_notes/devel` document.
This way everyone who is syncing the repository by the release tag will have release notes in the tree.
-* Update VERSION file to release version (for example, at the time of writing ``1.4.0``), and submit this
+* Update VERSION file to release version, name pattern is: ``v{version_name}``
+ (for example, it can be ``v1.4.0``), and submit this.
-* Tag the commit which updates the VERSION file. You can check
- `flashrom tags in Gerrit <https://review.coreboot.org/admin/repos/flashrom,tags,25>`_ for tag name pattern.
- As an example at the time of writing, the tag name was ``v1.4.0``.
+* Tag the commit which updates the VERSION file. Tag name should be the same as version name,
+ for example above ``v1.4.0``.
-* Create the tarball, sign it, and upload to the server together with the signature.
+* Create the tarball:
+
+ * At the moment of writing, the command we use ``meson dist --include-subprojects``,
+ more details are in `meson docs <https://mesonbuild.com/Creating-releases.html#creating-releases>`_.
+ * Check that tarball name follows the pattern ``flashrom-v{version_name}.tar.xz``, for example ``flashrom-v1.4.0.tar.xz``.
+
+* Sign the tarball, and upload to the server together with the signature.
* Update release notes with the link to download tarball, signature, and fingerprint. Submit this and check that final release notes are published on the website.
@@ -93,7 +98,8 @@
Start the next cycle of development
===================================
-* Update the VERSION file to the development version. For example, at the time of writing ``1.5.0-devel``, and submit this.
+* Update the VERSION file to the development version. For example, the name pattern is: ``v{version_name}-devel``,
+ for example ``v1.5.0-devel``, and submit this.
* Submit all the patches that have been ready and waiting.
To view, visit change 84811. To unsubscribe, or for help writing mail filters, visit settings.