Skip to content

Creating a Release

Michael Quellmalz edited this page Jun 3, 2020 · 1 revision

Preparation

  • Check if all issues corresponding to the release are closed (postpone some issues to a later release, if necessary)
  • Create the release branch release/3.x.x
  • Update ChangeLog
  • Update the documentation, if necessary
  • Check if NFFT_VERSION in configure.ac is correct
  • Bump the SHARED_VERSION_INFO in configure.ac if necessary

Testing

  • Create a release 3.x.x-rc1 in Github (Marked as Pre-release) from the release branch (the corresponding tag is created automatically)
  • Run all tests from the Github Release Assets (nfft-3.x.x.tar.gz)
  • Test the build scripts (windows-build-mex.sh, linux-build-mex.sh, and macos-build-mex.sh) and update if necessary
  • Perform exhaustive unit tests (configure with --enable-exhaustive-unit-tests) with Matlab on both Windows and Linux
  • Check that the doxygen documentation in doc/html
  • Repeat this process if necessary

Create the release

  • Merge branch release/3.x.x into master
  • Create the release from master branch
  • Add release to the webpage
  • Build the binaries and add them to the webpage
  • Add the current doxygen documentation to the webpage, if it changed

Afterwards

  • Merge branch master into develop
  • Bump NFFT_VERSION in configure.ac
Clone this wiki locally