Skip to content

Release Process

Jump to bottom
Sebastian Ehlert edited this page Mar 15, 2022 · 16 revisions

Creating Fpm releases

This guide describes how to create a new fpm release.

Release workflow

Important, always use a branch in your fork for the release preparation steps.

  1. Make sure to enable GitHub actions on your fork (visit the actions tab, required only once)
  2. Bump the version in fpm.toml and in the CLI output in src/fpm_command_line.f90
  3. Create a new test release in your fork, the release tag is always prefixed, i.e. version 0.4.0 is tagged as v0.4.0.
  4. Wait for the workflow to publish the release artifacts to your test release tag
  5. Open a PR against the main repository:
    • include a link to your test release tag
    • add the release notes, usual sections are Changed, New Features, Fixed and link with the respective PRs
    • wait for feedback and test the binaries from the test release tag
  6. Merge the PR and create the actual release tag in the main repository

The release at GitHub will automatically be announced to everybody watching the repository for releases.

Release aftermath

After creating the release there is still work to be done.

Announcing the release

Additionally to GitHub's release notification the release should be announced at the Fortran-lang discourse and via the @fortranlang Twitter account.

Fpm documentation

Add a new post with the release notes to the fpm documentation, by creating a new post in the news directory. The front matter of the post is formatted as

---
author: ...
date: YYYY-MM-DD
category: release
...

# Fpm version <version> released

The post is translatable like everything in the fpm documentation, make sure to ping the translators.

Conda-forge package

We package fpm on conda-forge. To update the conda package fork the fpm-feedstock. Updating the recipe (recipe/meta.yaml) can be done in the GitHub web interface or by cloning the repository, make sure to create a branch in your fork for this purpose.

The following steps should be sufficient for updating

  1. Download the source tarball from the release tag
  2. Get its SHA256 checksum
  3. Update the version number and the checksum in the recipe and reset the build number to 0 if necessary.
  4. Rerender the feedstock (only if you are working locally)
  5. Create a new PR against the main feedstock
  6. Request the bot to rerender (only if you haven't rerendered locally)
  7. Wait for the maintainers to approve and merge

You can also wait for the regro-autotick-bot to perform this steps, but this introduces some latency (only hours not days).

To rerender locally use

mamba create -n build conda-build conda-smithy conda-forge-pinning -c conda-forge
conda activate build
conda smithy rerender

If you don't have mamba, you can also use conda for the command, but it is better to simply install mamba first.

MSYS2 package

We package fpm for Windows with the MSYS2 toolchain. To update the MSYS2 package fork the MINGW-packages repository. Updating the package file (mingw-w64-fpm/PKGBUILD) can be done in the GitHub web interface or by cloning the repository, make sure to create a branch in your fork for this purpose.

The following steps should be sufficient for updating

  1. Download the source tarball from the release tag
  2. Get its SHA256 checksum
  3. Update the version number and the checksum in the recipe and reset the pkgrel number to 1 if necessary
  4. Create a new PR against the main repository
  5. Wait for the maintainers to approve and merge

The MSYS2 maintainer will sign the package and upload it to the package mirror, this can take several hours.

Spack package

We package fpm with spack. To update the spack package fork the spack repository. The package file can be found in var/spack/repos/builtin/packages/fpm/package.py.

  1. Download the source tarball from the release tag
  2. Get its SHA256 checksum
  3. Add the new version the package file
  4. Create a new PR against the main repositories develop branch
  5. Wait for the maintainers to approve and merge
Clone this wiki locally