add versioning

Author: MaximeBICMTL

.github/workflows/checks.yml

@@ -2,9 +2,13 @@ name: Python checks
 
 on:
   push:
-    branches: [main]
+    branches:
+      - main
+      - 'release-*'
   pull_request:
-    branches: [main]
+    branches:
+      - main
+      - 'release-*'
 
 jobs:
   ruff:

.github/workflows/release.yml

@@ -4,14 +4,65 @@ on:
   push:
     branches:
     - main
+    - 'release-*'
 
 permissions:
   contents: write
   packages: write
 
 jobs:
+  check-version:
+    name: Detect version
+    runs-on: ubuntu-latest
+    outputs:
+      name: ${{ steps.detect.outputs.name }}
+      description: ${{ steps.detect.outputs.description }}
+      prerelease: ${{ steps.detect.outputs.prerelease }}
+    steps:
+    - name: Checkout the repository
+      uses: actions/checkout@v4
+    - name: Detect version and release type
+      id: detect
+      run: |
+        if [[ "${{ github.ref }}" == refs/heads/main ]]; then
+          NAME="latest"
+          DESCRIPTION="Latest development build"
+          PRERELEASE="true"
+        elif [[ "${{ github.ref }}" =~ refs/heads/release-.* ]]; then
+          VERSION="${GITHUB_REF#refs/heads/release-}"
+
+          # Extract package version from the pyproject file.
+          PYPROJECT_VERSION=$(grep -E '^version = ' pyproject.toml | cut -d '"' -f 2)
+
+          # Check that a version has been found.
+          if [[ -z "$PYPROJECT_VERSION" ]]; then
+            echo "Error: No package version found in pyproject.toml"
+            exit 1
+          fi
+
+          # Compare branch and package versions.
+          if [[ "$VERSION" != "$PYPROJECT_VERSION" ]]; then
+            echo "Error: Version mismatch"
+            echo "Branch version: $VERSION"
+            echo "Package version: $PYPROJECT_VERSION"
+            exit 1
+          fi
+
+          NAME="$VERSION"
+          DESCRIPTION="Release $VERSION"
+          PRERELEASE="false"
+        else
+          echo "Error: Unsupported branch"
+          exit 1
+        fi
+
+        echo "name=$NAME" >> $GITHUB_OUTPUT
+        echo "description=$DESCRIPTION" >> $GITHUB_OUTPUT
+        echo "prerelease=$PRERELEASE" >> $GITHUB_OUTPUT
+
   release-executable:
     name: Release executable
+    needs: check-version
     runs-on: ubuntu-latest
 
     steps:
@@ -30,29 +81,32 @@ jobs:
         mkdir dist
         docker run --mount type=bind,src=$(pwd)/dist,dst=/mni_7t_dicom_to_bids/dist compile_mni_7t_dicom_to_bids
 
-    - name: Delete old latest release
+    - name: Delete existing release
       run: |
-        gh release delete latest --yes || true
+        gh release delete "${{ needs.check-version.outputs.name }}" --yes || true
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Create latest release
+    - name: Create release
       uses: softprops/action-gh-release@v2
       with:
-        tag_name: latest
-        name: "Latest development build"
+        tag_name: ${{ needs.check-version.outputs.name }}
+        name: "${{ needs.check-version.outputs.description }}"
         body: |
-          **Automated development build**
+          **${{ needs.check-version.outputs.description }}**
 
+          - **Version:** ${{ needs.check-version.outputs.name }}
           - **Commit:** ${{ github.sha }}
           - **Date:** ${{ github.event.head_commit.timestamp }}
+          - **Branch:** ${{ github.ref_name }}
         draft: false
-        prerelease: true
+        prerelease: ${{ needs.check-version.outputs.prerelease }}
         generate_release_notes: false
         files: dist/mni7t_dcm2bids
 
   release-image:
     name: Release image
+    needs: check-version
     runs-on: ubuntu-latest
 
     steps:
@@ -66,7 +120,7 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build Inventory Image
+      - name: Build and push Docker image
         run: |
-          docker build . --tag ghcr.io/bic-mni/mni-7t-dicom-to-bids:latest
-          docker push ghcr.io/bic-mni/mni-7t-dicom-to-bids:latest
+          docker build . --tag ghcr.io/bic-mni/mni-7t-dicom-to-bids:${{ needs.check-version.outputs.name }}
+          docker push ghcr.io/bic-mni/mni-7t-dicom-to-bids:${{ needs.check-version.outputs.name }}

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mni_7t_dicom_to_bids"
-version = "0.0.0"
+version = "0.1.0"
 readme = "README.md"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]

src/mni_7t_dicom_to_bids/pipeline.py

@@ -9,10 +9,13 @@
     print_found_ignored_dicom_series,
     print_found_mapped_bids_acquisitions,
     print_found_unknown_dicom_series,
+    print_version,
 )
 
 
 def mni_7t_dicom_to_bids(args: Args):
+    print_version()
+
     check_dicom_to_niix()
 
     dicom_series_list = group_dicom_series(args.dicom_study_path)

src/mni_7t_dicom_to_bids/print.py

@@ -1,4 +1,5 @@
 import os
+from importlib.metadata import version
 from shlex import quote
 
 from bic_util.print import print_error_exit, print_warning
@@ -7,6 +8,22 @@
 from mni_7t_dicom_to_bids.dataclass import DicomBidsMapping, DicomSeriesInfo
 
 
+def get_version() -> str:
+    """
+    Get the version of the current MNI 7T DICOM to BIDS package.
+    """
+
+    return version('mni_7t_dicom_to_bids')
+
+
+def print_version():
+    """
+    Print the version of the current MNI 7T DICOM to BIDS package.
+    """
+
+    print(f"Running the MNI 7T DICOM to BIDS converter version {get_version()}.")
+
+
 def print_found_dicom_series(dicom_series_list: list[DicomSeriesInfo]):
     """
     Print the DICOM series found in the DICOM study to the user.

src/mni_7t_dicom_to_bids/scripts/run_mni7t_dcm2bids.py

@@ -6,17 +6,22 @@
 
 from mni_7t_dicom_to_bids.args import ConvertUnknownsArg, process_args
 from mni_7t_dicom_to_bids.pipeline import mni_7t_dicom_to_bids
+from mni_7t_dicom_to_bids.print import get_version
 
 
 def main():
-
-    # Parse CLI arguments
+    # Parse CLI arguments.
 
     parser = argparse.ArgumentParser(
         prog='mni7t_dcm2bids',
         description="Convert a DICOM study to BIDS using the MNI 7T conversion configuration.",
     )
 
+    parser.add_argument('--version',
+        action='version',
+        version=get_version(),
+        help="Print the MNI 7T DICOM to BIDS converter version number and exit.")
+
     parser.add_argument('dicom_study_path',
         help="Path of the input DICOM study directory.")
 
@@ -53,7 +58,7 @@ def main():
         action='store_true',
         help="Overwrite files in the BIDS dataset if they already exist.")
 
-    # Process CLI arguments
+    # Process CLI arguments.
 
     args = process_args(parser.parse_args())