Skip to content

Commit

Permalink
set up pkgdown config
Browse files Browse the repository at this point in the history
  • Loading branch information
sskorik01 committed Dec 14, 2023
1 parent 4702208 commit 4d00957
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
^data-raw$
^README\.Rmd$
^LICENSE\.md$
^\.github$
^_pkgdown\.yml$
^docs$
^pkgdown$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
49 changes: 49 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
.httr-oauth
.DS_Store
.quarto
docs
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ library(universityrankingafrica)
# basisghana

<!-- badges: start -->
[![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)
<!-- badges: end -->

This package compiles sanitation data from established Open Defecation Free (ODF) communities across different regions in Ghana.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
# basisghana

<!-- badges: start -->

[![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)
<!-- badges: end -->

This package compiles sanitation data from established Open Defecation
Expand Down
28 changes: 28 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
url: https://github.com/openwashdata/basisghana/blob/main/_pkgdown.yml

template:
bootstrap: 5
includes:
in_header: |
<script defer data-domain="openwashdata.github.io/" src="https://plausible.io/js/script.js"></script>
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!"

0 comments on commit 4d00957

Please sign in to comment.