Merge pull request #1516 from stweil/actions

[openjpeg.git] / HOWTO-RELEASE

diff --git a/HOWTO-RELEASE b/HOWTO-RELEASE
index 1f3fb946106626ac620c91fd399164162af1da6c..2e4450c3700dd1c9dbf6dcdc04c6f9d9e3f34064 100644 (file)
--- a/HOWTO-RELEASE
+++ b/HOWTO-RELEASE
@@ -3,15 +3,28 @@ Check-list OpenJPEG Release
 * update MAJOR, MINOR, BUILD, SOVERSION in CMakeLists.txt
 * update MAJOR, MINOR, BUILD in appveyor.yml
 * update CHANGELOG with
-`github_changelog_generator --token TOKEN_HERE --exclude-labels gcode_fixed,OpjVersion-1.x --release-url "https://github.com/uclouvain/openjpeg/releases/%s" --since-tag v2.3.1 --future-release v2.4.0 --output append2changelog.md --user uclouvain --project openjpeg --exclude-tags version.1.0` . TOKEN_HERE is created at https://github.com/settings/tokens
+`github_changelog_generator --token TOKEN_HERE --exclude-labels gcode_fixed,OpjVersion-1.x --release-url "https://github.com/uclouvain/openjpeg/releases/%s" --since-tag v2.5.0 --future-release v2.5.1 --output append2changelog.md --user uclouvain --project openjpeg --exclude-tags version.1.0` . TOKEN_HERE is created at https://github.com/settings/tokens
 * update NEWS.md
-* git tag -a v2.4.0 -m "OpenJPEG v2.4.0 release"
+* git commit -a -m "Prepare for OpenJPEG v2.5.1 release"
+* git tag -a v2.5.1 -m "OpenJPEG v2.5.1 release"
 * git push origin --tags
 * add post to OpenJPEG website in gh-pages branch in _posts/ subdirectory. See commit https://github.com/uclouvain/openjpeg/commit/6563d704f5fb896209dd862ccfc6b97eb9183c5c
 * change binversion of openjpeg website in _config.yml in gh-pages branch
 * update release description if needed
 * update openjpeg.json with latest release
 * update OPJ_LATEST_VERSION in abi-check.sh, uncomment and update OPJ_PREVIOUS_VERSION in abi-check.sh, and push
+* locally run: OPJ_CI_ABI_CHECK=1 ./tools/travis-ci/abi-check.sh
+* cd ~/abi-check/work/abi-check/
+* put the sources of the new version in src/openjpeg/2.5.1/version.-2.5.1.tar.gz
+* PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-monitor -v 2.5.1  -build ./openjpeg.json
+* PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-tracker  -build ./openjpeg.json 
+* rm -rf src/openjpeg/current
+* rm -rf build_logs
+* Remove symbolic links: rm -f installed/openjpeg/2.5.1/lib/libopenjp2.so installed/openjpeg/2.5.1/lib/libopenjp2.so.7 installed/openjpeg/current/lib/libopenjp2.so abi-check/installed/openjpeg/current/lib/libopenjp2.so.7
+* git add --all .
+* git commit -m "Update ABI/API compatibility reports after 2.5.1 release"
+* git push
+* cd ~/openjpeg/openjpeg
 * comment back OPJ_PREVIOUS_VERSION and push
 * build doc and update Doxygen on website
 * manual build on Windows: