diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index ecaf36d348..ed7650c73c 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -1,28 +1,28 @@ -# 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] - tags: ['*'] pull_request: - branches: [master, main] + branches: [main, master] + release: + types: [published] + workflow_dispatch: name: pkgdown jobs: pkgdown: - if: github.event_name == 'push' || github.event.pull_request.head.repo.fork == false 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 }} - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} - isPush: ${{ github.event_name == 'push' }} - + permissions: + contents: write steps: - - uses: actions/checkout@v2 - - - uses: r-lib/actions/setup-tinytex@v2 + - uses: actions/checkout@v3 - uses: r-lib/actions/setup-pandoc@v2 @@ -35,40 +35,14 @@ jobs: extra-packages: any::pkgdown, local::. needs: website - - name: Install package - run: R CMD INSTALL . - - - name: Build and deploy pkgdown site - if: contains(env.isPush, 'true') - run: | - git config --local user.name "$GITHUB_ACTOR" - git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com" - Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)' - - - name: Create website - if: contains(env.isPush, 'false') - run: | - pkgdown::build_site() + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) shell: Rscript {0} - - name: Create index file - if: contains(env.isPush, 'false') - run: | - echo '
' > ./docs/index.html - - - name: Deploy to Netlify - if: contains(env.isPush, 'false') - id: netlify-deploy - uses: nwtgck/actions-netlify@v1.1 + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.4.1 with: - publish-dir: './docs' - production-branch: master - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: - 'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})' - # these all default to 'true' - enable-pull-request-comment: false - enable-commit-comment: false - # enable-commit-status: true - #o verwrites-pull-request-comment: true - timeout-minutes: 1 + clean: false + branch: gh-pages + folder: docs diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index 7a69ec410e..4b5b0eb687 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -33,7 +33,7 @@ jobs: covr::codecov( quiet = FALSE, clean = FALSE, - install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package") + install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") ) shell: Rscript {0} diff --git a/DESCRIPTION b/DESCRIPTION index 25e38d08e2..2e6ef540ad 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,13 +2,13 @@ Package: pkgdown Title: Make Static HTML Documentation for a Package Version: 2.0.7.9000 Authors@R: c( - person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre"), + person("Hadley", "Wickham", , "hadley@posit.co", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-4757-117X")), person("Jay", "Hesselberth", role = "aut", comment = c(ORCID = "0000-0002-6299-179X")), person("Maëlle", "Salmon", role = "aut", comment = c(ORCID = "0000-0002-2815-0399")), - person("RStudio", role = c("cph", "fnd")) + person("Posit Software, PBC", role = c("cph", "fnd")) ) Description: Generate an attractive and useful website from a source package. 'pkgdown' converts your documentation, vignettes, 'README', @@ -18,7 +18,7 @@ License: MIT + file LICENSE URL: https://pkgdown.r-lib.org, https://github.com/r-lib/pkgdown BugReports: https://github.com/r-lib/pkgdown/issues Depends: - R (>= 3.1.0) + R (>= 3.6) Imports: bslib (>= 0.3.1), callr (>= 3.7.3), @@ -64,5 +64,5 @@ Config/potools/style: explicit Config/testthat/edition: 3 Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.2.9000 +RoxygenNote: 7.2.3 SystemRequirements: pandoc diff --git a/LICENSE b/LICENSE index 8b3f0d421f..7acb56cd70 100644 --- a/LICENSE +++ b/LICENSE @@ -1,2 +1,2 @@ -YEAR: 2014--2018 -COPYRIGHT HOLDER: RStudio +YEAR: 2023 +COPYRIGHT HOLDER: pkgdown authors diff --git a/LICENSE.md b/LICENSE.md index c9f975512b..0a6c13c631 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2014-2018 RStudio +Copyright (c) 2023 pkgdown authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.Rmd b/README.Rmd index 86b3077986..9211af9c85 100644 --- a/README.Rmd +++ b/README.Rmd @@ -34,7 +34,8 @@ install.packages("pkgdown") ::: .pkgdown-devel ```{r, eval = FALSE} # Install development version from GitHub -devtools::install_github("r-lib/pkgdown") +# install.packages("pak") +pak::pak("r-lib/pkgdown") ``` ::: diff --git a/README.md b/README.md index 77fec024f5..8f6acb6617 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ install.packages("pkgdown") ``` r # Install development version from GitHub -devtools::install_github("r-lib/pkgdown") +# install.packages("pak") +pak::pak("r-lib/pkgdown") ``` @@ -81,7 +82,7 @@ Then learn about the many new ways to customise your site in ## In the wild -At last count, pkgdown is used [by over 6,000 +At last count, pkgdown is used [by over 8,000 packages](https://github.com/search?q=path%3A_pkgdown.yml+language%3AYAML&type=code&l=YAML). Here are a few examples created by contributors to pkgdown: diff --git a/man/figures/logo.png b/man/figures/logo.png index 8b92dae7dc..c415dc0ea4 100644 Binary files a/man/figures/logo.png and b/man/figures/logo.png differ diff --git a/man/pkgdown-package.Rd b/man/pkgdown-package.Rd index 9fb5fa1f47..0a833e0db6 100644 --- a/man/pkgdown-package.Rd +++ b/man/pkgdown-package.Rd @@ -20,7 +20,7 @@ Useful links: } \author{ -\strong{Maintainer}: Hadley Wickham \email{hadley@rstudio.com} (\href{https://orcid.org/0000-0003-4757-117X}{ORCID}) +\strong{Maintainer}: Hadley Wickham \email{hadley@posit.co} (\href{https://orcid.org/0000-0003-4757-117X}{ORCID}) Authors: \itemize{ @@ -30,7 +30,7 @@ Authors: Other contributors: \itemize{ - \item RStudio [copyright holder, funder] + \item Posit Software, PBC [copyright holder, funder] } } diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png index 3d77ee5f01..9386a565a9 100644 Binary files a/pkgdown/favicon/apple-touch-icon-120x120.png and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png index e10c0ddba1..7c41c07384 100644 Binary files a/pkgdown/favicon/apple-touch-icon-152x152.png and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png index cea144241d..4d75fa7354 100644 Binary files a/pkgdown/favicon/apple-touch-icon-180x180.png and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png index 679f010e89..18049b161a 100644 Binary files a/pkgdown/favicon/apple-touch-icon-60x60.png and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png index 884b4d4974..755d5f03ec 100644 Binary files a/pkgdown/favicon/apple-touch-icon-76x76.png and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png index 0b2624a1d2..f1d46ea800 100644 Binary files a/pkgdown/favicon/apple-touch-icon.png and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png index 25bea8c837..58c7cba9a3 100644 Binary files a/pkgdown/favicon/favicon-16x16.png and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png index 138246197d..94135aae86 100644 Binary files a/pkgdown/favicon/favicon-32x32.png and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico index 8e9b72f457..7fef537c9d 100644 Binary files a/pkgdown/favicon/favicon.ico and b/pkgdown/favicon/favicon.ico differ