From 4d00957547ed757785de4e96027f44016fc5ad42 Mon Sep 17 00:00:00 2001 From: Skorik Sophia Date: Thu, 14 Dec 2023 17:30:17 +0100 Subject: [PATCH] set up pkgdown config --- .Rbuildignore | 4 +++ .github/.gitignore | 1 + .github/workflows/R-CMD-check.yaml | 49 ++++++++++++++++++++++++++++++ .gitignore | 1 + README.Rmd | 1 + README.md | 2 ++ _pkgdown.yml | 28 +++++++++++++++++ 7 files changed, 86 insertions(+) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/R-CMD-check.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 8a33ca8..449a548 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,7 @@ ^data-raw$ ^README\.Rmd$ ^LICENSE\.md$ +^\.github$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ 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/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..a3ac618 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,49 @@ +# 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] + +name: R-CMD-check + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v3 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true diff --git a/.gitignore b/.gitignore index 7c794aa..457525e 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .httr-oauth .DS_Store .quarto +docs diff --git a/README.Rmd b/README.Rmd index 22be54b..96b1336 100644 --- a/README.Rmd +++ b/README.Rmd @@ -26,6 +26,7 @@ library(universityrankingafrica) # basisghana +[![R-CMD-check](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml) This package compiles sanitation data from established Open Defecation Free (ODF) communities across different regions in Ghana. diff --git a/README.md b/README.md index 52ad10a..02a1ae9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ # basisghana + +[![R-CMD-check](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml) This package compiles sanitation data from established Open Defecation diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..69f3123 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,28 @@ +url: https://github.com/openwashdata/basisghana/blob/main/_pkgdown.yml + +template: + bootstrap: 5 + includes: + in_header: | + + +home: + links: + - icon: github + text: GitHub repository + href: https://github.com/openwashdata/basisghana + sidebar: + structure: [links, citation, authors, dev, custom] + components: + custom: + title: + text: + +authors: + footer: + roles: [cre, fnd] + text: "Crafted by" + sidebar: + roles: [cre, aut, ctb] + before: "So *who* does the work?" + after: "Thanks all!"