Skip to content

Latest commit

 

History

History
99 lines (58 loc) · 2.42 KB

RELEASE_PROCEDURE.md

File metadata and controls

99 lines (58 loc) · 2.42 KB

Trip Version 2 - Release Procedure

Changelog

  1. Update ./CHANGELOG.md with the changes in this release.

Version Control

  1. Update master branch in trip-server-common sub-project

  2. Push master branch in trip-server-common sub-project

  3. Checkin the updated master branch from the trip-server-common sub-project

Build

  1. Update version number in configure.ac

  2. Create the distribution tarballs

    $ autoreconf -i
$ ./configure
$ make -j 8 check
$ PKG_CONFIG_PATH=\
/usr/local/lib/pkgconfig:/opt/local/lib/postgresql15/pkgconfig \
MAKEFLAGS='-j 8' make distcheck

  3. Create SHA256 sums for the tarballs

  4. Copy the tarballs to the download site

  5. Build PDF and HTML docs

    $ make html pdf

  6. Check in the changed files, including the updated po language files

Docker

  1. Optionally, check the Dockerfile has been updated to the use the correct release version number. The version information is updated by configure when Dockerfile is created from Dockerfile.in.

    $ grep 'ARG TRIP_SERVER_VERSION' Dockerfile
$ grep LABEL Dockerfile Dockerfile-postgis

  2. Build the Docker images, e.g.

    1. Optionally, Update Dockerfile-postgis to use the latest PostgreSQL build.

    2. Build the trip-database and trip-server images:

      $ DOCKER=podman PUSH=n ./docker-build.sh

  3. Test the Dockerfile

    $ docker compose up --no-recreate --detach
$ docker compose logs --follow

    Stop the container, optionally with (use the --volumes switch to also remove the database volume):

    $ docker compose down --volumes

Installation

$ ./configure
$ make
$ make html pdf
$ sudo make install install-html install-pdf

Release

  1. Copy the builds, SHA256 sums, HTML and PDF docs to the Trip Server 2 website

  2. Update the index page with details of the new release

  3. Update the symbolic link to point to the latest docs

  4. Tag the master branch of the parent project with release version number

  5. Push the master branch and check https://www.fdsd.co.uk/trip-server-2/readme.html has been updated

  6. Push Docker images:

    $ MAKEFLAGS='-j 4' DOCKER=podman ./docker-build.sh

Validation

  1. Check the website links for all the user documentation

  2. Check the Help menu item correctly links to the latest user guide

  3. Check the tarballs download

  4. Download the checksums file and validate against the downloaded tarballs