To use apptainer 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 apptainer executable to the PATH env var so it can be called in later steps.

Version of apptainer. See releases page for available versions. Version string should start with major version, not with v character.

steps:
- uses: actions/checkout@v2
- uses: eWaterCycle/setup-apptainer@v1
  with:
    apptainer-version: 1.0.3
- name: Run an apptainer container
  run: apptainer run docker://alpine cat /etc/os-release

For developers of setup-apptainer action.

First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation

You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)

uses: ./
with:
  apptainer-version: 1.0.3

See the actions tab for runs of this action! 🚀

After testing you can create a v1 tag to reference the stable and latest V1 action