release-checklist.md

Case: new pandoc release

• Add a new row for the release to versions.md. Make sure that no tag in the tags column is listed twice; adjust other rows if necessary. Use the "Alpine" and "Ubuntu" releases that are used for the dev (main) version.

• Set the PANDOC_VERSION environment variable. This will save a good bit of typing and prevent mistakes further down.

  ``` console
  $ export PANDOC_VERSION=2.13
  ```
  

• Create freeze files for each stack by running:

  $ make {static,alpine,ubuntu}-freeze-file

  It may make sense to also specify WITHOUT_CROSSREF=true, but the build should succeed either way.

• Commit the results.

  $ git add {static,alpine,ubuntu}/freeze/pandoc-$PANDOC_VERSION.project.freeze
  $ git commit -m "Create release=$PANDOC_VERSION"
  $ gh pr create --fill --draft

  or push it directly.

• GitHub Actions will take it from here: the new images will be built and pushed to Docker Hub as soon as the commit hits the master branch. Just check after 1h that everything worked.

• If there is a problem, e.g., because the tests fails as pandoc-crossref does not actually work with the new pandoc version, then raise an issue on GitHub. Either we can fix it, or we'll have to be patient and wait for an updated pandoc-crossref.

• Update the readme for each repository. This cannot be automated yet due to limitations of the Docker Hub API.

  • Run make docs-minimal | xclip -selection clipboard (or | pbcopy on mac)
  • Go to https://hub.docker.com/repository/docker/pandoc/minimal
  • Click the edit button next to "Readme".
  • Paste the content from the clipboard, replacing the old readme.
  • Save.

  Repeat for core and latex.

• Done.

Case: TeXLive was frozen

The tlmgr command in LaTeX images will start to behave badly every time a new TeXLive version is released. All images with the now frozen TeXLive version will have to be rebuilt.

• Change the variable default_version in file common/latex/install-texlive.sh to the current year.

• Rebuilt and push all images that come with the last, now frozen, TeXLive version. This will probably affect multiple versions. Put a line with all these version anywhere in the commit message. E.g.,

  release=2.17, 2.16.2
  

  The CI will then rebuild all specified versions.