From c6a5cdbc2ef26242451605d23b55bdb8ece00319 Mon Sep 17 00:00:00 2001
From: ChrisRackauckas-Claude <accounts@chrisrackauckas.com>
Date: Fri, 5 Jun 2026 05:38:05 -0400
Subject: [PATCH] ci: Runic suggestions workflow + expose extensions/docstrings

- Add runic-suggestions-on-pr.yml: the Runic counterpart of
  format-suggestions-on-pr.yml. runic-action format_files:true rewrites the
  tree, reviewdog/action-suggester posts the diff as PR suggestions (apply
  individually, or batch-commit them as one commit in the GitHub UI).
- Expose `extensions` (jl,md) and `docstrings` (Runic >= 1.7) on runic.yml.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 .github/workflows/runic-suggestions-on-pr.yml | 61 +++++++++++++++++++
 .github/workflows/runic.yml                   | 12 ++++
 2 files changed, 73 insertions(+)
 create mode 100644 .github/workflows/runic-suggestions-on-pr.yml

diff --git a/.github/workflows/runic-suggestions-on-pr.yml b/.github/workflows/runic-suggestions-on-pr.yml
new file mode 100644
index 0000000..b62a52a
--- /dev/null
+++ b/.github/workflows/runic-suggestions-on-pr.yml
@@ -0,0 +1,61 @@
+name: "Reusable Runic Suggestions Workflow"
+
+# Posts Runic formatting fixes as PR review suggestions (the Runic counterpart
+# of format-suggestions-on-pr.yml). runic-action with format_files: true
+# rewrites the tree, then reviewdog/action-suggester turns the diff into inline
+# suggestions. Apply them one-by-one, or "Add suggestion to batch" + "Commit
+# suggestions" in the GitHub UI to land them all as a single commit.
+
+on:
+  workflow_call:
+    inputs:
+      julia-version:
+        description: "Julia version"
+        default: "1"
+        required: false
+        type: string
+      runic-version:
+        description: "Version of Runic to use"
+        default: "1"
+        required: false
+        type: string
+      extensions:
+        description: "Comma-separated file extensions to format (e.g. 'jl' or 'jl,md'); requires Runic >= 1.7"
+        default: "jl"
+        required: false
+        type: string
+      docstrings:
+        description: "Format Julia code blocks in docstrings; requires Runic >= 1.7"
+        default: false
+        required: false
+        type: boolean
+
+jobs:
+  runic-suggestions:
+    name: "Runic Suggestions"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: julia-actions/setup-julia@v3
+        with:
+          version: "${{ inputs.julia-version }}"
+
+      - name: "Format with Runic"
+        # format_files rewrites the tree in place; the action still exits
+        # non-zero when it had to reformat, so don't let that stop the
+        # suggestion step.
+        continue-on-error: true
+        uses: fredrikekre/runic-action@v1
+        with:
+          version: "${{ inputs.runic-version }}"
+          extensions: "${{ inputs.extensions }}"
+          docstrings: "${{ inputs.docstrings }}"
+          format_files: "true"
+
+      - name: "Suggest formatting changes on the PR"
+        uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: "Runic"
+          fail_level: "any"
+          filter_mode: "added"
diff --git a/.github/workflows/runic.yml b/.github/workflows/runic.yml
index 24b2c7a..2961d36 100644
--- a/.github/workflows/runic.yml
+++ b/.github/workflows/runic.yml
@@ -13,6 +13,16 @@ on:
         default: "1"
         required: false
         type: string
+      extensions:
+        description: "Comma-separated file extensions to check (e.g. 'jl' or 'jl,md'); requires Runic >= 1.7"
+        default: "jl"
+        required: false
+        type: string
+      docstrings:
+        description: "Format Julia code blocks in docstrings; requires Runic >= 1.7"
+        default: false
+        required: false
+        type: boolean
       exclude:
         description: "Space-separated list of paths/directories to exclude from the Runic check (e.g. for vendored or legacy files Runic cannot parse). They are dropped from the git index before the check so runic-action's `git ls-files` skips them; the working tree and history are untouched."
         default: ""
@@ -37,3 +47,5 @@ jobs:
       - uses: fredrikekre/runic-action@v1
         with:
           version: "${{ inputs.runic-version }}"
+          extensions: "${{ inputs.extensions }}"
+          docstrings: "${{ inputs.docstrings }}"