Release v2.5.1.0 (#212)

* Lint markdown files and update files correspondingly. (#180) * Add Cython as dependency required during installation (#177) * Adapt Docker workflow according to new system tests design (#186) - modify args to fit to systemtest - make the manual triggering more useful - move latest tag to last master * bash string handling... Fun stuff * sprinkle in some " * adding some "debug" ouptut * Update .github/workflows/build-docker.yml * Require setuptools>=61 (#207) * Restrict to numpy < 2 and setuptools < 72 for better compatibiltiy with CI pipeline (#213) * Simplify setup.py w.r.t noisy warning (always shown when building with spack). * Use Ubuntu 24.04. * Explicitly specify docker image tags in CI. * use spack base image precice/ci-spack-pyprecice-deps-2404:2.5.1.0 * use precice base image precice/precice:2.5.1 * Add entry in changelog. * Fix spack workflow for 2.5.1.0. * Add branch for release candidate of 2.5.1.0 * Update build dependencies for release candidate * Use PyPI token instead of username and password in the package publishing action --------- Co-authored-by: Ishaan Desai <[email protected]> Co-authored-by: valentin-seitz <[email protected]> Co-authored-by: Valentin Seitz <[email protected]> Co-authored-by: Gerasimos Chourdakis <[email protected]>
precice · Dec 5, 2024 · d2d4d97 · d2d4d97
1 parent f0786b3
commit d2d4d97
Show file tree

Hide file tree

Showing 19 changed files with 249 additions and 174 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -13,7 +13,7 @@ jobs:
     needs: [setup_test]
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository
@@ -37,7 +37,7 @@ jobs:
     name: Run setup install
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository
@@ -62,7 +62,7 @@ jobs:
     needs: [setup_install]
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository
@@ -119,7 +119,7 @@ jobs:
     needs: [setup_test]
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository
@@ -140,7 +140,7 @@ jobs:
     needs: [setup_install, setup_test]
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository

diff --git a/.github/workflows/build-docker.yml b/.github/workflows/build-docker.yml
@@ -1,22 +1,39 @@
 name: Update docker image
 
 on:
-  workflow_dispatch:      # Trigger by hand from the UI
+  workflow_dispatch: # Trigger by hand from the UI
+    inputs:
+      branch:
+        type: choice
+        description: branch to build the image from
+        options:
+          - develop
   push:
     branches:
       - develop
 
+
 jobs:
   build-and-release-docker-image:
     name: Builds a dockerimage with the python bindings of preCICE
     runs-on: ubuntu-latest
     env:
         docker_username: precice
     steps:
-      - name: Get branch name
-        if: github.event_name != 'pull_request'
+      - name: Set branch name for manual triggering
+        if: github.event_name == 'workflow_dispatch'
+        shell: bash
+        run: echo "BINDINGS_REF=${{ inputs.branch }}" >> $GITHUB_ENV
+      - name: Set branch name for "on pull request" triggering
+        if: github.event_name != 'pull_request' && github.event_name != 'workflow_dispatch'
+        shell: bash
+        run: echo "BINDINGS_REF=${{ github.ref_name }}" >> $GITHUB_ENV
+      - name: Set PRECICE_TAG and the TAG depending on branch
         shell: bash
-        run: echo "branch=$(echo ${GITHUB_REF#refs/heads/} | tr / -)" >> $GITHUB_ENV    
+        run: |
+          echo "PRECICE_TAG=${{ env.BINDINGS_REF }}" >> "$GITHUB_ENV"
+          echo "TAG=${{ env.BINDINGS_REF }}" >> "$GITHUB_ENV"
+          echo "Building TAG: ${{ env.BINDINGS_REF }}"
       - name: Checkout Repository
         uses: actions/checkout@v2
       - name: Set up Docker Buildx
@@ -31,6 +48,7 @@ jobs:
         with:
           push: true
           file: "./tools/releasing/packaging/docker/Dockerfile"
-          tags: ${{ env.docker_username }}/python-bindings:${{ env.branch }},${{ env.docker_username }}/python-bindings:latest
+          tags: ${{ env.docker_username }}/python-bindings:${{ env.TAG }}
           build-args: |
-            branch=${{ env.branch }}
+            PRECICE_TAG=${{ env.PRECICE_TAG }}
+            PYTHON_BINDINGS_REF=${{ env.BINDINGS_REF }}
diff --git a/.github/workflows/build-env.yml b/.github/workflows/build-env.yml
@@ -2,6 +2,12 @@ name: Update build environment
 
 on:
   workflow_dispatch:      # Trigger by hand from the UI
+    inputs:
+      tag:
+        description: 'tag for docker image'
+        required: true
+        default: 'latest'
+        type: string
   schedule:
     - cron: '0 0 * * 0'   # Schedule it every Sunday
 
@@ -24,5 +30,5 @@ jobs:
         with:
           push: true
           context: .
-          file: spack/ci-spack-pyprecice-deps-2204.dockerfile
-          tags: precice/ci-spack-pyprecice-deps-2204
+          file: spack/ci-spack-pyprecice-deps-2404.dockerfile
+          tags: precice/ci-spack-pyprecice-deps-2404:${{ inputs.tag }}
diff --git a/.github/workflows/build-spack.yml b/.github/workflows/build-spack.yml
@@ -1,35 +1,35 @@
-# name: Build Spack
-# on:
-#   push:
-#     branches:
-#       - "*"
-#   pull_request:
-#     branches:
-#       - "*"
-#   schedule:
-#     - cron: '0 4 * * 1'   # Schedule it every Sunday
-#
-# jobs:
-#   build_spack:
-#     name: build_spack
-#     runs-on: ubuntu-latest
-#     timeout-minutes: 15
-#     container: precice/ci-spack-pyprecice-deps-2204
-#     defaults:
-#       run:
-#         shell: "bash --login -eo pipefail {0}"
-#     steps:
-#       - name: Checkout Repository
-#         uses: actions/checkout@v2
-#       - name: Move Package Script
-#         run: |
-#           cp -r spack/repo/packages/py-pyprecice/ /py-pyprecice-repo/packages/
-#       - name: Try to build py-pyprecice with spack and test it
-#         run: |
-#           . /opt/spack/share/spack/setup-env.sh
-#           spack env activate ci && spack arch
-#           spack remove py-pyprecice
-#           spack add pyprecice.test.py-pyprecice@develop && spack develop pyprecice.test.py-pyprecice@develop
-#           spack install && spack find
-#           spack load py-pyprecice
-#           BINDINGS_VERSION=$(python3 -c "import precice; print(precice.__version__)") && echo "Installed version of bindings is ${BINDINGS_VERSION}"
+name: Build Spack
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+  schedule:
+    - cron: '0 4 * * 1'   # Schedule it every Sunday
+
+jobs:
+  build_spack:
+    name: build_spack
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    container: precice/ci-spack-pyprecice-deps-2404:2.5.1.0
+    defaults:
+      run:
+        shell: "bash --login -eo pipefail {0}"
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Move Package Script
+        run: |
+          cp -r spack/repo/packages/py-pyprecice/ /py-pyprecice-repo/packages/
+      - name: Try to build py-pyprecice with spack and test it
+        run: |
+          . /opt/spack/share/spack/setup-env.sh
+          spack env activate ci && spack arch
+          spack remove py-pyprecice
+          spack add pyprecice.test.py-pyprecice@2.5.1.0 && spack develop pyprecice.test.py-pyprecice@2.5.1.0
+          spack install && spack find
+          spack load py-pyprecice
+          BINDINGS_VERSION=$(python3 -c "import precice; print(precice.__version__)") && echo "Installed version of bindings is ${BINDINGS_VERSION}"
diff --git a/.github/workflows/check-markdown.yml b/.github/workflows/check-markdown.yml
@@ -0,0 +1,14 @@
+name: Lint docs
+on: [push, pull_request]
+jobs:
+  check_md:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+      - name: Lint markdown files (markdownlint)
+        uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.json
+          files: '.'
+          ignore: changelog-entries
diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -27,8 +27,8 @@ jobs:
           pkgconfig
     - name: Build and publish
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
       run: |
         python setup.py sdist
         twine upload dist/*
diff --git a/.github/workflows/run-solverdummy.yml b/.github/workflows/run-solverdummy.yml
@@ -11,7 +11,7 @@ jobs:
     name: Run solverdummies
     runs-on: ubuntu-latest
     container:
-      image: precice/precice:latest
+      image: precice/precice:2.5.1
       options: --user root
     steps:
       - name: Checkout Repository

diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,7 @@
+{
+    "MD013": false,
+    "MD014": false,
+    "MD024": false,
+    "MD034": false,
+    "MD033": false
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.5.1.0
+
+* Backported trivial changes from v3. https://github.com/precice/python-bindings/issues/203
+
 ## 2.5.0.4
 
 * Add `tag_prefix = v` in versioneer configuration of `setup.cfg`.