From cb8e0a20bd70d4281fb4371774d2831fccab6ce0 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Berrard <8382354+py-b@users.noreply.github.com> Date: Mon, 24 Jul 2023 11:12:10 +0200 Subject: [PATCH] pkgdown via github pages (#7) --- .Rbuildignore | 2 ++ .github/workflows/pkgdown.yaml | 48 ++++++++++++++++++++++++++++++++++ .travis.yml | 8 +++--- _pkgdown.yml | 4 +++ 4 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 04c97cd..f907b1d 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,5 @@ ^tests/testthat/\.httr-oauth$ ^\.github$ ^pkgdown$ +^_pkgdown\.yml$ +^docs$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..ed7650c --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,48 @@ +# 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] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + 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 }} + permissions: + contents: write + 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::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.travis.yml b/.travis.yml index 475eaca..8c29d7d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,7 +11,7 @@ r_packages: cache: packages after_success: - Rscript -e 'covr::codecov()' -deploy: - provider: script - script: Rscript -e 'pkgdown::deploy_site_github(ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY"))' - skip_cleanup: true +# deploy: +# provider: script +# script: Rscript -e 'pkgdown::deploy_site_github(ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY"))' +# skip_cleanup: true diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..88bd4cd --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://inseefrlab.github.io/apinsee/ +template: + bootstrap: 5 +