For new releases, build an apptainer SIF image and host it as a GitHub package

Author: marcelzwiers

.github/workflows/build-apptainer.yml

@@ -0,0 +1,33 @@
+name: build-apptainer.yml
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'           # Push events to regular version tags only
+    branches:
+      - master
+
+jobs:
+  build-test-container:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    container:
+        image: kaczmarj/apptainer:latest
+        options: --privileged
+
+    name: Build Apptainer
+    steps:
+
+      - name: Check out code for the container builds
+        uses: actions/checkout@v4
+
+      - name: Build SIF image
+        run: |
+           apptainer build bidscoin.sif apptainer.def
+
+      - name: Login and Deploy Container
+        run: |
+           echo ${{ secrets.GITHUB_TOKEN }} | apptainer remote login -u ${{ secrets.GHCR_USERNAME }} --password-stdin oras://ghcr.io
+           apptainer push bidscoin.sif oras://ghcr.io/${GITHUB_REPOSITORY}:${tag}

docs/installation.rst

@@ -100,10 +100,15 @@ The current Apptainer image includes:
 
 This image does not include FreeSurfer/synthstrip (needed for ``skullstrip``)
 
+Downloading the container image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can download Apptainer images `directly from GiHub packages <https://github.com/orgs/Donders-Institute/packages?repo_name=bidscoin>`__
+
 Building the container image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Download the Apptainer `definition file <https://github.com/Donders-Institute/bidscoin/blob/master/apptainer.def>`__ and execute the following command to build a BIDScoin container image:
+If you want to build the BIDScoin container image yourself, you can download the Apptainer `definition file <https://github.com/Donders-Institute/bidscoin/blob/master/apptainer.def>`__ and execute the following command:
 
 .. code-block:: console