From ed241f6174e295a8e313858389fa6b85736f3bc8 Mon Sep 17 00:00:00 2001
From: Joan Maspons <joanmaspons@gmail.com>
Date: Mon, 18 Nov 2024 17:39:20 +0100
Subject: [PATCH] usethis::use_pkgdown_github_pages()

---
 .Rbuildignore                  |  3 +++
 .github/workflows/pkgdown.yaml | 49 ++++++++++++++++++++++++++++++++++
 .gitignore                     |  1 +
 DESCRIPTION                    | 11 ++++----
 _pkgdown.yml                   |  4 +++
 5 files changed, 62 insertions(+), 6 deletions(-)
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml

diff --git a/.Rbuildignore b/.Rbuildignore
index 9840126..e1e3aaf 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -6,3 +6,6 @@
 ^\.lintr$
 ^\.pre-commit-config\.yaml$
 ^inst/WORDLIST$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..bfc9f4d
--- /dev/null
+++ b/.github/workflows/pkgdown.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:
+  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/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
index 5b6a065..234f028 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
index 90076d9..86f6547 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -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", , "joanmaspons@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2286-8727"))
-  )
-Maintainer: Joan Maspons <joanmaspons@gmail.com>
 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)
@@ -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,
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..ad0a512
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: https://osm-catalan.github.io/icgc.osm/
+template:
+  bootstrap: 5
+