To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

HowToRelease: Difference between revisions

From ZNC
Jump to navigation Jump to search
>Psychon
Don't ping Kuja
Restore (probably)
Line 1: Line 1:
=== TODO ===
Should the changelog become part of the release tarballs? Just the latest changelog or a concatenation of all changelogs?
=== Preparation ===
=== Preparation ===
# Check todo lists and bug trackers.
# Check todo lists and bug trackers.
# Check whether our-of-source builds still work.
# Prepare ChangeLog/git, let everyone check it.
# Release an "-alpha1" and notice that nobody tests it.
=== To release RC1 ===
# Do a "-beta1" which still no one tests.
# Update version number in include/version.h and configure.ac, make a new branch 1.6.2 from 1.6.x, commit with message ZNC 1.6.2-rc1. (probably version.h should mention -rc1 in VERSION_STR?)
# For "-rc1", we finally do some version number changes
<pre>
## Update version number in *version.h* and *configure.ac* (use VERSION-rc1 here)
diff --git a/configure.ac b/configure.ac
## <code>git add</code> all modified files, so that make-tarball.sh picks them up.
index 2c25258..53a4527 100644
## Fix make-tarball.sh to add -rc1 to VERSION_EXTRA (TODO: do it automatically)
--- a/configure.ac
## Release tarball. (<code>./make-tarball.sh VERSION-rc1</code>).
+++ b/configure.ac
 
@@ -7,7 +7,7 @@ AC_DEFUN([AC_PROG_CC], [m4_errprint(__file__:__line__[: Something is trying to u
dnl Needed for AC_PATH_PROGS_FEATURE_CHECK which was added in 2.62
AC_PREREQ([2.62])
dnl Keep the version number in sync with version.h!
-AC_INIT([znc], [1.6.x])
+AC_INIT([znc], [1.6.2-rc1])
AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_SRCDIR([src/znc.cpp])
AC_LANG([C++])
diff --git a/include/znc/version.h b/include/znc/version.h
index 14d7bf1..d2c4b0b 100644
--- a/include/znc/version.h
+++ b/include/znc/version.h
@@ -4,9 +4,9 @@
// The following defines are for #if comparison (preprocessor only likes ints)
#define VERSION_MAJOR  1
#define VERSION_MINOR  6
-#define VERSION_PATCH  -1
+#define VERSION_PATCH  2
// This one is for display purpose
-#define VERSION_STR    "1.6.x"
+#define VERSION_STR    "1.6.2"
// This one is for ZNCModInfo
#define VERSION        (VERSION_MAJOR + VERSION_MINOR / 10.0)
</pre>
# Modify make-tarball.sh to have DESC="-rc1" (TODO: figure it out automatically), run ./make-tarball.sh 1.6.2-rc1 without commiting that change.
# Test the tarball, publish it.
# Tag the last commit with znc-1.6.2-rc1 (but without annotated tag), push commit and tag to github.
# Set Template:ZNC-Version-Alpha to 1.6.2-rc1
=== Release, release, release ===
=== Release, release, release ===
# Revert the changes from above
# Revert changes to make-tarball.sh from above
# Prepare changelog.txt based on [[ChangeLog/git]], let everyone check it
# git pull!!!!
# git pull!!!!
# Update version number in *version.h* and *configure.ac*
# Update version number in configure.ac
# Commit ("Increase the version number to foo")
<pre>
# Create tarball (make-tarball.sh VERSION)
diff --git a/configure.ac b/configure.ac
# Tag the new version in git (Use the changelog as commit msg, first line is "ZNC 1.foo")
index 53a4527..dae417f 100644
## <code>git tag -s znc-1.foo HEAD</code>
--- a/configure.ac
# Bump version number to foo+1. (Commit msg: "Increase the version number to foo+1")
+++ b/configure.ac
@@ -7,7 +7,7 @@ AC_DEFUN([AC_PROG_CC], [m4_errprint(__file__:__line__[: Something is trying to u
dnl Needed for AC_PATH_PROGS_FEATURE_CHECK which was added in 2.62
AC_PREREQ([2.62])
dnl Keep the version number in sync with version.h!
-AC_INIT([znc], [1.6.2-rc1])
+AC_INIT([znc], [1.6.2])
AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_SRCDIR([src/znc.cpp])
AC_LANG([C++])
</pre>
# Update ChangeLog.md based on ChangeLog/git
# Commit ("Increase the version number to 1.6.2")
# Create tarball (make-tarball.sh 1.6.2)
# Tag the new version in git (Use the changelog as msg, first line is "ZNC 1.6.2")
# git tag -s znc-1.6.2 HEAD
# git push --tags
# Merge 1.6.2 to 1.6.x, delete branch 1.6.2
# (If minor release?) Revert changes to version.h and configure.ac
# (If major release?) Bump version number to foo+1. (Commit msg: "Increase the version number to foo+1")
# Update the wiki
# Update the wiki
## Move [[ChangeLog/git]] and create that page again.
# Move ChangeLog/git and create that page again, remove released=no from version header.
## Update [[:Template:ZNC-Version]].
# Update Template:ZNC-Version.
# Clear Template:ZNC-Version-Alpha.
# Upload the release files to znc.in/.
# Upload the release files to znc.in/.
## Accessible as /srv/znc.in/www/htdocs/ on harpy.
#* Accessible as /srv/znc.in/www/htdocs/ on harpy.
## The files have to be chgrp's to user group znc!!!
#* The files have to be chgrp's to user group znc!!!
## The files themselves go directly into archive/
#* The files themselves go directly into archive/
## The main dir only gets symlinks
#* The main dir only gets symlinks
# Write znc-1.6.2-changelog.txt
# Update version number on Wikipedia.
# Update version number on Wikipedia.
# Update topic on freenode channel
# Update cygwin package using https://github.com/znc/znc-cygwin
# Update docker image using https://github.com/znc/znc-docker and https://github.com/docker-library/official-images

Revision as of 15:10, 22 April 2017

Preparation

  1. Check todo lists and bug trackers.
  2. Prepare ChangeLog/git, let everyone check it.

To release RC1

  1. Update version number in include/version.h and configure.ac, make a new branch 1.6.2 from 1.6.x, commit with message ZNC 1.6.2-rc1. (probably version.h should mention -rc1 in VERSION_STR?)
diff --git a/configure.ac b/configure.ac
index 2c25258..53a4527 100644
--- a/configure.ac
+++ b/configure.ac
@@ -7,7 +7,7 @@ AC_DEFUN([AC_PROG_CC], [m4_errprint(__file__:__line__[: Something is trying to u
 dnl Needed for AC_PATH_PROGS_FEATURE_CHECK which was added in 2.62
 AC_PREREQ([2.62])
 dnl Keep the version number in sync with version.h!
-AC_INIT([znc], [1.6.x])
+AC_INIT([znc], [1.6.2-rc1])
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([src/znc.cpp])
 AC_LANG([C++])
diff --git a/include/znc/version.h b/include/znc/version.h
index 14d7bf1..d2c4b0b 100644
--- a/include/znc/version.h
+++ b/include/znc/version.h
@@ -4,9 +4,9 @@
 // The following defines are for #if comparison (preprocessor only likes ints)
 #define VERSION_MAJOR  1
 #define VERSION_MINOR  6
-#define VERSION_PATCH  -1
+#define VERSION_PATCH  2
 // This one is for display purpose
-#define VERSION_STR    "1.6.x"
+#define VERSION_STR    "1.6.2"
 // This one is for ZNCModInfo
 #define VERSION        (VERSION_MAJOR + VERSION_MINOR / 10.0)
  1. Modify make-tarball.sh to have DESC="-rc1" (TODO: figure it out automatically), run ./make-tarball.sh 1.6.2-rc1 without commiting that change.
  2. Test the tarball, publish it.
  3. Tag the last commit with znc-1.6.2-rc1 (but without annotated tag), push commit and tag to github.
  4. Set Template:ZNC-Version-Alpha to 1.6.2-rc1

Release, release, release

  1. Revert changes to make-tarball.sh from above
  2. git pull!!!!
  3. Update version number in configure.ac
diff --git a/configure.ac b/configure.ac
index 53a4527..dae417f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -7,7 +7,7 @@ AC_DEFUN([AC_PROG_CC], [m4_errprint(__file__:__line__[: Something is trying to u
 dnl Needed for AC_PATH_PROGS_FEATURE_CHECK which was added in 2.62
 AC_PREREQ([2.62])
 dnl Keep the version number in sync with version.h!
-AC_INIT([znc], [1.6.2-rc1])
+AC_INIT([znc], [1.6.2])
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([src/znc.cpp])
 AC_LANG([C++])
  1. Update ChangeLog.md based on ChangeLog/git
  2. Commit ("Increase the version number to 1.6.2")
  3. Create tarball (make-tarball.sh 1.6.2)
  4. Tag the new version in git (Use the changelog as msg, first line is "ZNC 1.6.2")
  5. git tag -s znc-1.6.2 HEAD
  6. git push --tags
  7. Merge 1.6.2 to 1.6.x, delete branch 1.6.2
  8. (If minor release?) Revert changes to version.h and configure.ac
  9. (If major release?) Bump version number to foo+1. (Commit msg: "Increase the version number to foo+1")
  10. Update the wiki
  11. Move ChangeLog/git and create that page again, remove released=no from version header.
  12. Update Template:ZNC-Version.
  13. Clear Template:ZNC-Version-Alpha.
  14. Upload the release files to znc.in/.
    • Accessible as /srv/znc.in/www/htdocs/ on harpy.
    • The files have to be chgrp's to user group znc!!!
    • The files themselves go directly into archive/
    • The main dir only gets symlinks
  15. Write znc-1.6.2-changelog.txt
  16. Update version number on Wikipedia.
  17. Update topic on freenode channel
  18. Update cygwin package using https://github.com/znc/znc-cygwin
  19. Update docker image using https://github.com/znc/znc-docker and https://github.com/docker-library/official-images