Claude/fix GitHub actions workflows and pkg documentation#96
Merged
Conversation
instead, use: - the basic string manipulation functions - kwb.utils::extractSubstring() - basename(), dirname() add helper function: - email_kwb() In the vignette, simply use ``` for text blocks that do not represent R code but console outputs
Try to avoid issue with stringi installation
The existing workflows used deprecated action versions (checkout@v2, cache@v1/v2, upload-artifact@main, r-lib/actions@master) and the ubuntu-20.04 runner that was retired in April 2025. They also depended on the archived r-hub/sysreqs package and contained a broken Linux sysdeps condition. Replace each workflow with the current r-lib/actions@v2 patterns, delegating dependency installation and caching to setup-r-dependencies, switching to ubuntu-latest, oldrel-1, and v4 checkout/upload-artifact, wiring pkgdown to deploy via the GitHub Pages action, and updating test-coverage to use codecov-action@v4 with cobertura output. Keep the inst/templates/ci_github-actions copies in sync so newly bootstrapped packages get the same workflows.
Mirror the Claude Code workflows used in kwb.raindrop into this repo and ship them as templates so consumers of kwb.pkgbuild can opt in. * Add .github/workflows/claude.yaml (responds to @claude mentions on issues and PR reviews) and claude-code-review.yaml (automatic PR review on opened/synchronize). * Ship the same files as templates under inst/templates/ci_github-actions-claude/ so they stay separate from the always-installed default workflows. * New exported use_ghactions_claude() copies just the Claude workflows into an existing package. * use_ghactions() and use_pkg() gain a claude = FALSE toggle that additionally installs the Claude workflows when TRUE. Both workflows expect a CLAUDE_CODE_OAUTH_TOKEN repo secret in GitHub. * Bump DESCRIPTION to 0.3.0 and document the workflow modernization plus the Claude Code addition in NEWS.md for the v0.3.0 release.
* Remove dead duplicate definitions of git(), construct_commit_message() and github_push() from R/deploy_site_github_with_extra_files.R. The duplicates were silently overwritten by later definitions in the same file but still produced misleading public Rd entries (man/github_push.Rd). * Fix incorrect @return texts (copy/paste errors) for use_index_md(), use_badge_ghactions_rcmdcheck() and use_badge_runiverse() so the man pages describe what each function actually returns. * Mark internal helpers use_installation(), read_description(), kwb_author() and kwb_package() with @nord; remove the corresponding Rd files. NAMESPACE exports and man/ are now perfectly in sync (38=38). * Rewrite the titles / descriptions for use_pkgdown(), use_readme_md() and use_index_md(); fix typos (releveant, directoy, aleady, DESCIPTION, KWB-R" missing quote, file patern) across roxygen blocks and Rd files. * Update vignettes/tutorial.Rmd: replace stale Travis / AppVeyor references with the modern GitHub Actions workflow set, document the new claude = TRUE switch on use_pkg(), and fix the kwb.pkgdown / kwb.pkddown typos. * Add new vignette vignettes/github-actions.Rmd that explains the default workflows, the optional Claude Code integration, the required CLAUDE_CODE_OAUTH_TOKEN secret and how to refresh workflows in existing packages. * Document all of the above in NEWS.md for the v0.3.0 release.
The KWB logo URL https://logos.kompetenz-wasser.io/KWB_Logo_M_Blau_RGB.svg was previously hardcoded inside the body of use_pkgdown(). Lift it to two new parameters kwb_logo_url and kwb_logo_href with that URL (and https://www.kompetenz-wasser.de) as defaults, so the default logo is explicit, discoverable in the man page, and can be overridden per package without copy-pasting the function. Also bumps the href default from http:// to https://.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change is