Skip to content

Commit 392792e

Browse files
wlandauwlandau
committed
Docs and checks
1 parent 0c9d758 commit 392792e

File tree

8 files changed

+107
-152
lines changed

8 files changed

+107
-152
lines changed

‎.github/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

‎.github/workflows/check.yaml‎

Lines changed: 23 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
13
on:
24
push:
3-
branches:
4-
- main
5+
branches: [main, master]
56
pull_request:
6-
branches:
7-
- main
7+
branches: [main, master]
88

9-
name: check
9+
name: R-CMD-check
1010

1111
jobs:
12-
check:
12+
R-CMD-check:
1313
runs-on: ${{ matrix.config.os }}
1414

1515
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
@@ -18,63 +18,32 @@ jobs:
1818
fail-fast: false
1919
matrix:
2020
config:
21+
- {os: macos-latest, r: 'release'}
2122
- {os: windows-latest, r: 'release'}
22-
- {os: macOS-latest, r: 'release'}
23-
- {os: ubuntu-16.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
23+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24+
- {os: ubuntu-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'oldrel-1'}
2426

2527
env:
26-
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
27-
RSPM: ${{ matrix.config.rspm }}
28-
GITHUB_PAT: ${{ secrets.GITHUBPAT }}
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
R_KEEP_PKG_SOURCE: yes
2930

3031
steps:
31-
- uses: actions/checkout@v2
32+
- uses: actions/checkout@v3
3233

33-
- uses: r-lib/actions/setup-r@master
34+
- uses: r-lib/actions/setup-pandoc@v2
35+
36+
- uses: r-lib/actions/setup-r@v2
3437
with:
3538
r-version: ${{ matrix.config.r }}
39+
http-user-agent: ${{ matrix.config.http-user-agent }}
40+
use-public-rspm: true
3641

37-
- uses: r-lib/actions/setup-pandoc@master
38-
39-
- name: Query dependencies
40-
run: |
41-
install.packages('remotes')
42-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
43-
shell: Rscript {0}
44-
45-
- name: Cache R packages
46-
if: runner.os != 'Windows'
47-
uses: actions/cache@v1
42+
- uses: r-lib/actions/setup-r-dependencies@v2
4843
with:
49-
path: ${{ env.R_LIBS_USER }}
50-
key: ${{ runner.os }}-r-${{ matrix.config.r }}-1-${{ hashFiles('.github/depends.Rds') }}
51-
restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-1-
52-
53-
- name: Install system dependencies
54-
if: runner.os == 'Linux'
55-
env:
56-
RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
57-
run: |
58-
Rscript -e "remotes::install_github('r-hub/sysreqs')"
59-
sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
60-
sudo -s eval "$sysreqs"
61-
62-
- name: Install dependencies
63-
run: |
64-
remotes::install_deps(dependencies = TRUE)
65-
remotes::install_cran("rcmdcheck")
66-
shell: Rscript {0}
67-
68-
- name: Check
69-
env:
70-
_R_CHECK_CRAN_INCOMING_REMOTE_: false
71-
_R_CHECK_FORCE_SUGGESTS_: false
72-
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
73-
shell: Rscript {0}
44+
extra-packages: any::rcmdcheck
45+
needs: check
7446

75-
- name: Upload check results
76-
if: failure()
77-
uses: actions/upload-artifact@master
47+
- uses: r-lib/actions/check-r-package@v2
7848
with:
79-
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
80-
path: check
49+
upload-snapshots: true

‎.github/workflows/cover.yaml‎

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,50 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
13
on:
24
push:
3-
branches:
4-
- main
5+
branches: [main, master]
56
pull_request:
6-
branches:
7-
- main
7+
branches: [main, master]
88

99
name: cover
1010

1111
jobs:
1212
cover:
13-
runs-on: macOS-latest
13+
runs-on: ubuntu-latest
1414
env:
15-
GITHUB_PAT: ${{ secrets.GITHUBPAT }}
15+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
16+
1617
steps:
17-
- uses: actions/checkout@v2
18+
- uses: actions/checkout@v3
1819

19-
- uses: r-lib/actions/setup-r@master
20+
- uses: r-lib/actions/setup-r@v2
21+
with:
22+
use-public-rspm: true
2023

21-
- uses: r-lib/actions/setup-pandoc@master
24+
- uses: r-lib/actions/setup-r-dependencies@v2
25+
with:
26+
extra-packages: any::covr
27+
needs: coverage
2228

23-
- name: Query dependencies
29+
- name: Test coverage
2430
run: |
25-
install.packages('remotes')
26-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
31+
covr::codecov(
32+
quiet = FALSE,
33+
clean = FALSE,
34+
install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
35+
)
2736
shell: Rscript {0}
2837

29-
- name: Cache R packages
30-
uses: actions/cache@v1
31-
with:
32-
path: ${{ env.R_LIBS_USER }}
33-
key: macOS-r-4.0-1-${{ hashFiles('.github/depends.Rds') }}
34-
restore-keys: macOS-r-4.0-1-
35-
36-
- name: Install dependencies
38+
- name: Show testthat output
39+
if: always()
3740
run: |
38-
install.packages(c("remotes"))
39-
remotes::install_deps(dependencies = TRUE)
40-
remotes::install_cran("covr")
41-
shell: Rscript {0}
41+
## --------------------------------------------------------------------
42+
find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
43+
shell: bash
4244

43-
- name: Test coverage
44-
run: covr::codecov()
45-
shell: Rscript {0}
45+
- name: Upload test results
46+
if: failure()
47+
uses: actions/upload-artifact@v3
48+
with:
49+
name: coverage-test-failures
50+
path: ${{ runner.temp }}/package

‎.github/workflows/lint.yaml‎

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,32 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
13
on:
24
push:
3-
branches:
4-
- main
5+
branches: [main, master]
56
pull_request:
6-
branches:
7-
- main
7+
branches: [main, master]
88

99
name: lint
1010

1111
jobs:
1212
lint:
13-
runs-on: macOS-latest
13+
runs-on: ubuntu-latest
1414
env:
15-
GITHUB_PAT: ${{ secrets.GITHUBPAT }}
15+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
1616
steps:
17-
- uses: actions/checkout@v2
17+
- uses: actions/checkout@v3
1818

19-
- uses: r-lib/actions/setup-r@master
20-
21-
- name: Query dependencies
22-
run: |
23-
install.packages('remotes')
24-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
25-
shell: Rscript {0}
26-
27-
- name: Cache R packages
28-
uses: actions/cache@v1
19+
- uses: r-lib/actions/setup-r@v2
2920
with:
30-
path: ${{ env.R_LIBS_USER }}
31-
key: macOS-r-4.0-1-${{ hashFiles('.github/depends.Rds') }}
32-
restore-keys: macOS-r-4.0-1-
21+
use-public-rspm: true
3322

34-
- name: Install dependencies
35-
run: |
36-
install.packages(c("remotes"))
37-
remotes::install_deps(dependencies = TRUE)
38-
remotes::install_cran("lintr")
39-
shell: Rscript {0}
23+
- uses: r-lib/actions/setup-r-dependencies@v2
24+
with:
25+
extra-packages: any::lintr, local::.
26+
needs: lint
4027

4128
- name: Lint
42-
run: |
43-
out <- lintr::lint_package()
44-
print(out)
45-
if (length(out)) stop("lints found")
29+
run: lintr::lint_package()
4630
shell: Rscript {0}
31+
env:
32+
LINTR_ERROR_ON_LINT: true

‎.github/workflows/pkgdown.yaml‎

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,46 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
13
on:
24
push:
3-
branches: main
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
411

512
name: pkgdown
613

714
jobs:
815
pkgdown:
9-
runs-on: macOS-latest
16+
runs-on: ubuntu-latest
17+
# Only restrict concurrency for non-PR jobs
18+
concurrency:
19+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
1020
env:
1121
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
1222
steps:
13-
- uses: actions/checkout@v2
23+
- uses: actions/checkout@v3
1424

15-
- uses: r-lib/actions/setup-r@master
25+
- uses: r-lib/actions/setup-pandoc@v2
1626

17-
- uses: r-lib/actions/setup-pandoc@master
18-
19-
- name: Query dependencies
20-
run: |
21-
install.packages('remotes')
22-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
23-
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
24-
shell: Rscript {0}
27+
- uses: r-lib/actions/setup-r@v2
28+
with:
29+
use-public-rspm: true
2530

26-
- name: Cache R packages
27-
uses: actions/cache@v1
31+
- uses: r-lib/actions/setup-r-dependencies@v2
2832
with:
29-
path: ${{ env.R_LIBS_USER }}
30-
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
31-
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
33+
extra-packages: any::pkgdown, local::.
34+
needs: website
3235

33-
- name: Install Mac system dependencies
34-
run: |
35-
brew install zeromq
36-
- name: Install dependencies
37-
run: |
38-
install.packages("remotes")
39-
remotes::install_deps(dependencies = TRUE)
40-
remotes::install_dev("pkgdown")
36+
- name: Build site
37+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
4138
shell: Rscript {0}
4239

43-
- name: Install package
44-
run: R CMD INSTALL .
45-
46-
- name: Deploy package
47-
run: |
48-
git config --global user.email "${{ secrets.EMAIL }}"
49-
git config --global user.name "wlandau"
50-
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
40+
- name: Deploy to GitHub pages
41+
if: github.event_name != 'pull_request'
42+
uses: JamesIves/[email protected]
43+
with:
44+
clean: false
45+
branch: gh-pages
46+
folder: docs

‎.lintr‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
exclusions: list(
2-
"inst/templates/usedrake/make.R",
3-
"inst/templates/usedrake/_drake.R")
4-
linters: with_defaults(
5-
camel_case_linter = NULL,
1+
linters: linters_with_defaults(
2+
object_length_linter = NULL,
63
object_name_linter = NULL,
7-
object_usage_linter = NULL,
8-
snake_case_linter = NULL)
4+
object_usage_linter = NULL)

‎DESCRIPTION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ SystemRequirements:
5151
Graphviz (https://www.graphviz.org/),
5252
pprof (https://github.com/google/pprof)
5353
Roxygen: list(markdown = TRUE)
54-
RoxygenNote: 7.1.1
54+
RoxygenNote: 7.2.3

‎inst/WORDLIST‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ AppVeyor
44
Codecov
55
codecov
66
cran
7+
CRAN
8+
CRAN's
79
datatable
810
env
911
environ

0 commit comments

Comments
 (0)