Merge pull request #284 from cmu-delphi/readmeTweak #448
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 | |
| # | |
| # Edits from above workflow: also check pkgdown for PRs to `dev` branch, and | |
| # update the documentation web site on pushes to `dev` branch. | |
| on: | |
| push: | |
| branches: [main, dev] | |
| pull_request: | |
| branches: [main, dev] | |
| release: | |
| types: [published] | |
| workflow_dispatch: | |
| name: pkgdown | |
| jobs: | |
| pkgdown: | |
| # only build docs on the main repository and not forks | |
| if: github.repository_owner == 'cmu-delphi' | |
| 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 }} | |
| DELPHI_EPIDATA_KEY: ${{ secrets.SECRET_EPIDATR_GHACTIONS_DELPHI_EPIDATA_KEY }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: r-lib/actions/setup-pandoc@v2 | |
| - uses: r-lib/actions/setup-r@v2 | |
| with: | |
| use-public-rspm: true | |
| - uses: r-lib/actions/setup-r-dependencies@v2 | |
| with: | |
| extra-packages: any::pkgdown, local::., any::cli | |
| needs: website | |
| - name: Build site | |
| # - target_ref gets the ref from a different variable, depending on the event | |
| # - override allows us to set the pkgdown mode and version_label | |
| # - mode: release is the standard build mode, devel places the site in /dev | |
| # - version_label: 'light' and 'success' are CSS labels for Bootswatch: Cosmo | |
| # https://bootswatch.com/cosmo/ | |
| # - we use pkgdown:::build_github_pages to build the site because of an issue in pkgdown | |
| # https://github.com/r-lib/pkgdown/issues/2257 | |
| run: | | |
| target_ref <- "${{ github.event_name == 'pull_request' && github.base_ref || github.ref }}" | |
| override <- if (target_ref == "main" || target_ref == "refs/heads/main") { | |
| list(development = list(mode = "release", version_label = "light")) | |
| } else if (target_ref == "dev" || target_ref == "refs/heads/dev") { | |
| list(development = list(mode = "devel", version_label = "success")) | |
| } else { | |
| stop("Unexpected target_ref: ", target_ref) | |
| } | |
| pkg <- pkgdown::as_pkgdown(".", override = override) | |
| cli::cli_rule("Cleaning files from old site...") | |
| pkgdown::clean_site(pkg) | |
| pkgdown::build_site(pkg, preview = FALSE, install = FALSE, new_process = FALSE) | |
| pkgdown:::build_github_pages(pkg) | |
| shell: Rscript {0} | |
| - name: Deploy to GitHub pages 🚀 | |
| if: github.event_name != 'pull_request' | |
| uses: JamesIves/[email protected] | |
| with: | |
| clean: false | |
| branch: gh-pages | |
| folder: docs |