Merge pull request #21 from Appsilon/add-pkgdown-ci

Add pkgdown ci

.github/workflows/pkgdown.yaml

@@ -0,0 +1,39 @@
+# 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
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - 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 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: .
+          clean: false

DESCRIPTION

@@ -11,7 +11,7 @@ Authors@R:
     person(family = "Appsilon Sp. z o.o.", role = "cph")
   )
 Description: A framework that supports creating and extending enterprise Shiny applications using best practices.
-URL: https://github.com/Appsilon/rhino
+URL: https://appsilon.github.io/rhino, https://github.com/Appsilon/rhino
 BugReports: https://github.com/Appsilon/rhino/issues
 License: MIT + file LICENSE
 Encoding: UTF-8

README.md

@@ -29,3 +29,7 @@ Alternatively, the package can be installed, and then tested with `testthat::tes
 
 #### Linter
 Linter can be run using either `lintr::lint_package()` or `devtools::lint()`.
+
+#### `pkgdown` site
+To create a `pkgdown` site locally run either `pkgdown::build_site()` or `devtools::build_site()`.
+If built successfully, the website will be in `docs` directory.