Replace styler with air

Moohan · Moohan · commit 237a559c0c50 · 2025-10-28T12:27:27.000Z
https://posit-dev.github.io/air/formatter.html https://www.tidyverse.org/blog/2025/02/air/ https://yohann-data.fr/posts/airformatter/ Update phs_style_and_document.yaml Split the style and document actions Remove automatic documentation job from workflow Removed the phs_document job for automatic documentation generation and its dependencies. Update phs_package_checks.yaml Update phs_style.yaml to add default air.toml Update phs_style.yaml Update phs_document.yaml Update phs_document.yaml Update phs_style.yaml Update phs_style.yaml Update phs_document.yaml Update phs_package_checks.yaml
diff --git a/.github/workflows/phs_document.yaml b/.github/workflows/phs_document.yaml
@@ -0,0 +1,72 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  workflow_call:
+
+name: phs_document.yaml
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  phs_document:
+    name: "Automatically re-build the package documentation"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup R
+        uses: r-lib/actions/setup-r@bd49c52ffe281809afa6f0fecbf37483c5dd0b93 # v2.11.3
+        with:
+          use-public-rspm: true
+
+      - name: Install dependencies
+        uses: r-lib/actions/setup-r-dependencies@bd49c52ffe281809afa6f0fecbf37483c5dd0b93 # v2.11.3
+        with:
+          extra-packages: |
+            any::roxygen2
+            any::desc
+          needs: |
+            website
+            coverage
+
+      - name: Normalise DESCRIPTION
+        run: desc::desc_normalize()
+        shell: Rscript {0}
+
+      - name: Document
+        run: roxygen2::roxygenise()
+        shell: Rscript {0}
+
+      - name: Commit and push changes
+        id: commit_step_document
+        uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3 # v7.0.0
+        with:
+          commit_message: "Document package (GHA)"
+        continue-on-error: true
+
+      - name: Create Pull Request
+        if: ${{ steps.commit_step_document.outputs.changes_detected == 'true' && steps.commit_step_document.outcome == 'failure' }}
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        with:
+          commit-message: "Document package (GHA)"
+          branch: auto-document-code
+          delete-branch: true
+          title: "Document package (GHA)"
+          labels: maintenance
+          base: ${{ github.event.pull_request.base.ref }}
+          body: |
+            This Pull Request was automatically created to apply documentation changes to your code.
+            Please review and merge this PR.
+          assignees: ${{ github.actor }}
+          reviewers: ${{ github.actor }}
diff --git a/.github/workflows/phs_package_checks.yaml b/.github/workflows/phs_package_checks.yaml
@@ -15,7 +15,7 @@ permissions:
   contents: read
   pull-requests: read
   statuses: read
-  
+
 jobs:
   # Initial job to post status
   init:
@@ -35,8 +35,18 @@ jobs:
               description: 'Package checks in progress',
               context: 'PHS Package Checks'
             });
-  Style_and_document:
-    uses: ./.github/workflows/phs_style_and_document.yaml
+  Style:
+    uses: ./.github/workflows/phs_style.yaml
+    permissions:
+      contents: write
+      pull-requests: write
+    secrets: inherit
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+  Document:
+    needs: [Style]
+    uses: ./.github/workflows/phs_document.yaml
     permissions:
       contents: write
       pull-requests: write
@@ -45,7 +55,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}
       cancel-in-progress: true
   R-CMD-check-core:
-    needs: [Style_and_document]
+    needs: [Style, Document]
     uses: ./.github/workflows/phs_R-CMD-check-core.yaml
     permissions:
       contents: read
@@ -54,7 +64,7 @@ jobs:
       group: ${{ inputs.limit_parallel == false && format('r-cmd-check-{0}-{1}', github.workflow, github.run_id) || 'phs-core-check-queue' }}
       cancel-in-progress: false
   R-CMD-check-extended:
-    needs: [Style_and_document]
+    needs: [R-CMD-check-core]
     uses: ./.github/workflows/phs_R-CMD-check-extended.yaml
     permissions:
       contents: read
@@ -63,7 +73,7 @@ jobs:
       group: ${{ inputs.limit_parallel == false && format('r-cmd-check-{0}-{1}', github.workflow, github.run_id) || 'package-checks-queue' }}
       cancel-in-progress: false
   R-CMD-check-no-suggests:
-    needs: [R-CMD-check-core]
+    needs: [R-CMD-check-extended]
     uses: ./.github/workflows/phs_R-CMD-check-no-suggests.yaml
     permissions:
       contents: read
@@ -81,14 +91,15 @@ jobs:
       group: ${{ inputs.limit_parallel == false && format('test-coverage-{0}-{1}', github.workflow, github.run_id) || 'package-checks-queue' }}
       cancel-in-progress: false
   pkgdown:
-    needs: [Style_and_document]
+    needs: [Document]
     uses: ./.github/workflows/phs_pkgdown.yaml
     permissions:
       contents: write
     secrets: inherit
+  
 # Final job to update status
   finalize:
-    needs: [Style_and_document, R-CMD-check-core, test-coverage, pkgdown]
+    needs: [Style, Document, R-CMD-check-core, test-coverage, pkgdown]
     runs-on: ubuntu-latest
     if: always()
     permissions:
@@ -98,11 +109,10 @@ jobs:
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
           script: |
-            const allSuccess = ${{ needs.Style_and_document.result == 'success' && 
-                                    needs.R-CMD-check-core.result == 'success' && 
-                                    needs.test-coverage.result == 'success' && 
-                                    needs.pkgdown.result == 'success' }};
-            
+            const allSuccess = ${{ needs.Style.result == 'success' &&
+                                    needs.Document.result == 'success' &&
+                                    needs.R-CMD-check-core.result == 'success' &&
+                                    needs.test-coverage.result == 'success'}};
             await github.rest.repos.createCommitStatus({
               owner: context.repo.owner,
               repo: context.repo.repo,
diff --git a/.github/workflows/phs_style.yaml b/.github/workflows/phs_style.yaml
@@ -0,0 +1,67 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  workflow_call:
+
+name: phs_style.yaml
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  phs_style:
+    name: "Automatically style the code using air"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      
+      - name: Install posit-dev/air
+        uses: posit-dev/setup-air@63e80dedb6d275c94a3841e15e5ff8691e1ab237 # v1.0.0
+
+      - name: Include standard air.toml (overwrite existing)
+        run: |
+          echo '[format]' > air.toml
+          echo 'line-ending = "lf"' >> air.toml
+
+      - name: Add air.toml to .Rbuildignore if it exists
+        run: |
+          if [ -f .Rbuildignore ]; then
+            grep -qxF 'air.toml' .Rbuildignore || echo 'air.toml' >> .Rbuildignore
+          fi
+          
+      - name: Format using air
+        run: air format . 
+
+      - name: Commit and push changes
+        id: commit_step_style
+        uses: stefanzweifel/git-auto-commit-action@b863ae1933cb653a53c021fe36dbb774e1fb9403 # v5.2.0
+        with:
+          commit_message: "Style code (GHA)"
+        continue-on-error: true
+
+      - name: Create Pull Request
+        if: ${{ steps.commit_step_style.outputs.changes_detected == 'true' && steps.commit_step_style.outcome == 'failure' }}
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        with:
+          commit-message: "Style code (GHA)"
+          branch: auto-style-code
+          delete-branch: true
+          title: "Style code (GHA)"
+          labels: maintenance
+          base: ${{ github.event.pull_request.base.ref }} 
+          body: |
+            This Pull Request was automatically created to apply styling changes to your code.
+            Please review and merge this PR.
+          assignees: ${{ github.actor }}
+          reviewers: ${{ github.actor }}
+
diff --git a/.github/workflows/phs_style_and_document.yaml b/.github/workflows/phs_style_and_document.yaml
