Modernise GitHub Actions workflows (both in .github/workflows/ of this
repo and the templates in inst/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/[email protected],
and replace the deprecated r-lib/actions@master references with
r-lib/actions@v2. The @v5 / @v4.7.3 bumps 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.04 runner to ubuntu-latest and
rename the matrix entry oldrel to oldrel-1.
Replace the archived r-hub/sysreqs step with
r-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.
pkgdown workflow: deploy via JamesIves/github-pages-deploy-action@v4
on ubuntu-latest, with explicit permissions: contents: write and a
concurrency group.
test-coverage workflow: produce a Cobertura report and upload via the
new codecov/codecov-action@v4; upload test artefacts on failure.
pr-commands workflow: gate /document and /style jobs on
github.event.issue.pull_request so 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 @claude mentions in issues and PR reviews)
and claude-code-review.yaml (automatic PR review on opened /
synchronize).
New exported function use_ghactions_claude() to add only the Claude
workflows to an existing package.
use_ghactions() and use_pkg() gain a claude = FALSE toggle that
additionally installs the Claude workflows when set to TRUE. The
workflows expect a CLAUDE_CODE_OAUTH_TOKEN repository secret to be
configured in GitHub.
Documentation cleanup:
Remove dead duplicate definitions of git(), construct_commit_message()
and github_push() in R/deploy_site_github_with_extra_files.R (they
were silently overwritten by later definitions in the same file).
Fix copy/paste errors in @return for use_index_md(),
use_badge_ghactions_rcmdcheck() and use_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 @noRd so they no longer create
public Rd entries.
Rewrite the titles / descriptions for use_pkgdown(), use_readme_md()
and use_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 parameters kwb_logo_url
(default: https://logos.kompetenz-wasser.io/KWB_Logo_M_Blau_RGB.svg)
and kwb_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,
the CLAUDE_CODE_OAUTH_TOKEN secret, and how to refresh workflows in
existing packages.
Update vignette("tutorial"): replace stale Travis / AppVeyor
references with the GitHub Actions workflow set, document the new
claude = TRUE switch in use_pkg(), and fix the kwb.pkgdown /
kwb.pkddown typos.
Fix GitHub action worfklows:
fix continuous integration workflows (i.e. pkgdown, Rcmdcheck,
test-coverage)), which were broken after 2022-10-15 due to unavailable master
branch in upstream dependency r-lib/actions.
fix pkgdown GitHub actions workflow, which
crashed during build_news() generation on windows due to an recent change in Windows that has made it incompatible with old openssl servers (thanks to @jeroen for that hint!) and @garborcsardi
for this workaround!). For full discussion on this issue (which might be
fixed in an upcoming pkgdown version 2.0.7)
see pkgdown#2211
windows as default operating system for pkgdown (for
building documentation website) and test coverage workflow instead of macosx_pkgdown.ymlDocumentation website with pkgdown (>= 2.0.2) and new KWB website:
Design: now using bootstrap5 and colors slightly adapted to KWB design.
URL to KWB logo was updated due to new website.
Attention: URLs to projects (including logos) need to be corrected manually (for old _pkgdown.yml files
Deleted functions for unused CIs travis and appveyor
Rcmdcheck workflow on GitHub Actions by explicitly adding default organisation GITHUB_PATuse_badge_runiverse() (for linking to https://kwb-r.r-universe.dev)
if package is available and use for index.md and README.mdkwb.pkgstatus)Add function deploy_to_branch_with_extra_files() for using github-actions to
deploy to gh-pages (#73)
Use GitHub Actions as default CI (#78) and removed support for Travis and Appveyor
Update default GitHub branch to main since 2020-10-01 (see: Article)
add_creation_metadata: write creation metadata in yaml format as default
travis.yml template: add dependencies required for pkgdown (>= 1.6.1) installation
Update Travis-CI badges after migrating KWB-R build from travis-ci.org to .com (#72)
Improved use in case of an existing R package (by reading information from
DESCRIPTION file with function kwb.pkgbuild::read_description)
Improved documentation generation (closes #6)
Changed README.Rmd to index.Rmd (used by pkgdown::build_home) and added
"Installation" chapter
Added "Installation" chapter in README.md for Github repo site
Automatically convert package title to Title Case with tools::toTitleCase()
Added a NEWS.md file to track changes to the package.
See http://style.tidyverse.org/news.html for writing a good NEWS.md