Skip to content

Commit 980b77b

Browse files
hadleyhadley
authored
Upkeep 2023-10 (#2365)
* Rebrand * Update logo and favicons * Recommend pak * `usethis::use_mit_license()` * Bump required R version * `usethis::use_tidy_github_actions()`
1 parent d5432a4 commit 980b77b

18 files changed

+34
-58
lines changed

‎.github/workflows/pkgdown.yaml

+19-45
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
22
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
33
on:
44
push:
55
branches: [main, master]
6-
tags: ['*']
76
pull_request:
8-
branches: [master, main]
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
911

1012
name: pkgdown
1113

1214
jobs:
1315
pkgdown:
14-
if: github.event_name == 'push' || github.event.pull_request.head.repo.fork == false
1516
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 }}
1620
env:
1721
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
18-
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
19-
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
20-
isPush: ${{ github.event_name == 'push' }}
21-
22+
permissions:
23+
contents: write
2224
steps:
23-
- uses: actions/checkout@v2
24-
25-
- uses: r-lib/actions/setup-tinytex@v2
25+
- uses: actions/checkout@v3
2626

2727
- uses: r-lib/actions/setup-pandoc@v2
2828

@@ -35,40 +35,14 @@ jobs:
3535
extra-packages: any::pkgdown, local::.
3636
needs: website
3737

38-
- name: Install package
39-
run: R CMD INSTALL .
40-
41-
- name: Build and deploy pkgdown site
42-
if: contains(env.isPush, 'true')
43-
run: |
44-
git config --local user.name "$GITHUB_ACTOR"
45-
git config --local user.email "[email protected]"
46-
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
47-
48-
- name: Create website
49-
if: contains(env.isPush, 'false')
50-
run: |
51-
pkgdown::build_site()
38+
- name: Build site
39+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
5240
shell: Rscript {0}
5341

54-
- name: Create index file
55-
if: contains(env.isPush, 'false')
56-
run: |
57-
echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0;URL=/dev/index.html" /> <script language="javascript"> window.location.replace('/dev/index.html')</script></head></html>' > ./docs/index.html
58-
59-
- name: Deploy to Netlify
60-
if: contains(env.isPush, 'false')
61-
id: netlify-deploy
62-
uses: nwtgck/[email protected]
42+
- name: Deploy to GitHub pages 🚀
43+
if: github.event_name != 'pull_request'
44+
uses: JamesIves/[email protected]
6345
with:
64-
publish-dir: './docs'
65-
production-branch: master
66-
github-token: ${{ secrets.GITHUB_TOKEN }}
67-
deploy-message:
68-
'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})'
69-
# these all default to 'true'
70-
enable-pull-request-comment: false
71-
enable-commit-comment: false
72-
# enable-commit-status: true
73-
#o verwrites-pull-request-comment: true
74-
timeout-minutes: 1
46+
clean: false
47+
branch: gh-pages
48+
folder: docs

‎.github/workflows/test-coverage.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
covr::codecov(
3434
quiet = FALSE,
3535
clean = FALSE,
36-
install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
36+
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
3737
)
3838
shell: Rscript {0}
3939

‎DESCRIPTION

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Package: pkgdown
22
Title: Make Static HTML Documentation for a Package
33
Version: 2.0.7.9000
44
Authors@R: c(
5-
person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre"),
5+
person("Hadley", "Wickham", , "hadley@posit.co", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0003-4757-117X")),
77
person("Jay", "Hesselberth", role = "aut",
88
comment = c(ORCID = "0000-0002-6299-179X")),
99
person("Maëlle", "Salmon", role = "aut",
1010
comment = c(ORCID = "0000-0002-2815-0399")),
11-
person("RStudio", role = c("cph", "fnd"))
11+
person("Posit Software, PBC", role = c("cph", "fnd"))
1212
)
1313
Description: Generate an attractive and useful website from a source
1414
package. 'pkgdown' converts your documentation, vignettes, 'README',
@@ -18,7 +18,7 @@ License: MIT + file LICENSE
1818
URL: https://pkgdown.r-lib.org, https://github.com/r-lib/pkgdown
1919
BugReports: https://github.com/r-lib/pkgdown/issues
2020
Depends:
21-
R (>= 3.1.0)
21+
R (>= 3.6)
2222
Imports:
2323
bslib (>= 0.3.1),
2424
callr (>= 3.7.3),
@@ -64,5 +64,5 @@ Config/potools/style: explicit
6464
Config/testthat/edition: 3
6565
Encoding: UTF-8
6666
Roxygen: list(markdown = TRUE)
67-
RoxygenNote: 7.2.2.9000
67+
RoxygenNote: 7.2.3
6868
SystemRequirements: pandoc

‎LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
YEAR: 2014--2018
2-
COPYRIGHT HOLDER: RStudio
1+
YEAR: 2023
2+
COPYRIGHT HOLDER: pkgdown authors

‎LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MIT License
22

3-
Copyright (c) 2014-2018 RStudio
3+
Copyright (c) 2023 pkgdown authors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.Rmd

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ install.packages("pkgdown")
3434
::: .pkgdown-devel
3535
```{r, eval = FALSE}
3636
# Install development version from GitHub
37-
devtools::install_github("r-lib/pkgdown")
37+
# install.packages("pak")
38+
pak::pak("r-lib/pkgdown")
3839
```
3940
:::
4041

‎README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ install.packages("pkgdown")
3737

3838
``` r
3939
# Install development version from GitHub
40-
devtools::install_github("r-lib/pkgdown")
40+
# install.packages("pak")
41+
pak::pak("r-lib/pkgdown")
4142
```
4243

4344
</div>
@@ -81,7 +82,7 @@ Then learn about the many new ways to customise your site in
8182

8283
## In the wild
8384

84-
At last count, pkgdown is used [by over 6,000
85+
At last count, pkgdown is used [by over 8,000
8586
packages](https://github.com/search?q=path%3A_pkgdown.yml+language%3AYAML&type=code&l=YAML).
8687
Here are a few examples created by contributors to pkgdown:
8788

‎man/figures/logo.png

-36.3 KB
Loading

‎man/pkgdown-package.Rd

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkgdown/favicon/apple-touch-icon-120x120.png

-5.28 KB
Loading

‎pkgdown/favicon/apple-touch-icon-152x152.png

-8.6 KB
Loading

‎pkgdown/favicon/apple-touch-icon-180x180.png

-11.7 KB
Loading

‎pkgdown/favicon/apple-touch-icon-60x60.png

-1.27 KB
Loading

‎pkgdown/favicon/apple-touch-icon-76x76.png

-1.99 KB
Loading

‎pkgdown/favicon/apple-touch-icon.png

-11.7 KB
Loading

‎pkgdown/favicon/favicon-16x16.png

-102 Bytes
Loading

‎pkgdown/favicon/favicon-32x32.png

-423 Bytes
Loading

‎pkgdown/favicon/favicon.ico

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)