From 8e888e03b47d25bd266c4a917a7fd73d90702b49 Mon Sep 17 00:00:00 2001 From: PietrH Date: Tue, 7 Apr 2026 16:20:55 +0200 Subject: [PATCH 1/3] usethis::use_pkgdown() --- .Rbuildignore | 3 +++ .gitignore | 1 + _pkgdown.yml | 4 ++++ 3 files changed, 8 insertions(+) create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 0aa94f51..788279f3 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -5,3 +5,6 @@ [.]js$ ^\.github$ ^CITATION\.cff$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index aad9f9d8..91d4b4da 100644 --- a/.gitignore +++ b/.gitignore @@ -51,3 +51,4 @@ rsconnect/ # Postman collection exports tests/postman/*.json +docs diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 00000000..d71acfb9 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: ~ +template: + bootstrap: 5 + From 0c039f315e91a4f3ca47f7695a01ebae31fb39a3 Mon Sep 17 00:00:00 2001 From: PietrH Date: Tue, 7 Apr 2026 16:23:01 +0200 Subject: [PATCH 2/3] usethis::use_github_action("pkgdown") --- .github/workflows/pkgdown.yaml | 49 ++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/pkgdown.yaml diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 00000000..bfc9f4db --- /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 From 1cbe0b61e61d1557e6b64c7f5d8f7a8c7eb50053 Mon Sep 17 00:00:00 2001 From: PietrH Date: Tue, 7 Apr 2026 16:25:54 +0200 Subject: [PATCH 3/3] Mention new pkgdown website in NEWS --- NEWS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/NEWS.md b/NEWS.md index 9ba62dda..44f7e2ff 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,5 @@ # etnservice (development version) +- etnservice now has a pkgdown website: [inbo.github.io/etnservice/](https://inbo.github.io/etnservice/). # etnservice 0.6.0 - Added `get_receiver_logs()` to fetch receiver logs from the database. The data is returned as a tibble with a column with logs in JSON format. (#117)