diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html 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/.gitignore b/.gitignore index ff5a4f6..e555c0a 100644 --- a/.gitignore +++ b/.gitignore @@ -50,3 +50,4 @@ rsconnect/ # other next_actions.md +docs diff --git a/DESCRIPTION b/DESCRIPTION index 802ac2d..72cc615 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -8,7 +8,7 @@ Description: This package provides functions that extend the tidymodels ecosystem to enable usage of predictive models with offset terms. License: MIT + file LICENSE -URL: https://github.com/mattheaphy/offsetreg/, +URL: https://github.com/mattheaphy/offsetreg/, https://mattheaphy.github.io/offsetreg/ Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.2.3 diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..25e4dd4 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,8 @@ +url: https://mattheaphy.github.io/offsetreg/ +template: + bootstrap: 5 + bootswatch: zephyr +footer: + structure: + left: developed_by + right: built_with