Merge pull request #20 from ThinkR-open/test-ci

MargotBr · web-flow · commit 62de39c52a84 · 2024-02-28T14:37:05.000+01:00
ci: Update GitHub actions to match new environments
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -1,12 +1,11 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# 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:
   push:
     branches: [main, master]
   pull_request:
     branches: [main, master]
   schedule:
-    # * is a special character in YAML so you have to quote this string
     - cron:  '01 00 * * 3'
 
 name: R-CMD-check
@@ -21,7 +20,7 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest,   r: 'release'}
+          - {os: macos-latest,   r: 'release'}
           - {os: windows-latest, r: 'release'}
           - {os: windows-latest, r: 'devel'}
           - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
@@ -33,18 +32,22 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: rcmdcheck
+          extra-packages: any::rcmdcheck
+          needs: check
 
-      - uses: r-lib/actions/check-r-package@v1
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -1,8 +1,12 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# 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:
   push:
     branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  schedule:
+    - cron:  '01 00 * * 3'
   release:
     types: [published]
   workflow_dispatch:
@@ -12,25 +16,35 @@ name: pkgdown
 jobs:
   pkgdown:
     runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: pkgdown
+          extra-packages: any::pkgdown, local::.
           needs: website
 
-      - name: Deploy package
-        run: |
-          git config --local user.name "$GITHUB_ACTOR"
-          git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
-          Rscript -e 'install.packages("remotes");remotes::install_github("ThinkR-open/thinkrtemplate", upgrade = "never")'
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -1,10 +1,11 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# 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:
   push:
     branches: [main, master]
+  pull_request:
+    branches: [main, master]
   schedule:
-    # * is a special character in YAML so you have to quote this string
     - cron:  '01 00 * * 3'
 
 name: test-coverage
@@ -16,16 +17,36 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: covr
+          extra-packages: any::covr
+          needs: coverage
 
       - name: Test coverage
-        run: covr::codecov()
+        run: |
+          covr::codecov(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
+          )
         shell: Rscript {0}
+
+      - name: Show testthat output
+        if: always()
+        run: |
+          ## --------------------------------------------------------------------
+          find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-test-failures
+          path: ${{ runner.temp }}/package
diff --git a/README.Rmd b/README.Rmd
@@ -24,7 +24,7 @@ file.copy(list.files("reference/figures", full.names = TRUE),
 # gitdown <img src="man/figures/logo.png" align="right" alt="" width="120" />
 
 <!-- badges: start -->
-[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
+[![R-CMD-check](https://github.com/ThinkR-open/gitdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/gitdown/actions/workflows/R-CMD-check.yaml)
 [![Coverage status](https://codecov.io/gh/ThinkR-open/gitdown/branch/main/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=main)
 [![CRAN status](https://www.r-pkg.org/badges/version/gitdown)](https://CRAN.R-project.org/package=gitdown)
 <!-- badges: end -->
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
+[![R-CMD-check](https://github.com/ThinkR-open/gitdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/gitdown/actions/workflows/R-CMD-check.yaml)
 [![Coverage
 status](https://codecov.io/gh/ThinkR-open/gitdown/branch/main/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=main)
 [![CRAN
@@ -40,9 +40,9 @@ remotes::install_github("ThinkR-open/gitdown")
 Create a versioned directory with some commits and a NEWS.md in a
 temporary directory
 
--   Some commits mention an issue with `#`
--   Some commits mention a ticket with `ticket`
--   A commit is associated with a tag
+- Some commits mention an issue with `#`
+- Some commits mention a ticket with `ticket`
+- A commit is associated with a tag
 
 ``` r
 library(dplyr)
@@ -109,17 +109,17 @@ get_commits_pattern(repo, pattern = "#[[:digit:]]+", ref = "main") %>%
   select(pattern.content, everything())
 #> 4 commits found.
 #> # A tibble: 7 × 12
-#>   pattern.content sha    summary message  author email when                order
-#>   <chr>           <chr>  <chr>   <chr>    <chr>  <chr> <dttm>              <int>
-#> 1 #32             8790c… Add NE… "Add NE… Alice  alic… 2022-03-04 15:31:14     4
-#> 2 #1              8790c… Add NE… "Add NE… Alice  alic… 2022-03-04 15:31:14     4
-#> 3 #12             8790c… Add NE… "Add NE… Alice  alic… 2022-03-04 15:31:14     4
-#> 4 #2              c0870… Third … "Third … Alice  alic… 2022-03-04 15:31:14     3
-#> 5 #145            c0870… Third … "Third … Alice  alic… 2022-03-04 15:31:14     3
-#> 6 #1              a97db… exampl… "exampl… Alice  alic… 2022-03-04 15:31:14     2
-#> 7 <NA>            b27b5… First … "First … Alice  alic… 2022-03-04 15:31:14     1
-#> # … with 4 more variables: tag.name <chr>, tag.message <chr>,
-#> #   pattern.type <chr>, pattern.title <chr>
+#>   pattern.content sha     summary message author email when                order
+#>   <chr>           <chr>   <chr>   <chr>   <chr>  <chr> <dttm>              <int>
+#> 1 #32             1fd238… Add NE… "Add N… Alice  alic… 2024-02-28 13:22:16     4
+#> 2 #1              1fd238… Add NE… "Add N… Alice  alic… 2024-02-28 13:22:16     4
+#> 3 #12             1fd238… Add NE… "Add N… Alice  alic… 2024-02-28 13:22:16     4
+#> 4 #2              91e2c1… Third … "Third… Alice  alic… 2024-02-28 13:22:16     3
+#> 5 #145            91e2c1… Third … "Third… Alice  alic… 2024-02-28 13:22:16     3
+#> 6 #1              7e998d… exampl… "examp… Alice  alic… 2024-02-28 13:22:16     2
+#> 7 <NA>            1b6cc5… First … "First… Alice  alic… 2024-02-28 13:22:16     1
+#> # ℹ 4 more variables: tag.name <chr>, tag.message <chr>, pattern.type <chr>,
+#> #   pattern.title <chr>
 ```
 
 Get commits with issues and specific home-made pattern. Use a named
@@ -134,21 +134,21 @@ get_commits_pattern(
   select(pattern.type, pattern.content, everything())
 #> 4 commits found.
 #> # A tibble: 12 × 12
-#>    pattern.type pattern.content sha       summary   message        author email 
-#>    <chr>        <chr>           <chr>     <chr>     <chr>          <chr>  <chr> 
-#>  1 Tickets      ticket6789      8790cc60… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  2 Tickets      ticket1234      8790cc60… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  3 Issues       #32             8790cc60… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  4 Issues       #1              8790cc60… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  5 Issues       #12             8790cc60… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  6 Tickets      <NA>            c0870ab4… Third co… "Third commit… Alice  alice…
-#>  7 Issues       #2              c0870ab4… Third co… "Third commit… Alice  alice…
-#>  8 Issues       #145            c0870ab4… Third co… "Third commit… Alice  alice…
-#>  9 Tickets      ticket1234      a97db45b… example:… "example: mod… Alice  alice…
-#> 10 Issues       #1              a97db45b… example:… "example: mod… Alice  alice…
-#> 11 Tickets      <NA>            b27b55fe… First co… "First commit… Alice  alice…
-#> 12 Issues       <NA>            b27b55fe… First co… "First commit… Alice  alice…
-#> # … with 5 more variables: when <dttm>, order <int>, tag.name <chr>,
+#>    pattern.type pattern.content sha                 summary message author email
+#>    <chr>        <chr>           <chr>               <chr>   <chr>   <chr>  <chr>
+#>  1 Tickets      ticket6789      1fd238efc602f52946… Add NE… "Add N… Alice  alic…
+#>  2 Tickets      ticket1234      1fd238efc602f52946… Add NE… "Add N… Alice  alic…
+#>  3 Issues       #32             1fd238efc602f52946… Add NE… "Add N… Alice  alic…
+#>  4 Issues       #1              1fd238efc602f52946… Add NE… "Add N… Alice  alic…
+#>  5 Issues       #12             1fd238efc602f52946… Add NE… "Add N… Alice  alic…
+#>  6 Tickets      <NA>            91e2c152a0525fc589… Third … "Third… Alice  alic…
+#>  7 Issues       #2              91e2c152a0525fc589… Third … "Third… Alice  alic…
+#>  8 Issues       #145            91e2c152a0525fc589… Third … "Third… Alice  alic…
+#>  9 Tickets      ticket1234      7e998d8e673e331274… exampl… "examp… Alice  alic…
+#> 10 Issues       #1              7e998d8e673e331274… exampl… "examp… Alice  alic…
+#> 11 Tickets      <NA>            1b6cc5d04920de4a60… First … "First… Alice  alic…
+#> 12 Issues       <NA>            1b6cc5d04920de4a60… First … "First… Alice  alic…
+#> # ℹ 5 more variables: when <dttm>, order <int>, tag.name <chr>,
 #> #   tag.message <chr>, pattern.title <chr>
 ```
 
@@ -166,9 +166,9 @@ With this example, the vignette will show this content:
 
 | File        | Tracked in git | Date of creation    | Last modification   |
 |:------------|:---------------|:--------------------|:--------------------|
-| NEWS.md     | Yes            | 2022-03-04 16:31:14 | 2022-03-04 16:31:14 |
-| example.txt | Yes            | 2022-03-04 16:31:14 | 2022-03-04 16:31:14 |
-| R/my_mean.R | No             | NA                  | 2022-03-04 16:31:14 |
+| NEWS.md     | Yes            | 2024-02-28 13:22:17 | 2024-02-28 13:22:17 |
+| example.txt | Yes            | 2024-02-28 13:22:17 | 2024-02-28 13:22:17 |
+| R/my_mean.R | No             | NA                  | 2024-02-28 13:22:17 |
 
 ## Sponsor
 
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -3,4 +3,10 @@ home:
   description: Read all commit messages and sort them according to
     tags or specific text pattern.
 template:
-  package: thinkrtemplate
+  bootstrap: 5
+  bslib:
+    bg: "#ffffff"
+    fg: "#3b4450"
+    primary: "#DE633C"
+    secondary: "#15b7d6"
+    body-color: "#28292B"
diff --git a/dev_history.R b/dev_history.R
@@ -62,7 +62,7 @@ checkhelper::print_globals(globals)
 #              travis_endpoint = ".org")
 # # usethis::use_travis()
 # usethis::use_appveyor()
-usethis::use_github_action_check_standard()
+usethis::use_github_action("check-standard")
 usethis::use_github_action("pkgdown")
 usethis::use_github_action("test-coverage")
 
