Merge pull request #76 from bcgov/update-actions

Update GH actions + readme badge url

Author: stephhazlitt

.github/workflows/R-CMD-check.yaml

@@ -1,16 +1,14 @@
-# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
-# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+# 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
+    branches: [main, master]
   pull_request:
-    branches:
-      - main
-      - master
+    branches: [main, master]
 
-name: R-CMD-check
+name: R-CMD-check.yaml
+
+permissions: read-all
 
 jobs:
   R-CMD-check:
@@ -22,65 +20,33 @@ jobs:
       fail-fast: false
       matrix:
         config:
+          - {os: macos-latest,   r: 'release'}
           - {os: windows-latest, r: 'release'}
-          - {os: macOS-latest, r: 'release'}
-          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
-          - {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
 
     env:
-      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
-      RSPM: ${{ matrix.config.rspm }}
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
+      - 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-pandoc@v1
-
-      - name: Query dependencies
-        run: |
-          install.packages('remotes')
-          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
-          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
-        shell: Rscript {0}
-
-      - name: Restore R package cache
-        if: runner.os != 'Windows'
-        uses: actions/cache@v2
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          path: ${{ env.R_LIBS_USER }}
-          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
-          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
-
-      - name: Install system dependencies
-        if: runner.os == 'Linux'
-        run: |
-          while read -r cmd
-          do
-            eval sudo $cmd
-          done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))')
-
-      - name: Install dependencies
-        run: |
-          remotes::install_deps(dependencies = TRUE)
-          remotes::install_cran("rcmdcheck")
-        shell: Rscript {0}
-
-      - name: Check
-        env:
-          _R_CHECK_CRAN_INCOMING_REMOTE_: false
-        run: |
-          options(crayon.enabled = TRUE)
-          rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
-        shell: Rscript {0}
+          extra-packages: any::rcmdcheck
+          needs: check
 
-      - name: Upload check results
-        if: failure()
-        uses: actions/upload-artifact@main
+      - uses: r-lib/actions/check-r-package@v2
         with:
-          name: ${{ runner.os }}-r${{ matrix.config.r }}-results
-          path: check
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

README.Rmd

@@ -16,9 +16,13 @@ knitr::opts_chunk$set(
 ```
 
 # bcgovr <img src="tools/readme/logo.png" align="right" />
-[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
-[![R-CMD-check](https://github.com/bcgov/bcgovr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/bcgovr/actions)
+
+<!-- badges: start -->
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
+[![R-CMD-check](https://github.com/bcgov/bcgovr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcgov/bcgovr/actions/workflows/R-CMD-check.yaml)
+
+<!-- badges: end -->
 
 
 ## Overview

README.md

@@ -3,9 +3,13 @@
 
 # bcgovr <img src="tools/readme/logo.png" align="right" />
 
-[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
-[![R-CMD-check](https://github.com/bcgov/bcgovr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/bcgovr/actions)
+<!-- badges: start -->
+
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
+[![R-CMD-check](https://github.com/bcgov/bcgovr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcgov/bcgovr/actions/workflows/R-CMD-check.yaml)
+
+<!-- badges: end -->
 
 ## Overview
 
@@ -74,16 +78,16 @@ required bcgov GitHub files and initialise Git version control.
 The `bcgovr` package installs a set of [RStudio
 Addins](https://rstudio.github.io/rstudioaddins/):
 
-1.  Insert the [boiler-plate Apache 2.0 license
+1)  Insert the [boiler-plate Apache 2.0 license
     header](https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/Licenses.md)
     into the comments header of a source file (uses
     `insert_bcgov_apache_header()`).
-2.  Insert the [boiler-plate Creative Commons Attribution 4.0
+2)  Insert the [boiler-plate Creative Commons Attribution 4.0
     International License
     header](https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/Licenses.md)
     into the comments header of a source file (uses
     `insert_bcgov_cc_header()`).
-3.  Insert a [bcgov project lifecycle
+3)  Insert a [bcgov project lifecycle
     badge](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
     into an .Rmd or .md file to indicate the current state of a project
     (uses `insert_bcgov_lifecycle_badge()`).
@@ -332,16 +336,16 @@ There are several options you can specify in your `.Rprofile` file to
 customise the default behaviour when using the `create_bcgov_` and
 `use_bcgov_` functions in `bcgovr`.
 
--   `bcgovr.coc.email`: Code of Conduct contact email address
+- `bcgovr.coc.email`: Code of Conduct contact email address
 
--   `bcgovr.dir.struct`: Alternative project directory structure for
-    `create_bcgov_project()`. This should be specified as a character
-    vector of directory (i.e. folders) and file paths, relative to the
-    root of the project. Directories should be identified by having a
-    trailing forward-slash (e.g., `"dir/"`).
+- `bcgovr.dir.struct`: Alternative project directory structure for
+  `create_bcgov_project()`. This should be specified as a character
+  vector of directory (i.e. folders) and file paths, relative to the
+  root of the project. Directories should be identified by having a
+  trailing forward-slash (e.g., `"dir/"`).
 
-    The default is:
-    `c("R/", "data/", "out/", "01_load.R", "02_clean.R", "03_analysis.R", "04_output.R", "internal.R", "run_all.R")`.
+  The default is:
+  `c("R/", "data/", "out/", "01_load.R", "02_clean.R", "03_analysis.R", "04_output.R", "internal.R", "run_all.R")`.
 
 To make use of these options, there should be a section in your
 `.Rprofile` file that looks something like this: