Merge branch 'main' into wasm-poc

insightsengineering · Jun 19, 2024 · bb4d3cc · bb4d3cc
2 parents 31a3898 + b8e3de5
commit bb4d3cc
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 21 deletions.
diff --git a/.github/workflows/build-check-install.yaml b/.github/workflows/build-check-install.yaml
@@ -694,9 +694,12 @@ jobs:
         if: inputs.skip-r-cmd-check != true
         run: |
           find ${{ env.PKGNAME }}.Rcheck -type f -regextype posix-egrep \
-            -regex '.*00install.out|.*00check.log|.*00build.out' -print0 | while IFS= read -r -d $'\0' file; do
-            printf "==================================\n$file\n==================================\n"
-            cat $file
+            -regex '.*00install.out|.*00check.log|.*00build.out|.*-Ex.Rout|.*tests/testthat\.Rout.*' \
+            -print0 | while IFS= read -r -d $'\0' file; do
+              # Grouping allows to collapse/expand logs when needed.
+              echo "::group::$file"
+              cat $file
+              echo "::endgroup::"
           done
         shell: bash
 
@@ -782,6 +785,18 @@ jobs:
           path: ${{ github.event.repository.name }}/${{ inputs.package-subdirectory }}/${{ env.PKGBUILD }}
           name: ${{ env.PKGBUILD }}
 
+      - name: Upload logs artifact 🗞️
+        uses: actions/upload-artifact@v4
+        with:
+          path: |
+            ${{ env.PKGNAME }}.Rcheck/*00install.out
+            ${{ env.PKGNAME }}.Rcheck/*00check.log
+            ${{ env.PKGNAME }}.Rcheck/*00build.out
+            ${{ env.PKGNAME }}.Rcheck/*-Ex.Rout
+            ${{ env.PKGNAME }}.Rcheck/tests/testthat.Rout
+            ${{ env.PKGNAME }}.Rcheck/tests/testthat.Rout.fail
+          name: check-logs-${{ env.PKGNAME }}-${{ inputs.concurrency-group }}
+
   publish-junit-html-report:
     name: Publish JUnit HTML report 📰
     runs-on: ubuntu-latest
@@ -813,7 +828,7 @@ jobs:
 
       - name: Upload JUnit HTML report to GitHub pages 🗞️
         if: needs.build-install-check.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./unit-test-report
@@ -823,7 +838,7 @@ jobs:
         if: >
           needs.build-install-check.outputs.is-latest-tag == 'true'
             && needs.build-install-check.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./unit-test-report
@@ -833,15 +848,15 @@ jobs:
         if: >
           needs.build-install-check.outputs.is-rc-tag == 'true'
             && needs.build-install-check.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./unit-test-report
           destination_dir: ${{ inputs.release-candidate-alt-name }}/unit-test-report
 
       - name: Upload JUnit HTML report to GitHub pages (non-multiversion) 🗞️
         if: needs.build-install-check.outputs.multiversion-docs == 'false'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./unit-test-report

diff --git a/.github/workflows/links.yaml b/.github/workflows/links.yaml
@@ -16,11 +16,16 @@ on:
   workflow_dispatch:
   workflow_call:
     inputs:
-      additional_args:
+      lychee-additional-args:
         description: Additional arguments to pass to lychee
         required: false
         type: string
-        default: ""
+        default: "--exclude-private"
+      lychee-fail:
+        description: Fail workflow run on error (i.e. when lychee exit code is not 0)
+        required: false
+        type: boolean
+        default: false
       package-subdirectory:
         description: Subdirectory in the repository, where the R package is located.
         required: false
@@ -79,19 +84,20 @@ jobs:
           SKIP_INSTRUCTION: "[skip links]"
 
       - name: Check URLs in docs 🔬
-        uses: lycheeverse/lychee-action@v1.8.0
+        uses: lycheeverse/lychee-action@v1.10.0
         with:
           args: >-
-            --exclude-private
             --exclude "https://github.com.*.git|https://insightsengineering.github.io.*|lewagon.*|knightdave.*|.*users.noreply.github.com|lycheeverse.*"
             --verbose
             --no-progress
-            ${{ inputs.additional_args }}
+            ${{ inputs.lychee-additional-args }}
             **/*.md
             **/*.html
             **/*.Rmd
             **/*.yaml
             **/*.yml
+            *.md
+          fail: ${{ inputs.lychee-fail }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -137,7 +143,8 @@ jobs:
 
       - name: Check URLs with urlchecker 🔬
         run: |
-          bad_urls <- nrow(print(urlchecker::url_check(".")))
+          # For unexplained reasons, parallel = FALSE is required to prevent some false positives.
+          bad_urls <- nrow(print(urlchecker::url_check(".", parallel = FALSE)))
           if (bad_urls > 0) {
             stop("Looks like a total of ", bad_urls, " URL(s) were found! Please correct them.")
           }

diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -419,7 +419,7 @@ jobs:
 
       - name: Upload coverage report to GitHub pages 🗞️
         if: needs.coverage.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./coverage-report
@@ -429,7 +429,7 @@ jobs:
         if: >
           needs.coverage.outputs.is-latest-tag == 'true'
             && needs.coverage.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./coverage-report
@@ -439,15 +439,15 @@ jobs:
         if: >
           needs.coverage.outputs.is-rc-tag == 'true'
             && needs.coverage.outputs.multiversion-docs == 'true'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./coverage-report
           destination_dir: ${{ inputs.release-candidate-alt-name }}/coverage-report
 
       - name: Upload coverage report to GitHub pages (non-multiversion) 🗞️
         if: needs.coverage.outputs.multiversion-docs == 'false'
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ steps.github-token.outputs.token }}
           publish_dir: ./coverage-report

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -77,6 +77,6 @@ repos:
         files: '\.Rhistory|\.RData|\.Rds|\.rds$'
         # `exclude: <regex>` to allow committing specific files.
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.40.0
+    rev: v0.41.0
     hooks:
       - id: markdownlint
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Type: Package
 Package: r.pkg.template
 Title: R Package Template
-Version: 0.1.0.9160
-Date: 2024-05-22
+Version: 0.1.0.9167
+Date: 2024-06-18
 Authors@R:
     person("insightsengineering", , , "[email protected]", role = c("aut", "cre"))
 Description: R package template with GitHub Actions workflows included.

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# r.pkg.template 0.1.0.9160
+# r.pkg.template 0.1.0.9167
 
 ### New features