abi_check.sh: Update version number for automatic abi check (2.5.0->2.5.1)
[openjpeg.git] / HOWTO-RELEASE
1 Check-list OpenJPEG Release
2
3 * update MAJOR, MINOR, BUILD, SOVERSION in CMakeLists.txt
4 * update MAJOR, MINOR, BUILD in appveyor.yml
5 * update CHANGELOG with
6 `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
7 * update NEWS.md
8 * git commit -a -m "Prepare for OpenJPEG v2.5.1 release"
9 * git tag -a v2.5.1 -m "OpenJPEG v2.5.1 release"
10 * git push origin --tags
11 * add post to OpenJPEG website in gh-pages branch in _posts/ subdirectory. See commit https://github.com/uclouvain/openjpeg/commit/6563d704f5fb896209dd862ccfc6b97eb9183c5c
12 * change binversion of openjpeg website in _config.yml in gh-pages branch
13 * update release description if needed
14 * update openjpeg.json with latest release
15 * update OPJ_LATEST_VERSION in abi-check.sh, uncomment and update OPJ_PREVIOUS_VERSION in abi-check.sh, and push
16 * locally run: OPJ_CI_ABI_CHECK=1 ./tools/travis-ci/abi-check.sh
17 * cd ~/abi-check/work/abi-check/
18 * put the sources of the new version in src/openjpeg/2.X.0/version.-2.X.0.tar.gz
19 * PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-monitor -v 2.X.0  -build ./openjpeg.json
20 * PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-tracker  -build ./openjpeg.json 
21 * rm -rf src/openjpeg/current
22 * rm -rf build_logs
23 * git add --all .
24 * git commit -m "Update ABI/API compatibility reports after 2.X.0 release"
25 * git push
26 * cd ~/openjpeg/openjpeg
27 * comment back OPJ_PREVIOUS_VERSION and push
28 * build doc and update Doxygen on website
29 * manual build on Windows:
30     - cmake ..  -G "Visual Studio 15 2017" -A x64 -DCMAKE_CONFIGURATION_TYPES=Release -DBUILD_THIRDPARTY=ON -D CPACK_GENERATOR:STRING=ZIP -D CPACK_PACKAGE_FILE_NAME:STRING=openjpeg-v2.4.0-windows-x64
31     - cmake --build . --target package --config Release
32 * send email to ML opj, comp.compression, iiif
33 * tweet