update contributing to include reference to dev guide #92
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/pkgdown/blob/main/.github/workflows/pkgdown.yaml | |
| # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | |
| on: | |
| push: | |
| branches: [main, master] | |
| pull_request: | |
| branches: [main, master] | |
| release: | |
| types: [published] | |
| workflow_dispatch: | |
| name: pkgdown-pr-preview | |
| jobs: | |
| pkgdown-pr-preview: | |
| 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' || github.event_name == 'workflow_dispatch' }} | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: r-lib/actions/setup-tinytex@v2 | |
| - name: Set up Quarto | |
| uses: quarto-dev/quarto-actions/setup@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: Build site | |
| run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) | |
| shell: Rscript {0} | |
| - name: Deploy production to GitHub pages 🚀 | |
| if: contains(env.isPush, 'true') | |
| uses: JamesIves/[email protected] | |
| with: | |
| clean: false | |
| branch: gh-pages | |
| folder: docs | |
| - id: deploy-dir | |
| name: Determine dev status | |
| run: | | |
| if [[ $(grep -c -E 'sion. ([0-9]*\.){3}' ${{ github.workspace }}/DESCRIPTION) == 1 ]]; then | |
| echo 'dir=./docs/dev' >> $GITHUB_OUTPUT | |
| else | |
| echo 'dir=./docs' >> $GITHUB_OUTPUT | |
| fi | |
| - name: Deploy PR preview to Netlify | |
| if: contains(env.isPush, 'false') | |
| id: netlify-deploy | |
| uses: nwtgck/actions-netlify@v3 | |
| with: | |
| publish-dir: '${{ steps.deploy-dir.outputs.dir }}' | |
| production-branch: main | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| deploy-message: | |
| 'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})' | |
| enable-pull-request-comment: true | |
| enable-commit-comment: false | |
| enable-commit-status: false | |
| enable-github-deployment: false | |
| overwrites-pull-request-comment: true | |
| fails-without-credentials: true | |
| timeout-minutes: 1 |