Rename and convert ReleaseNotes.adoc to UPGRADING.md

Author: flashcode

ReleaseNotes.adoc

@@ -0,0 +1,10 @@
+# WeeChat Relay Upgrade guidelines
+
+These upgrade guidelines only contain instructions for version upgrades which require manual actions.\
+When upgrading from version X to Y, please read and apply all instructions from version X+1 to version Y (included).
+
+For a list of all changes in each version, please see [CHANGELOG.md](CHANGELOG.md).
+
+## Version 1.0.0
+
+No upgrade guidelines.

UPGRADING.md

@@ -1,4 +1,4 @@
 AUTHORS.adoc
 Contributing.adoc
 README.adoc
-ReleaseNotes.adoc
+UPGRADING.md

debian-stable/libweechatrelay.docs

@@ -33,32 +33,6 @@ if(BUILD_DOC OR BUILD_MAN)
       -a pygments-style=native
     )
 
-    # sed arguments used to replace links in release notes
-    set(SED_LINKS_ARGS
-      -e "'s/issue #\\([0-9][0-9]*\\)/https:\\/\\/github.com\\/weechat\\/weechat\\/issues\\/\\1[issue #\\1^]/g'"
-      -e "'s/debian #\\([0-9][0-9]*\\)/http:\\/\\/bugs.debian.org\\/cgi-bin\\/bugreport.cgi?bug=\\1[debian bug #\\1^]/g'"
-      -e "'s/\\(CVE-[0-9][0-9]*-[0-9][0-9]*\\)/https:\\/\\/cve.mitre.org\\/cgi-bin\\/cvename.cgi?name=\\1[\\1^]/g'"
-    )
-
-    # Release notes
-    add_custom_command(
-      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes-links.adoc"
-      COMMAND sed ARGS ${SED_LINKS_ARGS} "${CMAKE_CURRENT_SOURCE_DIR}/../ReleaseNotes.adoc" > "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes-links.adoc"
-      DEPENDS
-      "${CMAKE_CURRENT_SOURCE_DIR}/../ReleaseNotes.adoc"
-      WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
-    )
-    add_custom_command(
-      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes.html"
-      COMMAND "${ASCIIDOCTOR_EXECUTABLE}" ARGS ${ASCIIDOCTOR_ARGS} -a docinfodir="${CMAKE_CURRENT_SOURCE_DIR}" -o ReleaseNotes.html "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes-links.adoc"
-      DEPENDS
-      "${CMAKE_CURRENT_SOURCE_DIR}/docinfo.html"
-      "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes-links.adoc"
-      WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
-      COMMENT "Building ReleaseNotes.html"
-    )
-    add_custom_target(rn DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes.html")
-
     # man/doc in all languages
     add_subdirectory(en)
     add_subdirectory(fr)

doc/CMakeLists.txt

@@ -22,7 +22,7 @@
 # Make a new WeeChat Relay release:
 #   1. bump version
 #   2. git commit + tag
-#   3. compile, run, test, build rn + packages
+#   3. compile, run, test, build packages
 #   4. test package: unpack, compile, run, test
 #
 
@@ -55,22 +55,20 @@ release_start ()
     fi
     mkdir -p "${build_dir}"
     pkg_tar="${build_dir}/weechat-relay-${version}.tar"
-    rn="${build_dir}/doc/ReleaseNotes.html"
 }
 
 release_bump_version ()
 {
     "${root_dir}/tools/bump_version.sh" stable
     sed -i \
         -e "s/^\(== Version ${version}\) (under dev)$/\1 (${date})/" \
-        "${root_dir}/CHANGELOG.md" \
-        "${root_dir}/ReleaseNotes.adoc"
+        "${root_dir}/CHANGELOG.md"
 }
 
 release_commit_tag ()
 {
     cd "${root_dir}"
-    git commit -m "Version ${version}" version.sh CHANGELOG.md ReleaseNotes.adoc || release_error "git commit error, release already done?"
+    git commit -m "Version ${version}" version.sh CHANGELOG.md || release_error "git commit error, release already done?"
     git tag -a "v${version}" -m "WeeChat Relay ${version}"
 }
 
@@ -85,7 +83,6 @@ release_build ()
         -DBUILD_TESTS=ON \
         "${root_dir}"
     make install
-    make rn
     make test CTEST_OUTPUT_ON_FAILURE=TRUE
     make dist
     version_weechat_relay=$("${build_dir}/install/bin/weechat-relay-cli" --version)
@@ -130,7 +127,6 @@ release_end ()
     echo "  version  : ${version}"
     echo "  date     : ${date}"
     echo "  build dir: ${build_dir}"
-    echo "  rn       : ${rn}"
     echo "  packages :"
     for pkg in "${pkg_tar}".*; do
         echo "    $pkg"

tools/release.sh

@@ -101,7 +101,7 @@ libweechatrelay_CONTENTS="
     usr/share/doc/weechat/Contributing.adoc
     usr/share/doc/weechat/COPYING
     usr/share/doc/weechat/README.adoc
-    usr/share/doc/weechat/ReleaseNotes.adoc
+    usr/share/doc/weechat/UPGRADING.md
 "
 libweechatrelay_REQUIRES="weechat"