From: Tom Hromatka <tom.hromatka@oracle.com>
Date: Thu, 4 Aug 2022 19:48:32 +0000 (-0600)
Subject: doc: Update the github release process
X-Git-Tag: v3.0~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a2340ab8cb04a7aa02e796a257329784913970df;p=thirdparty%2Flibcgroup.git

doc: Update the github release process

Add a step to update the libcgroup-tests submodule

Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>
---

diff --git a/doc/internal/release-github.md b/doc/internal/release-github.md
index 95a46046..8f9c289b 100644
--- a/doc/internal/release-github.md
+++ b/doc/internal/release-github.md
@@ -5,74 +5,82 @@ https://github.com/libcgroup/libcgroup
 This is the process that should be followed when creating a new libcgroup
 release.
 
-#### 1. Verify that all issues assigned to the release milestone have been resolved
+#### 1. Update the libcgroup-tests submodule
+
+	# ./bootstrap.sh
+	# git submodule update  --remote tests
+	# git add tests
+	# git commit -s
+	# git push
+
+#### 2. Verify that all issues assigned to the release milestone have been resolved
 
   * https://github.com/libcgroup/libcgroup/milestones
 
-#### 2. Verify that the Github Actions are all passing
+#### 3. Verify that the Github Actions are all passing
 
-#### 3. Verify that the bundled test suite runs without error
+#### 4. Verify that the bundled test suite runs without error
 
 	# ./bootstrap.sh
 	# make check
 
-#### 4. Verify that the packaging is correct
+#### 5. Verify that the packaging is correct
 
 	# make distcheck
 
-#### 5. Perform any distribution test builds
+#### 6. Perform any distribution test builds
 
   * Oracle Linux
   * Fedora Rawhide
   * Red Hat Enterprise Linux
   * etc.
 
-#### 6. If any problems were found up to this point that resulted in code changes, restart the process
+#### 7. If any problems were found up to this point that resulted in code changes, restart the process
 
-#### 7. If this is a new major/minor release, create new 'release-X.Y' branch
+#### 8. If this is a new major/minor release, create new 'release-X.Y' branch
 
 	# git branch "release-X.Y"
 
-#### 8. Update the version number in configure.ac AC_INIT(...) macro
+#### 9. Update the version number in configure.ac AC_INIT(...) macro
 
-#### 9. Tag the release in the local repository with a signed tag
+#### 10. Tag the release in the local repository with a signed tag
 
 	# git tag -s -m "version X.Y.Z" vX.Y.Z
 
-#### 10. Build final release tarball
+#### 11. Build final release tarball
 
 	# make clean
 	# ./bootstrap.sh
 	# make dist-gzip
 
-#### 11. Verify the release tarball in a separate directory
+#### 12. Verify the release tarball in a separate directory
 
 	<unpack the release tarball in a temporary directory>
 	# ./configure --sysconfdir=/etc --localstatedir=/var \
 	--enable-opaque-hierarchy="name=systemd" --enable-python
 	# make check
 
-#### 12. Generate a checksum for the release tarball
+#### 13. Generate a checksum for the release tarball
 
 	# sha256sum <tarball> > libcgroup-X.Y.Z.tar.gz.SHA256SUM
 
-#### 13. GPG sign the release tarball and checksum using the maintainer's key
+#### 14. GPG sign the release tarball and checksum using the maintainer's key
 
 	# gpg --armor --detach-sign libcgroup-X.Y.Z.tar.gz
 	# gpg --clearsign libcgroup-X.Y.Z.tar.gz.SHA256SUM
 
-#### 14. Push the release tag to the main GitHub repository
+#### 15. Push the release tag to the main GitHub repository
 
 	# git push <repo> vX.Y.Z
 
-#### 15. Create a new GitHub release using the associated tag and upload the following files
+#### 16. Create a new GitHub release using the associated tag and upload the following files
 
   * libcgroup-X.Y.Z.tar.gz
   * libcgroup-X.Y.Z.tar.gz.asc
   * libcgroup-X.Y.Z.tar.gz.SHA256SUM
   * libcgroup-X.Y.Z.tar.gz.SHA256SUM.asc
 
-#### 16. Update the GitHub release notes for older releases which are now unsupported
+#### 17. Update the GitHub release notes for older releases which are now unsupported
 
 The following Markdown text is suggested at the top of the release note, see old GitHub releases for examples.