Skip to content

Commit

Permalink
usethis::use_pkgdown_github_pages()
Browse files Browse the repository at this point in the history
  • Loading branch information
jmaspons committed Nov 18, 2024
1 parent 76a9c15 commit ed241f6
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
^\.lintr$
^\.pre-commit-config\.yaml$
^inst/WORDLIST$
^_pkgdown\.yml$
^docs$
^pkgdown$
49 changes: 49 additions & 0 deletions .github/workflows/pkgdown.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:
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

permissions: read-all

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/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.Rhistory
.RData
.Ruserdata
docs
11 changes: 5 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@ Type: Package
Package: icgc.osm
Title: Col·laboració ICGC & OSM
Version: 0.0.2
Authors@R: c(
Authors@R:
person("Joan", "Maspons", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-2286-8727"))
)
Maintainer: Joan Maspons <[email protected]>
Description: Eines i dades per les col·laboracions entre l'ICGC i OSM.
License: CC BY 4.0 | GPL (>= 3)
License_is_FOSS: yes
URL: https://github.com/OSM-Catalan/icgc.osm
URL: https://github.com/OSM-Catalan/icgc.osm, https://osm-catalan.github.io/icgc.osm/
BugReports: https://github.com/OSM-Catalan/icgc.osm/issues
Depends:
R (>= 3.5)
Expand All @@ -22,12 +19,14 @@ Suggests:
openxlsx,
sf,
testthat (>= 3.0.0)
Remotes: jmaspons/dbTools
Remotes:
jmaspons/dbTools
Config/testthat/edition: 3
Encoding: UTF-8
Language: ca
LazyData: true
LazyDataCompression: xz
License_is_FOSS: yes
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
X-schema.org-keywords: ICGC, Institut Cartogràfic i Geològic de Catalunya,
Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://osm-catalan.github.io/icgc.osm/
template:
bootstrap: 5

0 comments on commit ed241f6

Please sign in to comment.