opj_jp2_read_header(): move setting color_space here instead in opj_jp2_decode()...
[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.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
7 * update NEWS.md
8 * git tag -a v2.4.0 -m "OpenJPEG v2.4.0 release"
9 * git push origin --tags
10 * add post to OpenJPEG website in gh-pages branch in _posts/ subdirectory. See commit https://github.com/uclouvain/openjpeg/commit/6563d704f5fb896209dd862ccfc6b97eb9183c5c
11 * change binversion of openjpeg website in _config.yml in gh-pages branch
12 * update release description if needed
13 * update openjpeg.json with latest release
14 * update OPJ_LATEST_VERSION in abi-check.sh, uncomment and update OPJ_PREVIOUS_VERSION in abi-check.sh, and push
15 * locally run: OPJ_CI_ABI_CHECK=1 ./tools/travis-ci/abi-check.sh
16 * cd ~/abi-check/work/abi-check/
17 * put the sources of the new version in src/openjpeg/2.X.0/version.-2.X.0.tar.gz
18 * PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-monitor -v 2.X.0  -build ./openjpeg.json
19 * PATH=$PWD/../../tools/abi-tracker/bin:$PWD/../../tools/wdiff/bin:$PWD/../../tools:$PATH abi-tracker  -build ./openjpeg.json 
20 * rm -rf src/openjpeg/current
21 * rm -rf build_logs
22 * git add --all .
23 * git commit -m "Update ABI/API compatibility reports after 2.X.0 release"
24 * git push
25 * cd ~/openjpeg/openjpeg
26 * comment back OPJ_PREVIOUS_VERSION and push
27 * build doc and update Doxygen on website
28 * manual build on Windows:
29     - 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
30     - cmake --build . --target package --config Release
31 * send email to ML opj, comp.compression, iiif
32 * tweet