notcurses/doc/release-checklist.md

# Release procedure

## Precheck

* Review the testing checklist (doc/testing-checklist.md)
* clang-tidy check with something like:
  * `cmake "-DCMAKE_CXX_CLANG_TIDY=/usr/bin/clang-tidy-11;-checks=-*,clang-analyzer-*,modernize-*,performance-*" ..`
  * `scan-build cmake .. && scan-build make`

## Release

* Run tools/release.sh $OLDVERSION $VERSION
  * Finalize CHANGELOG.md
  * Bumps version numbers everywhere they need bumping
  * Commits changes, tags result with v$VERSION, pushes tag
  * Downloads new tarball and signs it
  * Upload signature to github
* Draft new release at https://github.com/dankamongmen/notcurses/releases
  * Title is "v$VERSION—some quip"
  * That's an em dash (U+2014, UTF-8 e2 80 94), get it right
* Upload new Rust crate with `cargo publish`
* Upload new Python pip with
  * `python3 setup.py sdist`
  * `twine upload dist/*`
* Generate and upload new HTML documentation via `make html`
  * `scp *.html ../doc/man/index.html qemfd.net:/var/www/notcurses/`
* Generate and upload new Doxygen documentation via `doxygen ../doc/Doxyfile`
  * `scp -r html qemfd.net:/var/www/notcurses/`

## Packaging

### Debian

* In gbp repository:
  * Update Debian changelog, if necessary: `dch -v $VERSION+dfsg.1-1`
  * Finalize Debian changelog with `dch -r`
  * Repack DFSG-safe tarball with uscan, upload to github
    * `uscan --repack --compression xz --force`
    * `gpg --sign --armor --detach-sign ../notcurses_$VERSION+dfsg.1.orig.tar.xz`
    * sign, upload dfsg+sig to github
    * import new version: `gbp import-orig ../notcurses_$VERSION+dfsg.1.orig.tar.xz`
    * `git push --tags`
    * build source package: `dpkg-buildpackage --build=source`
    * build binaries: `cd .. && export TERM=xterm-256color && sudo pbuilder build *dsc`
        * perform this in xterm with TERM=xterm-256color
        * beware: freak TERMs won't be present in pbuilder
* Copy `../*notcurses*$VERSION*` to apt repo, import with `reprepro`
* Update Debian changelog with `dch -v $NEXTVERSION-1`
* Update CMakeLists.txt with next version

### Fedora

* In pagure/notcurses master:
  * Update notcurses.spec, bump version, add changelog entry
  * clear out any old ersatz detritus
  * spectool -g notcurses.spec
  * fedpkg upload *.xz *.asc
  * fedpkg new-sources *.xz *.asc
  * fedpkg commit
  * git push
  * fedpkg build
  * fedpkg switch-branch f32
  * git merge master

### Arch

* Upload new AUR information
  * Update `pkgver` and `sha256sums` entries
  * `makepkg --printsrcinfo > .SRCINFO`
  * Test that package builds with `makepkg`
  * `git commit -a`

### FreeBSD

* Update svn checkout of Ports tree: `cd /usr/ports && svn up`
* Upgrade ports: `portupgrade -uap`
* `cd /usr/ports/devel/notcurses`
* Update `DISTVERSION` in `Makefile
* `sudo make makesum`
* `make stage`
* `make stage-qa`
* `portlint`
* `svn diff > ../`make -VPKGNAME`.diff
* File bug on devel/notcurses, attach diff
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00			`# Release procedure`

			`## Precheck`

First go at ncplane_puttext() (#690) Very simple take at ncplane_puttext(), a new function for linebroken text. Also some very basic unit tests. I doubt this works very well yet, but it handles the simplest cases #682. Added nclog(), internal function for logging. #520 2020-06-08 07:01:58 +00:00			`* Review the testing checklist (doc/testing-checklist.md)`
release-checklist: add scan-build invocation 2020-05-07 04:53:23 +00:00			`* clang-tidy check with something like:`
			* `cmake "-DCMAKE_CXX_CLANG_TIDY=/usr/bin/clang-tidy-11;-checks=-,clang-analyzer-,modernize-,performance-" ..`
			* `scan-build cmake .. && scan-build make`
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00
			`## Release`

v1.3.2 2020-04-19 06:24:03 +00:00			`* Run tools/release.sh $OLDVERSION $VERSION`
			`* Finalize CHANGELOG.md`
			`* Bumps version numbers everywhere they need bumping`
			`* Commits changes, tags result with v$VERSION, pushes tag`
			`* Downloads new tarball and signs it`
			`* Upload signature to github`
release guide 2019-11-29 03:19:15 +00:00			`* Draft new release at https://github.com/dankamongmen/notcurses/releases`
			`* Title is "v$VERSION—some quip"`
			`* That's an em dash (U+2014, UTF-8 e2 80 94), get it right`
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00			* Upload new Rust crate with `cargo publish`
			`* Upload new Python pip with`
			* `python3 setup.py sdist`
			* `twine upload dist/*`
			* Generate and upload new HTML documentation via `make html`
			* `scp *.html ../doc/man/index.html qemfd.net:/var/www/notcurses/`
			* Generate and upload new Doxygen documentation via `doxygen ../doc/Doxyfile`
			* `scp -r html qemfd.net:/var/www/notcurses/`

release checklist: add fedora 2020-06-14 22:59:35 +00:00			`## Packaging`

			`### Debian`
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00
update release process for gbp 2020-04-19 19:55:43 +00:00			`* In gbp repository:`
man pages: terminals don't honor COLORTERM, they honor escapes 2020-04-19 21:12:13 +00:00			* Update Debian changelog, if necessary: `dch -v $VERSION+dfsg.1-1`
update release process for gbp 2020-04-19 19:55:43 +00:00			* Finalize Debian changelog with `dch -r`
			`* Repack DFSG-safe tarball with uscan, upload to github`
man pages: terminals don't honor COLORTERM, they honor escapes 2020-04-19 21:12:13 +00:00			* `uscan --repack --compression xz --force`
NCVISUAL_OPTION_MAYDEGRADE -> NCVISUAL_OPTION_NODEGRADE, doc 'em 2020-06-05 12:05:02 +00:00			* `gpg --sign --armor --detach-sign ../notcurses_$VERSION+dfsg.1.orig.tar.xz`
notcurses-view: verify Notcurses::can_open() 2020-05-07 13:04:50 +00:00			`* sign, upload dfsg+sig to github`
			* import new version: `gbp import-orig ../notcurses_$VERSION+dfsg.1.orig.tar.xz`
document GBP steps for release 2020-04-27 01:38:32 +00:00			* `git push --tags`
update release process for gbp 2020-04-19 19:55:43 +00:00			* build source package: `dpkg-buildpackage --build=source`
NCVISUAL_OPTION_MAYDEGRADE -> NCVISUAL_OPTION_NODEGRADE, doc 'em 2020-06-05 12:05:02 +00:00			* build binaries: `cd .. && export TERM=xterm-256color && sudo pbuilder build *dsc`
not to self regarding pbuilder 2020-06-01 20:07:00 +00:00			`* perform this in xterm with TERM=xterm-256color`
			`* beware: freak TERMs won't be present in pbuilder`
release guide 2019-11-29 03:19:15 +00:00			* Copy `../notcurses$VERSION*` to apt repo, import with `reprepro`
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00			* Update Debian changelog with `dch -v $NEXTVERSION-1`
			`* Update CMakeLists.txt with next version`

release checklist: add fedora 2020-06-14 22:59:35 +00:00			`### Fedora`

			`* In pagure/notcurses master:`
			`* Update notcurses.spec, bump version, add changelog entry`
			`* clear out any old ersatz detritus`
			`* spectool -g notcurses.spec`
			`* fedpkg upload .xz .asc`
			`* fedpkg new-sources .xz .asc`
			`* fedpkg commit`
			`* git push`
			`* fedpkg build`
			`* fedpkg switch-branch f32`
			`* git merge master`

			`### Arch`
testing-checklist: add LANG=C, needed for debuilder 2020-06-14 21:39:58 +00:00
release guide 2019-11-29 03:19:15 +00:00			`* Upload new AUR information`
			* Update `pkgver` and `sha256sums` entries
			* `makepkg --printsrcinfo > .SRCINFO`
			* Test that package builds with `makepkg`
			* `git commit -a`
freebsd release notes 2020-06-01 21:26:56 +00:00
release checklist: add fedora 2020-06-14 22:59:35 +00:00			`### FreeBSD`
freebsd release notes 2020-06-01 21:26:56 +00:00
			* Update svn checkout of Ports tree: `cd /usr/ports && svn up`
			* Upgrade ports: `portupgrade -uap`
			* `cd /usr/ports/devel/notcurses`
			* Update `DISTVERSION` in `Makefile
			* `sudo make makesum`
			* `make stage`
			* `make stage-qa`
			* `portlint`
			* `svn diff > ../`make -VPKGNAME`.diff
			`* File bug on devel/notcurses, attach diff`