Release Checklist

A draft of the steps to prepare a release.

Setup

Install the release candidate:

$ gem install asciidoctor --pre

Stylesheet QA

• verify -a toc! does not create a TOC

• verify -a toc creates TOC in header (below title)

• verify -a toc=header creates TOC in header (below title)

• verify -a toc=preamble creates TOC in preamble

• verify -a toc=left creates TOC in left sidebar

• verify -a toc=right creates TOC in right sidebar

• verify -a toc=macro creates TOC at position of toc::[] macro

• verify -a source-highlighter! does not highlight source code, but listing has background color

• verify -a source-highlighter=coderay highlights source code with CodeRay

• verify -a source-highlighter=pygments highlights source code with Pygments

• verify -a source-highlighter=highlightjs highlights source code with highlight.js

• verify -a source-highlighter=prettify highlights source code with prettify

• verify -a source-highlighter=coderay -a linenums adds line numbers to source code

• verify -a source-highlighter=coderay -a linenums -a coderay-linenums-mode=table adds line numbers to source code using table

• verify -a source-highlighter=pygments -a linenums adds line numbers to source code

• verify -a source-highlighter=pygments -a linenums -a pygments-linenums-mode=table adds line numbers to source code using table

• verify -a source-highlighter=highlightjs -a linenums adds line numbers to source code

• verify long author line wraps correctly

• verify Print Preview for article doctype

• verify Print Preview for book doctype

Gem QA

• proofread summary and description

  • in .gemspec

  • in README.adoc

  • in repository metadata on github.com

• add all changes to CHANGELOG.adoc

• set release date in CHANGELOG.adoc

• put the CHANGELOG from the latest release in CHANGELOG section of the README.adoc

• update version in man page and regenerate

• check if there are necessary gem upgrades (e.g., coderay)

• check if there are updated libraries from CDN (e.g., MathJax, highlight.js, Font Awesome)

General QA

• test on Windows

• build asciidoctor.js against release candidate

Website

• upgrade Asciidoctor to latest release (final release when ready, release candidate before)

• pull latest content styles from default stylesheet

• unstage all documentation updates

• remove revdate attribute, update date in revision line and remove page-draft attribute in announcement post