KWB-R/kwb.pkgbuild: kwb.pkgbuild (v0.3.0): Helper functions for automating R package development at KWB to a predefined style
Authors/Creators
- 1. Kompetenzzentrum Wasser Berlin gGmbH
- 2. @anthropics
Description
kwb.pkgbuild 0.3.0 <small>2026-05-07</small>
Modernise GitHub Actions workflows (both in
.github/workflows/of this repo and the templates ininst/templates/ci_github-actions/) so that they run on current GitHub-hosted runners again:Bump action versions:
actions/checkout@v5,actions/upload-artifact@v4,codecov/codecov-action@v5,JamesIves/github-pages-deploy-action@v4.7.3, and replace the deprecatedr-lib/actions@masterreferences withr-lib/actions@v2. The@v5/@v4.7.3bumps run on Node.js 24 and avoid the GitHub deprecation warning for Node.js 20 actions (forced default June 2026, removed September 2026, see https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/).Switch from the retired
ubuntu-20.04runner toubuntu-latestand rename the matrix entryoldreltooldrel-1.Replace the archived
r-hub/sysreqsstep withr-lib/actions/setup-r-dependencies@v2, which also handles dependency caching out of the box.Fix a stale
if: runner.os == 'Linux (no, try without!)'condition that silently disabled the Linux system-dependency step.pkgdownworkflow: deploy viaJamesIves/github-pages-deploy-action@v4onubuntu-latest, with explicitpermissions: contents: writeand a concurrency group.test-coverageworkflow: produce a Cobertura report and upload via the newcodecov/codecov-action@v4; upload test artefacts on failure.pr-commandsworkflow: gate/documentand/stylejobs ongithub.event.issue.pull_requestso they no longer fire on plain issue comments.
Add optional Claude Code GitHub Actions workflows (analogue to kwb.raindrop):
New templates in
inst/templates/ci_github-actions-claude/:claude.yaml(responds to@claudementions in issues and PR reviews) andclaude-code-review.yaml(automatic PR review onopened/synchronize).New exported function
use_ghactions_claude()to add only the Claude workflows to an existing package.use_ghactions()anduse_pkg()gain aclaude = FALSEtoggle that additionally installs the Claude workflows when set toTRUE. The workflows expect aCLAUDE_CODE_OAUTH_TOKENrepository secret to be configured in GitHub.
Documentation cleanup:
Remove dead duplicate definitions of
git(),construct_commit_message()andgithub_push()inR/deploy_site_github_with_extra_files.R(they were silently overwritten by later definitions in the same file).Fix copy/paste errors in
@returnforuse_index_md(),use_badge_ghactions_rcmdcheck()anduse_badge_runiverse()(which referenced "travis" / "codecov" badges instead of the actual return value).Mark internal helpers (
use_installation(),read_description(),kwb_author(),kwb_package()) with@noRdso they no longer create public Rd entries.Rewrite the titles / descriptions for
use_pkgdown(),use_readme_md()anduse_index_md()so the man pages describe what the function actually does.Fix typos (
releveant,directoy,aleady,DESCIPTION,(default: KWB-R"),file patern) across roxygen blocks and Rd files.
use_pkgdown(): expose the KWB logo as parameterskwb_logo_url(default:https://logos.kompetenz-wasser.io/KWB_Logo_M_Blau_RGB.svg) andkwb_logo_href(default:https://www.kompetenz-wasser.de) so the default logo URL is no longer hardcoded inside the function body and can be overridden per package without forking the function.Vignettes:
New vignette
vignette("github-actions", package = "kwb.pkgbuild")describing the default workflows, the optional Claude Code integration, theCLAUDE_CODE_OAUTH_TOKENsecret, and how to refresh workflows in existing packages.Update
vignette("tutorial"): replace stale Travis / AppVeyor references with the GitHub Actions workflow set, document the newclaude = TRUEswitch inuse_pkg(), and fix thekwb.pkgdown/kwb.pkddowntypos.
Files
KWB-R/kwb.pkgbuild-v0.3.0.zip
Files
(498.7 kB)
| Name | Size | Download all |
|---|---|---|
|
md5:1220fe5dde97b216ca590ad666a9b432
|
498.7 kB | Preview Download |
Additional details
Related works
- Is supplement to
- Software: https://github.com/KWB-R/kwb.pkgbuild/tree/v0.3.0 (URL)
Software
- Repository URL
- https://github.com/KWB-R/kwb.pkgbuild