Merge pull request #645 from DeepRank/release_3.1.0_gcroci2

release: v3.1.0

Author: gcroci2

.bumpversion.cfg

@@ -0,0 +1,17 @@
+[tool.bumpversion]
+current_version = "3.1.0"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "CITATION.cff"
+search = 'version: "{current_version}"'
+replace = 'version: "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "deeprank2/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'

.bumpversion.toml

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: 2022 Dusan Mijatovic (dv4all)
+# SPDX-FileCopyrightText: 2022 dv4all
+# SPDX-FileCopyrightText: 2024 Ewan Cahen (Netherlands eScience Center) <e.cahen@esciencecenter.nl>
+# SPDX-FileCopyrightText: 2024 Netherlands eScience Center
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: reusable ghcr.io module
+
+on:
+  workflow_call:
+    inputs:
+      ghcr_user:
+        required: true
+        description: User for logging to ghcr.io (use github.actor)
+        type: string
+      base_image_name:
+        required: true
+        description: Base image name incl. ghcr.io
+        type: string
+      image_tag:
+        required: true
+        description: Image tag (version)
+        type: string
+      dockerfile:
+        required: true
+        description: Location and name of docker file
+        type: string
+      docker_context:
+        required: true
+        description: Docker context for the build command
+        type: string
+    secrets:
+      token:
+        required: true
+    outputs:
+      image_created:
+        description: Full image name after upload to ghcr.io
+        value: ${{jobs.build_and_push.outputs.image_build}}
+      image_uploaded:
+        description: Confirmation that image is uploaded to ghcr.io
+        value: ${{jobs.build_and_push.outputs.image_pushed}}
+
+jobs:
+  build_and_push:
+    name: build and push image
+    runs-on: ubuntu-22.04
+    outputs:
+      image_build: ${{steps.build_image.outputs.image_build}}
+      image_pushed: ${{steps.build_image.outputs.image_pushed}}
+    steps:
+      - name: checkout
+        # https://github.com/actions/checkout
+        uses: actions/checkout@v4
+      - name: build
+        id: build_image
+        run: |
+          IMAGE_TAG_VERSION=${{inputs.base_image_name}}:${{inputs.image_tag}}
+          IMAGE_TAG_LASTEST=${{inputs.base_image_name}}:latest
+          echo image_tag_version $IMAGE_TAG_VERSION
+          docker build -t $IMAGE_TAG_VERSION -t $IMAGE_TAG_LASTEST -f ${{inputs.dockerfile}} ${{inputs.docker_context}}
+          echo "{image_build}={$IMAGE_TAG_VERSIONvalue}" >> $GITHUB_OUTPUT
+      - name: push to ghcr.io
+        id: push_image
+        run: |
+          echo login
+          echo "${{secrets.token}}" | docker login https://ghcr.io -u ${{inputs.ghcr_user}} --password-stdin
+          echo push auth image with all tags
+          docker push ${{inputs.base_image_name}} --all-tags
+          echo "{image_build}={$IMAGE_TAG_VERSIONvalue}" >> $GITHUB_OUTPUT

.github/workflows/_ghcr.yml

@@ -3,7 +3,7 @@ name: build (latest release)
 # Only trigger, when the release workflow succeeded
 on:
   workflow_run:
-    workflows: ["Build and upload to PyPI"]
+    workflows: ["Build and upload to PyPI and ghcr.io"]
     types:
       - completed
 
@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-22.04"]
         python-version: ["3.10"] # ["3.10", "3.11"]
 
     # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell

.github/workflows/build-latest-release.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-22.04"]
         python-version: ["3.10"] # ["3.10", "3.11"]
 
     # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell

.github/workflows/build-repo-frozen-env.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-22.04"]
         python-version: ["3.10"] # ["3.10", "3.11"]
 
     # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell

.github/workflows/build-repo.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   validate:
     name: "validate"
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Check out a copy of the repository
         uses: actions/checkout@v3

.github/workflows/cffconvert.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-22.04"]
         python-version: ["3.10"]
 
     # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell

.github/workflows/coveralls.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   paper:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Paper Draft
     steps:
       - name: Checkout

.github/workflows/draft-pdf.yml

@@ -11,7 +11,7 @@ jobs:
   verify:
     if: github.event.pull_request.draft == false
     name: "fair-software"
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: fair-software/howfairis-github-action@0.2.1
         name: Measure compliance with fair-software.eu recommendations