Edit GitHub syntax to see _pkgdown.yml config advice (#2343) #2041
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/master/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] | |
| name: pkgdown | |
| jobs: | |
| pkgdown: | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.fork == false | |
| runs-on: ubuntu-latest | |
| 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' }} | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: r-lib/actions/setup-tinytex@v2 | |
| - 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::. | |
| 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 "[email protected]" | |
| Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)' | |
| - name: Create website | |
| if: contains(env.isPush, 'false') | |
| run: | | |
| pkgdown::build_site() | |
| shell: Rscript {0} | |
| - name: Create index file | |
| if: contains(env.isPush, 'false') | |
| run: | | |
| 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 | |
| - name: Deploy to Netlify | |
| if: contains(env.isPush, 'false') | |
| id: netlify-deploy | |
| uses: nwtgck/[email protected] | |
| 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 |