Merge branch 'main' of https://github.com/sunpy/ndcube into irregular_rebin

Author: DanRyanIrish

.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: cimg/python:3.10
+      - image: cimg/python:3.12
     environment:
       TOXENV=<< parameters.jobname >>
     steps:
@@ -57,7 +57,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: cimg/python:3.10
+      - image: cimg/python:3.12
     environment:
       TOXENV: << parameters.jobname >>
       GIT_SSH_COMMAND: ssh -i ~/.ssh/id_rsa_b1c8b094a8ec67162b0f18a949a6b1db
@@ -99,16 +99,16 @@ workflows:
           matrix:
             parameters:
               jobname:
-                - "py310-figure"
-                - "py310-figure-devdeps"
+                - "py312-figure"
+                - "py312-figure-devdeps"
 
       - deploy-reference-images:
           name: baseline-<< matrix.jobname >>
           matrix:
             parameters:
               jobname:
-                - "py310-figure"
-                - "py310-figure-devdeps"
+                - "py312-figure"
+                - "py312-figure-devdeps"
           requires:
             - << matrix.jobname >>
           filters:

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "00b247401fc4660d63583bb44117a84ecd36ae01",
+  "commit": "c66950b04d0a535002d122c9d5bc0f23534b530c",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -10,13 +10,20 @@
       "author_name": "The SunPy Community",
       "author_email": "sunpy@googlegroups.com",
       "project_url": "https://docs.sunpy.org/projects/ndcube",
+      "github_repo": "sunpy/ndcube",
+      "sourcecode_url": "https://github.com/sunpy/ndcube",
+      "download_url": "https://pypi.org/project/ndcube",
+      "documentation_url": "https://docs.sunpy.org/projects/ndcube",
+      "changelog_url": "https://docs.sunpy.org/projects/ndcube/en/stable/whatsnew/changelog.html",
+      "issue_tracker_url": "https://github.com/sunpy/ndcube/issues",
       "license": "BSD 2-Clause",
       "minimum_python_version": "3.10",
       "use_compiled_extensions": "n",
       "enable_dynamic_dev_versions": "y",
       "include_example_code": "n",
       "include_cruft_update_github_workflow": "y",
-      "_sphinx_theme": "alabaster",
+      "use_extended_ruff_linting": "y",
+      "_sphinx_theme": "sunpy",
       "_parent_project": "",
       "_install_requires": "",
       "_copy_without_render": [

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+# Main CI Workflow
 name: CI
 
 on:
@@ -21,7 +22,7 @@ concurrency:
 
 jobs:
   core:
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
       submodules: false
       coverage: codecov
@@ -37,15 +38,15 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.12'
       - run: python -m pip install -U --user build
       - run: python -m build . --sdist
       - run: python -m pip install -U --user twine
       - run: python -m twine check dist/*
 
   test:
     needs: [core, sdist_verify]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
       submodules: false
       coverage: codecov
@@ -60,9 +61,9 @@ jobs:
 
   docs:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
-      default_python: '3.10'
+      default_python: '3.12'
       submodules: false
       pytest: false
       toxdeps: tox-pypi-filter
@@ -84,9 +85,9 @@ jobs:
         github.event_name == 'pull_request' &&
         contains(github.event.pull_request.labels.*.name, 'Run cron CI')
       )
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
-      default_python: '3.10'
+      default_python: '3.12'
       submodules: false
       coverage: codecov
       toxdeps: tox-pypi-filter
@@ -95,23 +96,28 @@ jobs:
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  publish_pure:
-      if: |
-        github.event_name != 'pull_request' && (
-          github.ref_name != 'main' ||
-          github.event_name == 'workflow_dispatch' )
-      needs: [test, docs]
-      uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
-      with:
-        python-version: '3.10'
-        test_extras: 'tests'
-        test_command: 'pytest -p no:warnings --doctest-rst --pyargs ndcube'
-        submodules: false
-      secrets:
-        pypi_token: ${{ secrets.pypi_token }}
+  publish:
+    # Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
+    # see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
+    if: |
+      github.event_name != 'pull_request' ||
+      (
+        github.event_name == 'pull_request' &&
+        contains(github.event.pull_request.labels.*.name, 'Run publish')
+      )
+    needs: [test, docs]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
+    with:
+      python-version: '3.12'
+      test_extras: 'all,tests'
+      test_command: 'pytest -p no:warnings --doctest-rst --pyargs ndcube'
+      submodules: false
+    secrets:
+      pypi_token: ${{ secrets.pypi_token }}
+
   notify:
     if: always() && github.event_name == 'workflow_dispatch'
-    needs: [publish_pure, cron]
+    needs: [publish, cron]
     runs-on: ubuntu-latest
     steps:
       - uses: Cadair/matrix-notify-action@main

.github/workflows/label_sync.yml

@@ -0,0 +1,23 @@
+name: Label Sync
+on:
+  workflow_dispatch:
+  schedule:
+    #        ┌───────── minute (0 - 59)
+    #        │ ┌───────── hour (0 - 23)
+    #        │ │ ┌───────── day of the month (1 - 31)
+    #        │ │ │ ┌───────── month (1 - 12 or JAN-DEC)
+    #        │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
+    - cron: '0 0 * * *' # run every day at midnight UTC
+
+# Give permissions to write issue labels
+permissions:
+  issues: write
+
+jobs:
+  label_sync:
+    runs-on: ubuntu-latest
+    name: Label Sync
+    steps:
+      - uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd
+        with:
+          config-file: https://raw.githubusercontent.com/sunpy/.github/main/labels.yml

.github/workflows/sub_package_update.yml

@@ -21,14 +21,6 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: true
-      matrix:
-        include:
-          - add-paths: .
-            body: apply the changes to this repo.
-            branch: cruft/update
-            commit-message: "Automatic package template update"
-            title: Updates from the package template
-
     steps:
       - uses: actions/checkout@v4
 
@@ -55,25 +47,47 @@ jobs:
           echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
 
       - name: Run update if available
+        id: cruft_update
         if: steps.check.outputs.has_changes == '1'
         run: |
           git config --global user.email "${{ github.actor }}@users.noreply.github.com"
           git config --global user.name "${{ github.actor }}"
 
-          cruft update --skip-apply-ask --refresh-private-variables
+          cruft_output=$(cruft update --skip-apply-ask --refresh-private-variables)
+          echo $cruft_output
           git restore --staged .
 
-      - name: Create pull request
+          if [[ "$cruft_output" == *"Failed to cleanly apply the update, there may be merge conflicts."* ]]; then
+            echo merge_conflicts=1 >> $GITHUB_OUTPUT
+          else
+            echo merge_conflicts=0 >> $GITHUB_OUTPUT
+          fi
+
+      - name: Check if only .cruft.json is modified
+        id: cruft_json
         if: steps.check.outputs.has_changes == '1'
-        uses: peter-evans/create-pull-request@v6
+        run: |
+          git status --porcelain=1
+          if [[ "$(git status --porcelain=1)" == " M .cruft.json" ]]; then
+            echo "Only .cruft.json is modified. Exiting workflow early."
+            echo "has_changes=0" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_changes=1" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create pull request
+        if: steps.cruft_json.outputs.has_changes == '1'
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          add-paths: ${{ matrix.add-paths }}
-          commit-message: ${{ matrix.commit-message }}
-          branch: ${{ matrix.branch }}
+          add-paths: "."
+          commit-message: "Automatic package template update"
+          branch: "cruft/update"
           delete-branch: true
-          branch-suffix: timestamp
-          title: ${{ matrix.title }}
+          draft: ${{ steps.cruft_update.outputs.merge_conflicts == '1' }}
+          title: "Updates from the package template"
           body: |
-            This is an autogenerated PR, which will ${{ matrix.body }}.
-            [Cruft](https://cruft.github.io/cruft/) has detected updates from the Package Template
+            This is an autogenerated PR, which will applies the latest changes from the [SunPy Package Template](https://github.com/sunpy/package-template).
+            If this pull request has been opened as a draft there are conflicts which need fixing.
+
+            **To run the CI on this pull request you will need to close it and reopen it.**

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.4.7"
+    rev: "v0.8.2"
     hooks:
       - id: ruff
         args: ["--fix"]
@@ -11,7 +11,7 @@ repos:
       - id: isort
         exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|ndcube/extern)$"
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-ast
       - id: check-case-conflict

.readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-lts-latest
   tools:
-    python: "mambaforge-4.10"
+    python: "mambaforge-latest"
   jobs:
     post_checkout:
       - git fetch --unshallow || true

.rtd-environment.yml

@@ -2,6 +2,6 @@ name: ndcube
 channels:
   - conda-forge
 dependencies:
-  - python=3.11
+  - python=3.12
   - pip
   - graphviz!=2.42.*,!=2.43.*