GitHub Action to setup singularity

The setup-apptainer GitHub Action contains newer versions of the open source fork of Singularity. Please use the setup-apptainer GitHub Action instead of this one.

To use Singularity containers in a workflow you need to install it first. This GitHub Action downloads, compiles and installs it for you.

The setup will add the singularity executable to the PATH env var so it can be called in later steps. It also sets SINGULARITY_ROOT env var to the location where singularity was installed.

Inputs

singularity-version

Version of singularity. See releases page for available versions. If a binary build of a version is available on https://github.com/eWaterCycle/singularity-versions/releases it is used otherwise the version is build during the action, which requires a go installation and takes significantly longer.

Example usage

steps:
- uses: actions/checkout@v2
- uses: eWaterCycle/setup-singularity@v7
  with:
    singularity-version: 3.8.3
- name: Run a singularity container
  run: singularity run docker://alpine cat /etc/os-release

Build

For developers of setup-singularity action.

Install deps with

npm install

Build dist with

npm run build