Rename and convert ChangeLog.adoc to CHANGELOG.md

Author: flashcode

CHANGELOG.md

@@ -0,0 +1,8 @@
+# WeeChat Relay ChangeLog
+
+## Version 1.0.0 (under dev)
+
+### Added
+
+- New binary weechat-relay-cli to test the library
+- New C library to communicate between WeeChat and a client using the "weechat" relay protocol

CMakeLists.txt

@@ -131,7 +131,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/weechat-relay.cygport.in
 if(CYGWIN)
   install(FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/AUTHORS.adoc
-    ${CMAKE_CURRENT_SOURCE_DIR}/ChangeLog.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/CHANGELOG.md
     ${CMAKE_CURRENT_SOURCE_DIR}/Contributing.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/README.adoc
     DESTINATION ${DATAROOTDIR}/doc/${PROJECT_NAME})

ChangeLog.adoc

@@ -12,9 +12,7 @@ https://weechat.org/files/releasenotes/relay/ReleaseNotes-devel.html[here]). +
 It is recommended to read it when upgrading to a new stable
 version.
 
-For a complete list of changes, please look at
-https://weechat.org/files/changelog/relay/ChangeLog-devel.html[ChangeLog]
-(file _ChangeLog.adoc_ in sources).
+For a complete list of changes, please look at CHANGELOG.md.
 
 
 [[v1.0.0]]

ReleaseNotes.adoc

@@ -29,7 +29,7 @@ override_dh_auto_build: $(BUILDDIR)/Makefile
 	dh_auto_build
 
 override_dh_installchangelogs:
-	dh_installchangelogs ChangeLog.adoc
+	dh_installchangelogs CHANGELOG.md
 
 %:
 	dh $@ --builddirectory=$(BUILDDIR) --without autoreconf

debian-stable/rules

@@ -33,32 +33,13 @@ if(BUILD_DOC OR BUILD_MAN)
       -a pygments-style=native
     )
 
-    # sed arguments used to replace links in ChangeLog and release notes
+    # 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'"
     )
 
-    # ChangeLog
-    add_custom_command(
-      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog-links.adoc"
-      COMMAND sed ARGS ${SED_LINKS_ARGS} "${CMAKE_CURRENT_SOURCE_DIR}/../ChangeLog.adoc" > "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog-links.adoc"
-      DEPENDS
-      "${CMAKE_CURRENT_SOURCE_DIR}/../ChangeLog.adoc"
-      WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
-    )
-    add_custom_command(
-      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog.html"
-      COMMAND "${ASCIIDOCTOR_EXECUTABLE}" ARGS ${ASCIIDOCTOR_ARGS} -a docinfodir="${CMAKE_CURRENT_SOURCE_DIR}" -o ChangeLog.html "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog-links.adoc"
-      DEPENDS
-      "${CMAKE_CURRENT_SOURCE_DIR}/docinfo.html"
-      "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog-links.adoc"
-      WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
-      COMMENT "Building ChangeLog.html"
-    )
-    add_custom_target(changelog DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/ChangeLog.html")
-
     # Release notes
     add_custom_command(
       OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ReleaseNotes-links.adoc"

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 changelog + rn + packages
+#   3. compile, run, test, build rn + packages
 #   4. test package: unpack, compile, run, test
 #
 
@@ -55,7 +55,6 @@ release_start ()
     fi
     mkdir -p "${build_dir}"
     pkg_tar="${build_dir}/weechat-relay-${version}.tar"
-    chglog="${build_dir}/doc/ChangeLog.html"
     rn="${build_dir}/doc/ReleaseNotes.html"
 }
 
@@ -64,14 +63,14 @@ release_bump_version ()
     "${root_dir}/tools/bump_version.sh" stable
     sed -i \
         -e "s/^\(== Version ${version}\) (under dev)$/\1 (${date})/" \
-        "${root_dir}/ChangeLog.adoc" \
+        "${root_dir}/CHANGELOG.md" \
         "${root_dir}/ReleaseNotes.adoc"
 }
 
 release_commit_tag ()
 {
     cd "${root_dir}"
-    git commit -m "Version ${version}" version.sh ChangeLog.adoc ReleaseNotes.adoc || release_error "git commit error, release already done?"
+    git commit -m "Version ${version}" version.sh CHANGELOG.md ReleaseNotes.adoc || release_error "git commit error, release already done?"
     git tag -a "v${version}" -m "WeeChat Relay ${version}"
 }
 
@@ -86,7 +85,6 @@ release_build ()
         -DBUILD_TESTS=ON \
         "${root_dir}"
     make install
-    make changelog
     make rn
     make test CTEST_OUTPUT_ON_FAILURE=TRUE
     make dist
@@ -132,13 +130,11 @@ 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"
     done
-    echo "  chglog/rn:"
-    echo "    $chglog"
-    echo "    $rn"
     echo "=========================================================================="
     echo
     echo "*** SUCCESS! ***"

tools/release.sh

@@ -97,7 +97,7 @@ between WeeChat and a client using the \"weechat\" relay protocol."
 libweechatrelay_CONTENTS="
     usr/lib/libweechatrelay.dll
     usr/share/doc/weechat/AUTHORS.adoc
-    usr/share/doc/weechat/ChangeLog.adoc
+    usr/share/doc/weechat/CHANGELOG.md
     usr/share/doc/weechat/Contributing.adoc
     usr/share/doc/weechat/COPYING
     usr/share/doc/weechat/README.adoc