From 514d41a5b780c2dff130e891e0fbab4808b44586 Mon Sep 17 00:00:00 2001 From: gbganalyst Date: Tue, 6 Feb 2024 18:18:38 +0100 Subject: [PATCH] pkg down --- .Rbuildignore | 3 +++ .github/workflows/pkgdown.yaml | 48 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 2 +- README.Rmd | 5 ---- _pkgdown.yml | 4 +++ 6 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index fbd392b..6938886 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -8,3 +8,6 @@ ^codecov\.yml$ ^doc$ ^Meta$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..a7276e8 --- /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@v4 + + - 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.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index e77a603..4dcd0be 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ inst/doc /doc/ /Meta/ +docs diff --git a/DESCRIPTION b/DESCRIPTION index c88d2ef..4df9c3c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -22,7 +22,7 @@ Description: Designed to simplify and streamline the process of reading workflows. Additionally, the package seamlessly works with labelled data from SPSS and Stata. License: MIT + file LICENSE -URL: https://github.com/gbganalyst/bulkreadr +URL: https://github.com/gbganalyst/bulkreadr, https://gbganalyst.github.io/bulkreadr/ BugReports: https://github.com/gbganalyst/bulkreadr/issues Depends: purrr diff --git a/README.Rmd b/README.Rmd index 40c2ef0..7b36c3b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -89,11 +89,6 @@ This section provides a concise overview of the different functions available in | [`read_stata_data()`](#read_stata_data) | [`fill_missing_values()`](#fill_missing_values) | - - - - - **Note:** > For the majority of functions within this package, we will utilize data stored in the system file by the `bulkreadr`, which can be accessed using the `system.file()` function. If you wish to utilize your own data stored in your local directory, please ensure that you have set the appropriate file path prior to using any functions provided by the bulkreadr package. diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..96a8ec8 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://gbganalyst.github.io/bulkreadr/ +template: + bootstrap: 5 +