Merge branch 'main' into pr/penelopeysm/835

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

@@ -8,4 +8,4 @@ steps:
     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,7 +33,7 @@ jobs:
           - name: DifferentiationInterfaceTest
             shortcut: DIT
             dir: './DifferentiationInterfaceTest'
-    
+
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.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

.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

CONTRIBUTING.md

@@ -9,5 +9,7 @@ _Only the two maintainers are allowed to approve and merge pull requests._
 Feel free to ping them if they do not answer within a week or so.
 
 Apart from the conditions above, this repository follows the [ColPrac](https://github.com/SciML/ColPrac) best practices and [Conventional Commits](https://www.conventionalcommits.org/en/).
-Its code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) with [BlueStyle](https://github.com/JuliaDiff/BlueStyle) -- please format any modified code before opening a pull request, otherwise CI will fail.
+Its code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) with [BlueStyle](https://github.com/JuliaDiff/BlueStyle).
+As part of continuous integration, a set of formal tests is run using [pre-commit](https://pre-commit.com/).
+We invite you to install pre-commit so that these checks are performed locally before you open or update a pull request.
 You can refer to the [dev guide](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface/dev/dev_guide/) for details on the package structure and the testing pipeline.