Merge pull request #4611 from firedrakeproject/connorjward/merge-release

Merge release

Author: connorjward

.github/workflows/core.yml

@@ -82,7 +82,6 @@ jobs:
       OMP_NUM_THREADS: 1
       OPENBLAS_NUM_THREADS: 1
       FIREDRAKE_CI: 1
-      PYOP2_CI_TESTS: 1
       PYOP2_SPMD_STRICT: 1
       # NOTE: One should occasionally update test_durations.json by running
       # 'make test_durations' inside a 'firedrake:latest' Docker image.
@@ -134,17 +133,6 @@ jobs:
             exit 1
           fi
 
-      # Raise an error if any 'TODO RELEASE' comments remain
-      - name: Check no 'TODO RELEASE' comments (release only)
-        if: inputs.target_branch == 'release'
-        working-directory: firedrake-repo
-        run: |
-          if [ -z "$( grep -r --exclude-dir='.*' 'TODO RELEASE' )" ]; then
-            exit 0
-          else
-            exit 1
-          fi
-
       - name: Install system dependencies (2)
         run: |
           apt-get -y install \

.github/workflows/docker.yml

@@ -41,18 +41,11 @@ jobs:
       matrix:
         os: [Linux, macOS]
         arch: [default, complex]
-        platform: [linux/amd64, linux/arm64]
-        # Cannot use inputs in exclude clauses, so add a dummy matrix dim
-        build_dev:
-          - ${{ inputs.build_dev }}
-        # exclude incompatible os+platform, and only build linux dev containers
-        exclude:
-          - os: Linux
-            platform: linux/arm64
-          - os: macOS
-            platform: linux/amd64
-          - os: macOS
-            build_dev: true
+        include:
+        - os: Linux
+          platform: linux/amd64
+        - os: macOS
+          platform: linux/arm64
     uses: ./.github/workflows/docker_build.yml
     with:
       os: ${{ matrix.os }}

.github/workflows/release.yml

@@ -1,24 +1,72 @@
 name: Publish release
 
 on:
-  release:
-    types: [released]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: The branch to release from
+        type: string
+        required: true
+      version:
+        description: The version number to release
+        type: string
+        required: true
 
 jobs:
-  deploy:
+  check:
+    name: Pre-release checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: firedrake-repo
+          ref: ${{ inputs.branch }}
+
+      - name: Check no 'TODO RELEASE' comments remain
+        working-directory: firedrake-repo
+        run: |
+          if [ -z "$( grep -r --exclude-dir='.*' 'TODO RELEASE' )" ]; then
+            exit 0
+          else
+            exit 1
+          fi
+
+      - name: Check version number matches
+        working-directory: firedrake-repo
+        run: |
+          if [ -z "$( grep 'version = \"${{ inputs.version }}\"' pyproject.toml )" ]; then
+            exit 1
+          else
+            exit 0
+          fi
+
+  pypi:
     uses: ./.github/workflows/core.yml
+    needs: check
     with:
-      source_ref: release
+      source_ref: ${{ inputs.branch }}
       target_branch: release
       run_tests: false
       upload_pypi: true
     secrets: inherit
 
+  github_release:
+    name: Create GitHub release
+    needs: pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create ${{ inputs.version }} --title ${{ inputs.version }} --generate-notes
+
   docker:
     name: Build Docker containers
     uses: ./.github/workflows/docker.yml
+    needs: pypi
     with:
-      tag: ${{ github.ref_name }}
-      branch: ${{ github.ref_name }}
-      build_dev: false
+      tag: ${{ inputs.version }}
+      branch: ${{ inputs.branch }}
     secrets: inherit

docker/Dockerfile.vanilla

@@ -168,5 +168,5 @@ ENV PYOP2_CFLAGS=$CFLAGS
 
 # Run the smoke tests.
 RUN cd /opt/firedrake/ \
-    && firedrake-check \
+    && firedrake-check --mpiexec 'mpiexec --oversubscribe -n' \
     && firedrake-clean

firedrake/interpolation.py

@@ -205,6 +205,9 @@ def interpolate(expr, V, subset=None, access=None, allow_missing_dofs=False, def
 class Interpolator(abc.ABC):
     """A reusable interpolation object.
 
+    This object can be used to carry out the same interpolation
+    multiple times (for example in a timestepping loop).
+
     Parameters
     ----------
     expr
@@ -249,11 +252,8 @@ class Interpolator(abc.ABC):
         between a VOM and its input ordering. Defaults to ``True`` which uses SF broadcast
         and reduce operations.
 
-    This object can be used to carry out the same interpolation
-    multiple times (for example in a timestepping loop).
-
-    Note
-    ----
+    Notes
+    -----
 
        The :class:`Interpolator` holds a reference to the provided
        arguments (such that they won't be collected until the

pyop2/caching.py

@@ -32,7 +32,6 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 
 """Provides common base classes for cached objects."""
-import atexit
 import cachetools
 import functools
 import hashlib
@@ -61,9 +60,6 @@
 _CACHE_CIDX = count()
 _KNOWN_CACHES = []
 
-# Flag for outputting information at the end of testing (do not abuse!)
-_running_on_ci = bool(os.environ.get('PYOP2_CI_TESTS'))
-
 
 # FIXME: (Later) Remove ObjectCached
 class ObjectCached(object):
@@ -312,10 +308,6 @@ def print_cache_stats(*args, **kwargs):
         print(hline)
 
 
-if _running_on_ci:
-    print_cache_stats = atexit.register(print_cache_stats)
-
-
 class _CacheMiss:
     pass
 
@@ -488,7 +480,7 @@ class DEFAULT_CACHE(dict):
 # EXOTIC_CACHE = partial(instrument(cachetools.LRUCache), maxsize=100)
 
 # Turn on cache measurements if printing cache info is enabled
-if configuration["print_cache_info"] or _running_on_ci:
+if configuration["print_cache_info"]:
     DEFAULT_CACHE = instrument(DEFAULT_CACHE)
     DictLikeDiskAccess = instrument(DictLikeDiskAccess)
 

pyop2/mpi.py

@@ -76,8 +76,6 @@
 _DUPED_COMM_DICT = {}
 # Flag to indicate whether we are in cleanup (at exit)
 PYOP2_FINALIZED = False
-# Flag for outputting information at the end of testing (do not abuse!)
-_running_on_ci = bool(os.environ.get('PYOP2_CI_TESTS'))
 
 
 class PyOP2CommError(ValueError):
@@ -549,12 +547,10 @@ def finalize_safe_debug():
     finished writing debug information. In this case we fall back to using the
     Python `print` function to output debugging information.
 
-    Furthermore, we always want to see this finalization information when
-    running the CI tests.
     '''
     global debug
     if PYOP2_FINALIZED:
-        if logger.level > DEBUG and not _running_on_ci:
+        if logger.level > DEBUG:
             debug = lambda string: None
         else:
             debug = lambda string: print(string)

pyproject.toml

@@ -1,6 +1,7 @@
 [project]
 name = "firedrake"
 # <year>.<month>.<patch>
+# TODO RELEASE: remove '.dev0'
 version = "2025.5.0.dev0"
 description = "An automated system for the portable solution of partial differential equations using the finite element method"
 readme = "README.rst"
@@ -77,7 +78,7 @@ docs = [
   "matplotlib",  # needed to resolve API
   "numpydoc",
   "pylit",
-  "sphinx<8.2.0",  # https://github.com/firedrakeproject/firedrake/issues/4059
+  "sphinx",
   "sphinx-autobuild",
   "sphinx-reredirects",
   "sphinxcontrib-bibtex",

scripts/check-config

@@ -20,25 +20,12 @@ class InvalidConfigurationException(Exception):
 
 
 def main():
-    # TODO RELEASE
-    # check_firedrake_version()
     check_min_python_version()
     check_petsc_version()
     check_slepc_version()
     check_petsc_version_spec()
 
 
-def check_firedrake_version():
-    firedrake_version = check_file_contains_pattern(
-        REPO_ROOT / "pyproject.toml",
-        "version = \"(.*)\""
-    )
-    check_file_contains_pattern(
-        REPO_ROOT/"docs/source/install.rst",
-        f"https://raw.githubusercontent.com/firedrakeproject/firedrake/refs/tags/{firedrake_version}/scripts/firedrake-configure"
-    )
-
-
 def check_min_python_version() -> None:
     min_python_version = check_file_contains_pattern(
         REPO_ROOT / "pyproject.toml",