Release instructions - neutronimaging/imagingsuite GitHub Wiki

Introduction

The release of a new official version of an application includes the following steps. The release process will only be executed by the development team after completed debugging and testing phase.

Packaging

Use the build, deploy, and packaging scripts scripts for the application you want to deploy. Build scripts are located in the folder imagingsuite/build that contains build scripts for MacOS, Windows, and Ubuntu Linux. A typical process to package MuhRec on Mac would be:

imagingsuite/build_all.sh
imagingsuite/applications/muhrec/deploymuhrec_mac.sh
imagingsuite/applications/muhrec/package_mac.sh

Which would create the artefact muhrec_YYYYMMDD.dmg. A similar procedure can be done for Linux and Windows.

Package testing

The testing shall be done on a vanilla system, i.e. the test system shall not have the development tools installed.

  1. Unpack/install the package on the computer.
  2. Start the application.
  3. Run a basic processing task using test data.
  4. Inspect UI behaviour on different screen sizes and OS.

Release note

Write release note for the application. The document is located in the application folder. The note shall describe latest updates and fixed issues. In addition is should also mention known critical issues and provide a link to the GitHub issues. The release note will be added to the release upload. Extracting detailed release info:

  1. The script imagingsuite/build/loghistory.sh lists all commits since a year back.
  2. git log --pretty=format:"%h - %an, %ar : %s" --since=2.years > ~/gitlog.txt
  3. Make a list of closed issues related to the application since the last release.
    curl -i "https://api.github.com/repos/neutronimaging/imagingsuite/issues?state=closed"

Uploading

Go to the release page and select draft new release.

  • Add the release note text
  • Upload the binary assets to be included in the release
  • Press submit release.

Prepare DOI

Go to zenodo.org (Only @anderskaestner) and locate the DOI for the latest release. GitHub is linked to Zenodo and updates DOIs automatically. You do however need revise some text slightly and update the author list.

Copy the DOI badge link and insert it into the release note on GitHub.

Notify the user community

Send notification mails to:

  • DMSC + Steering committee + ODIN team
  • SINE2020
  • EXTREMA mailing list (COST action MP1207)
  • ISNR mailing list
  • Users registered on the mailing list.

There may be overlaps between these lists...

⚠️ **GitHub.com Fallback** ⚠️