Merge branch 'main' into gd/coherent_map

Author: gdalle

.JuliaFormatter.toml

@@ -1,6 +1,3 @@
 style = "blue"
-align_assignment = true
-align_struct_field = true
-align_conditional = true
-align_pair_arrow = true
-align_matrix = true
+format_docstrings = true
+format_markdown = true

.buildkite/pipeline.yml

@@ -1,14 +1,11 @@
 steps:
   - label: "DI GPU tests"
-    if: |
-      !build.pull_request.draft &&
-        build.pull_request.labels includes "gpu"
     plugins:
       - JuliaCI/julia#v1:
           version: "1"
     command: |
-      julia ./DifferentiationInterface/test/GPU/CUDA/simple.jl
+      julia ./DifferentiationInterface/test/GPU/CUDA/main.jl
     agents:
       queue: "juliagpu"
       cuda: "*"
-    timeout_in_minutes: 60
+    timeout_in_minutes: 60

.github/workflows/CompatHelper.yml

@@ -42,4 +42,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
-          # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}
+          # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}

.github/workflows/Documentation.yml

@@ -15,7 +15,7 @@ concurrency:
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
 jobs:
-  
+
   docs:
     name: ${{ matrix.pkg.shortcut }}
     runs-on: ubuntu-latest
@@ -33,15 +33,15 @@ jobs:
           - name: DifferentiationInterfaceTest
             shortcut: DIT
             dir: './DifferentiationInterfaceTest'
-    
+
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:
           version: '1'  # TODO: 1
       - uses: julia-actions/cache@v1
       - name: Install dependencies
-        run: julia --project=${{ matrix.pkg.dir}}/docs/ -e '
+        run: julia --project=${{ matrix.pkg.dir}}/docs/ --color=yes -e '
           using Pkg;
           Pkg.Registry.update();
           if "${{ matrix.pkg.name}}" == "DifferentiationInterface";
@@ -54,4 +54,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
-        run: julia --project=${{ matrix.pkg.dir}}/docs/ ${{ matrix.pkg.dir}}/docs/make.jl
+        run: julia --project=${{ matrix.pkg.dir}}/docs/ --color=yes ${{ matrix.pkg.dir}}/docs/make.jl

.github/workflows/PreCommit.yml

@@ -0,0 +1,27 @@
+name: Pre-Commit
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+    tags: ["*"]
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+      - uses: julia-actions/cache@v2
+      - run: julia -e 'using Pkg; Pkg.add("JuliaFormatter")'
+      - uses: astral-sh/setup-uv@v6
+      - run: uv tool install pre-commit
+      - run: pre-commit run --all-files --show-diff-on-failure --color always

.github/workflows/Register.yml

@@ -13,4 +13,4 @@ jobs:
     steps:
       - uses: julia-actions/RegisterAction@latest
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/TagBot.yml

@@ -36,4 +36,4 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ssh: ${{ secrets.DOCUMENTER_KEY }}
-          subdir: DifferentiationInterfaceTest
+          subdir: DifferentiationInterfaceTest

.github/workflows/Test.yml

@@ -20,12 +20,12 @@ jobs:
     name: ${{ matrix.version }} - DI (${{ matrix.group }})
     runs-on: ubuntu-latest
     if: ${{ !contains(github.event.pull_request.labels.*.name, 'skipci') }}
-    timeout-minutes: 60
+    timeout-minutes: 120
     permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
       actions: write
       contents: read
     strategy:
-      fail-fast: false  # TODO: toggle
+      fail-fast: true  # TODO: toggle
       matrix:
         version:
           - "1.10"
@@ -60,6 +60,7 @@ jobs:
             group: Back/ChainRules
     env:
       JULIA_DI_TEST_GROUP: ${{ matrix.group }}
+      JULIA_DI_PR_DRAFT: ${{ github.event.pull_request.draft }}
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -69,10 +70,14 @@ jobs:
       - uses: julia-actions/cache@v2
       - name: Install dependencies & run tests
         # how to add the local DIT to the DI test env?
-        run: julia --project=./DifferentiationInterface -e '
+        run: julia --project=./DifferentiationInterface --color=yes -e '
           using Pkg;
           Pkg.Registry.update();
-          Pkg.test("DifferentiationInterface"; coverage=true);'
+          if ENV["JULIA_DI_PR_DRAFT"] == "true";
+              Pkg.test("DifferentiationInterface"; coverage=true, julia_args=["-O1"]);
+          else;
+              Pkg.test("DifferentiationInterface"; coverage=true);
+          end;'
       - uses: julia-actions/julia-processcoverage@v1
         with:
           directories: ./DifferentiationInterface/src,./DifferentiationInterface/ext,./DifferentiationInterface/test
@@ -109,6 +114,7 @@ jobs:
             version: "1.10"
     env:
       JULIA_DIT_TEST_GROUP: ${{ matrix.group }}
+      JULIA_DI_PR_DRAFT: ${{ github.event.pull_request.draft }}
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -117,11 +123,15 @@ jobs:
           arch: x64
       - uses: julia-actions/cache@v2
       - name: Install dependencies & run tests
-        run: julia --project=./DifferentiationInterfaceTest -e '
+        run: julia --project=./DifferentiationInterfaceTest --color=yes -e '
           using Pkg;
           Pkg.Registry.update();
           Pkg.develop(path="./DifferentiationInterface");
-          Pkg.test("DifferentiationInterfaceTest"; coverage=true);'
+          if ENV["JULIA_DI_PR_DRAFT"] == "true";
+              Pkg.test("DifferentiationInterfaceTest"; coverage=true, julia_args=["-O1"]);
+          else;
+              Pkg.test("DifferentiationInterfaceTest"; coverage=true);
+          end;'
       - uses: julia-actions/julia-processcoverage@v1
         with:
           directories: ./DifferentiationInterfaceTest/src,./DifferentiationInterfaceTest/ext,./DifferentiationInterfaceTest/test

.gitignore

@@ -11,4 +11,4 @@
 *.csv
 
 playground.jl
-.vscode
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-merge-conflict
+    -   id: no-commit-to-branch
+-   repo: "https://github.com/domluna/JuliaFormatter.jl"
+    rev: "v2.1.6"  # or whatever the desired release is
+    hooks:
+    -   id: "julia-formatter"
+fail_fast: true