Workflow updates (#116)

Propagate changes from: insightsengineering/idr-tasks#513, insightsengineering/idr-tasks#522, insightsengineering/idr-tasks#533 and insightsengineering/idr-tasks#543.
insightsengineering · Jun 1, 2023 · 8754438 · 8754438
1 parent 194b9eb
commit 8754438
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 12 deletions.
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -15,6 +15,13 @@ on:
       - main
   workflow_dispatch:
 
+  # Rerun workflows once pkgdown has finished running, to add coverage
+  # and unit test report to gh-pages branch.
+  workflow_run:
+    workflows: ["Docs 📚"]
+    types:
+      - completed
+
 jobs:
   audit:
     name: Audit Dependencies 🕵️‍♂️
@@ -23,16 +30,22 @@ jobs:
     name: R CMD Check 🧬
     uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
       additional-env-vars: |
         _R_CHECK_CRAN_INCOMING_REMOTE_=false
       additional-r-cmd-check-params: --as-cran
+      enforce-note-blocklist: true
+      note-blocklist: |
+        checking dependencies in R code ... NOTE
+        checking R code for possible problems ... NOTE
+        checking examples ... NOTE
+        checking Rd line widths ... NOTE
   coverage:
     name: Coverage 📔
     uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   linter:
     if: github.event_name != 'push'
     name: SuperLinter 🦸‍♀️
@@ -41,7 +54,7 @@ jobs:
     name: Roxygen 🅾
     uses: insightsengineering/r.pkg.template/.github/workflows/roxygen.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
       auto-update: true
   gitleaks:
@@ -60,7 +73,7 @@ jobs:
     if: github.event_name == 'push'
     uses: insightsengineering/r.pkg.template/.github/workflows/version-bump.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   version:
     name: Version Check 🏁
     uses: insightsengineering/r.pkg.template/.github/workflows/version.yaml@main

diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -38,6 +38,6 @@ jobs:
     name: Pkgdown Docs 📚
     uses: insightsengineering/r.pkg.template/.github/workflows/pkgdown.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
       default-landing-page: latest-tag
diff --git a/.github/workflows/integration-tests.yaml b/.github/workflows/integration-tests.yaml
@@ -0,0 +1,20 @@
+---
+name: Integration Tests 🧪
+
+on:
+  schedule:
+    - cron: '45 3 * * 0'
+
+jobs:
+  dependency-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        test-strategy: ["min", "release", "max"]
+    uses: insightsengineering/r.pkg.template/.github/workflows/verdepcheck.yaml@main
+    name: Dependency Test - ${{ matrix.test-strategy }} 🔢
+    secrets:
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GCHAT_WEBHOOK: ${{ secrets.GCHAT_WEBHOOK }}
+    with:
+      strategy: ${{ matrix.test-strategy }}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -13,7 +13,7 @@ jobs:
     needs: release
     uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
       skip-r-cmd-check: true
       skip-r-cmd-install: true
@@ -22,17 +22,39 @@ jobs:
     needs: release
     uses: insightsengineering/r.pkg.template/.github/workflows/pkgdown.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
       default-landing-page: latest-tag
   validation:
     name: R Package Validation report 📃
     needs: release
     uses: insightsengineering/r.pkg.template/.github/workflows/validation.yaml@main
     secrets:
-      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   release:
     name: Create release 🎉
     uses: insightsengineering/r.pkg.template/.github/workflows/release.yaml@main
     permissions:
       contents: write
+  r-cmd:
+    name: R CMD Check 🧬
+    needs: [release, docs]
+    uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
+    secrets:
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    with:
+      additional-env-vars: |
+        _R_CHECK_CRAN_INCOMING_REMOTE_=false
+      additional-r-cmd-check-params: --as-cran
+      enforce-note-blocklist: true
+      note-blocklist: |
+        checking dependencies in R code ... NOTE
+        checking R code for possible problems ... NOTE
+        checking examples ... NOTE
+        checking Rd line widths ... NOTE
+  coverage:
+    name: Coverage 📔
+    needs: [release, docs]
+    uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main
+    secrets:
+      REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # osprey
 
 <!-- start badges -->
-[![Check 🛠](https://github.com/insightsengineering/osprey/actions/workflows/check.yaml/badge.svg)](https://github.com/insightsengineering/osprey/actions/workflows/check.yaml)
+[![Check 🛠](https://github.com/insightsengineering/osprey/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/osprey/main/unit-test-report/)
 [![Docs 📚](https://github.com/insightsengineering/osprey/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/osprey/)
-[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/osprey/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/osprey/_xml_coverage_reports/data/main/coverage.xml)
+[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/osprey/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/osprey/main/coverage-report/)
 
 ![GitHub forks](https://img.shields.io/github/forks/insightsengineering/osprey?style=social)
 ![GitHub Repo stars](https://img.shields.io/github/stars/insightsengineering/osprey?style=social)

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -4,8 +4,19 @@ template:
   package: nesttemplate
 
 navbar:
-  right:
-    - icon: fa-github
+  structure:
+    left: [intro, reference, articles, tutorials, news, reports]
+    right: [search, github]
+  components:
+    reports:
+      text: Reports
+      menu:
+      - text: Coverage report
+        href: coverage-report/
+      - text: Unit test report
+        href: unit-test-report/
+    github:
+      icon: fa-github
       href: https://github.com/insightsengineering/osprey
 
 reference: