From 94c46b7370617e286fbd21a1744ddb3c22624f65 Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Mon, 13 Jul 2026 10:54:12 +0100 Subject: [PATCH 1/2] initial commit of skill --- .claude/skills/r-cran-release/SKILL.md | 377 +++++++++++++++++++++++++ 1 file changed, 377 insertions(+) create mode 100644 .claude/skills/r-cran-release/SKILL.md diff --git a/.claude/skills/r-cran-release/SKILL.md b/.claude/skills/r-cran-release/SKILL.md new file mode 100644 index 00000000000..3ac55ac962e --- /dev/null +++ b/.claude/skills/r-cran-release/SKILL.md @@ -0,0 +1,377 @@ +# R CRAN Release + +Guide the R package maintainer through the CRAN release process for the Apache Arrow R package. Only use this skill when explicitly doing a CRAN release. + +Use exactly this sequence of steps. Use a checklist as you go. Do not skip ahead, and ask the user to confirm step completion. + +## 1. Create GitHub Tracking Issue + +Ask the user for the release version number. + +```bash +gh issue create --repo apache/arrow \ + --title "[R] CRAN packaging checklist for version " \ + --body "$(cat r/PACKAGING.md | sed -n '/^- \[ \]/,$p')" +``` + +Track the issue number - update checkboxes as you complete each step. + +## 2. Create CRAN Release Branch + +Ask the user which RC number to use (e.g., rc1, rc2), then confirm before creating and pushing. + +```bash +git fetch upstream +git checkout apache-arrow--rc +git checkout -b maint--r +git push upstream maint--r +``` + +All subsequent steps should be done on this branch. + +## 3. Remove Badges from README + +In `r/README.md`, delete everything between `` and `` (inclusive): + +```bash +sed -i '//,//d' r/README.md +``` + +## 4. Review Deprecated Functions + +Find functions using `.Deprecated()` that may need to advance (deprecated -> defunct/removed): + +```bash +grep -rn "\.Deprecated" r/R/*.R +``` + +Review each match and decide if the deprecation should advance for this release (e.g., remove the function entirely or change to `.Defunct()`). + +## 5. Evaluate Nightly Build Status + +First, find the release candidate date: + +```bash +gh api repos/apache/arrow/releases --jq '.[] | select(.tag_name | contains("-rc")) | {tag_name, created_at}' +``` + +Then check R nightly builds were passing at that time: + +1. Go to https://github.com/ursacomputing/crossbow/actions +2. Click the "Logs" tab +3. Filter by the RC date +4. Filter by task status: failure +5. Look for any failing R jobs (jobs starting with `test-r-` or `r-`) + +All R jobs should have been passing at RC time. If any were failing, investigate whether they would cause CRAN rejection. + +For failed job logs, search: https://github.com/ursacomputing/crossbow/branches/all?query= + +## 6. Check Current CRAN Check Results + +Fetch https://cran.r-project.org/web/checks/check_results_arrow.html and extract the check results table showing platform, version, and status. Also check for any "Additional issues" section. + +All platforms should show OK or NOTE status. NOTEs about package size (e.g., "installed size is 130+ Mb") are expected due to bundled Arrow C++ and can be ignored. Other NOTEs or any ERROR/WARN should be investigated. + +## 7. Ensure README is Accurate + +Read `r/README.md` and verify: +- Installation instructions are current +- Feature descriptions match current functionality +- Version-specific notes (e.g., C++ version requirements) are correct +- No outdated information + +Report any issues found. + +## 8. Run URL Checker + +Confirm on the `maint--r` branch: + +```bash +git branch --show-current +``` + +Then run: + +```bash +cd r && Rscript -e 'urlchecker::url_check()' +``` + +All URLs should pass (badges were already removed). Fix any broken links. + +## 9. Polish NEWS + +Review `r/NEWS.md` and polish following tidyverse style: + +- Use present tense ("X now does Y", not "X did Y") +- Name contributors with `@username` if they're not a listed package author +- Use categories: "New features", "Minor improvements and fixes", "Installation" (if relevant) +- Keep entries concise - match the style of previous releases +- Only include user-facing changes - no CI updates or internal refactoring + +Find the previous version from NEWS.md: + +```bash +grep "^# arrow" r/NEWS.md | head -5 +``` + +Then find R commits since that version: + +```bash +git log --oneline apache-arrow-..HEAD | grep "\[R\]" +``` + +Do NOT update version numbers - this is done automatically later. + +Open a GitHub issue for the NEWS updates, submit a PR to main, then cherry-pick into the `maint--r` branch later. + +## 10. Cherry-pick Necessary Changes + +Check if there are any fixes that need to be cherry-picked into the `maint--r` branch: + +1. Check the comments on the release tracking issue for any noted cherry-picks +2. Ask if there are any other fixes merged to main after the RC + +Common reasons to cherry-pick: +- Fixes for CRAN check failures identified in earlier steps +- NEWS updates (from step 9) +- Critical bug fixes + +For each PR noted, get the merge commit SHA: + +```bash +gh pr view --repo apache/arrow --json mergeCommit,title --jq '{sha: .mergeCommit.oid, title: .title}' +``` + +Present the list of commits and ask for confirmation before cherry-picking. + +For each confirmed commit: + +```bash +git cherry-pick +``` + +Ask before pushing: + +```bash +git push upstream maint--r +``` + +## 11. Create Crossbow Verification PR + +Create a PR to run all R crossbow jobs against the CRAN release branch: + +```bash +gh pr create --repo apache/arrow \ + --base maint- \ + --head maint--r \ + --title "WIP: [R] Verify CRAN release " \ + --body "Do not merge: Running R crossbow jobs against the CRAN release branch." \ + --draft +``` + +Then add a comment to trigger crossbow: + +```bash +gh pr comment --repo apache/arrow --body "@github-actions crossbow submit --group r" +``` + +Add a link to this PR in the tracking issue so progress can be monitored. + +Before proceeding to CRAN submission, verify all crossbow jobs pass. + +## 12. Build and Check Package Locally + +Ensure on the `maint--r` branch with a clean working directory: + +```bash +git fetch upstream +git checkout maint--r +git clean -f -d +``` + +Check if `ARROW_HOME` is set: + +```bash +echo "ARROW_HOME=${ARROW_HOME:-}" +``` + +If set, unset it so the build uses the vendored C++ version: + +```bash +unset ARROW_HOME +``` + +Run the build (this takes a while): + +```bash +cd r && make build +``` + +After the build, check for any generated doc changes that need to be committed: + +```bash +git status +``` + +If there are modified `.Rd` files or other doc changes, commit them: + +```bash +git add r/man/ r/inst/NOTICE.txt +git commit -m "[R] Update generated documentation" +``` + +Ask before pushing. + +Then run the check: + +```r +devtools::check_built("arrow_.tar.gz") +``` + +Fix any issues before proceeding. + +## 13. Wait for Release Vote + +Check if the Apache Arrow release vote has passed before continuing. + +## 14. Update Checksums + +Download checksums for pre-compiled binaries from ASF artifactory. Ask for the libarrow version (usually matches the release version): + +```bash +cd r && Rscript tools/update-checksums.R +``` + +Then commit the checksums: + +```bash +git add -f tools/checksums/ +git commit -m "[CRAN] Add checksums" +``` + +Ask before pushing. + +## 15. Rebuild Package + +Rebuild the tarball with checksums added: + +```bash +cd r && make build +``` + +Check for any new doc changes after rebuild: + +```bash +git status +``` + +Commit any changes and ask before pushing. + +## 16. Check Binary Distributions + +Test that the package works with pre-compiled Arrow C++ binaries on different platforms. + +### Windows (win-builder) + +Upload `r/arrow_.tar.gz` to https://win-builder.r-project.org/upload.aspx (r-devel only). + +Results are emailed to Jon (the package maintainer). Ping Jon and wait for confirmation that the check is clean - no ERRORs, WARNINGs, or unexpected NOTEs. NOTEs about package size are expected. + +### macOS Builder + +Upload `r/arrow_.tar.gz` to https://mac.r-project.org/macbuilder/submit.html + +Check the results link for any issues. + +### Ubuntu Binary Installation + +Test on Ubuntu that hosted binaries are used: + +```r +install.packages("r/arrow_.tar.gz", repos = NULL) +``` + +The installation should download pre-compiled binaries rather than building from source. + +### Final Local Check + +Run one final local check: + +```r +devtools::check_built("r/arrow_.tar.gz") +``` + +## 17. Submit to CRAN + +Upload `r/arrow_.tar.gz` to https://xmpalantir.wu.ac.at/cransubmit/ + +Ping Jon to confirm the submission email when it arrives. + +## 18. Tag for r-universe + +After CRAN accepts the package: + +```bash +git tag -f r-universe-release maint--r +git push upstream r-universe-release --force +``` + +## 19. Update Backwards Compatibility Matrix + +Add a new line to `dev/tasks/r/github.linux.arrow.version.back.compat.yml` with the new version. + +Create a PR to main for this change. + +## 20. Wait for CRAN Binaries + +Monitor https://cran.r-project.org/package=arrow until CRAN-hosted binaries reflect the new version. + +## 21. Prepare Social Media Content (Major Releases) + +For major releases, prepare content for social media highlighting new features. + +Format (thread of toots): +1. Opening: "We're excited to announce the release of {arrow} . Here's a roundup of the new features and changes. Full details can be found at https://arrow.apache.org/docs/r/news/ #rstats" +2. Feature highlights: One toot per major user-facing feature, with code screenshots from https://carbon.now.sh/ where appropriate. Skip minor fixes and CI/internal changes. +3. Contributor stats: Total contributors, C++ only, R only, both, first-timers. + +To generate contributor stats, run from the arrow repo root: + +```r +source("r/tools/contributor_stats.R") +release_contributor_stats("apache-arrow-", "apache-arrow-") +``` + +## 22. Patch Releases Only: Update Version Numbers + +For patch releases (e.g., X.Y.1), update the version in: +- `ci/scripts/PKGBUILD` +- `r/DESCRIPTION` +- `r/NEWS.md` + +## 23. CRAN-Only Releases: Update Documentation + +For CRAN-only releases (no corresponding Arrow release): + +Rebuild news page: + +```r +pkgdown::build_news() +``` + +Submit a PR to the `asf-site` branch of https://github.com/apache/arrow-site with contents of `arrow/r/docs/news/index.html` replacing `arrow-site/docs/r/news/index.html`. + +Bump the version in `r/pkgdown/assets/versions.json` and update on the `asf-site` branch too. + +## 24. Check C++ Updates + +Review C++ changes in this release and create GitHub issues for any items that need R bindings: + +```bash +git log --oneline apache-arrow-..apache-arrow- -- cpp/ | head -50 +``` + +## 25. Review Checklist + +Review this packaging checklist and update as needed based on any issues encountered during this release. From 50cc8116e5daf6168b696d28cb78d98e5f084d6d Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Mon, 13 Jul 2026 12:07:12 +0100 Subject: [PATCH 2/2] Update release skill Co-Authored-By: Claude Opus 4.6 (1M context) --- .claude/skills/r-cran-release/SKILL.md | 30 ++++++++------------------ dev/release/rat_exclude_files.txt | 1 + r/PACKAGING.md | 6 ------ 3 files changed, 10 insertions(+), 27 deletions(-) diff --git a/.claude/skills/r-cran-release/SKILL.md b/.claude/skills/r-cran-release/SKILL.md index 3ac55ac962e..7c79569506a 100644 --- a/.claude/skills/r-cran-release/SKILL.md +++ b/.claude/skills/r-cran-release/SKILL.md @@ -2,7 +2,9 @@ Guide the R package maintainer through the CRAN release process for the Apache Arrow R package. Only use this skill when explicitly doing a CRAN release. -Use exactly this sequence of steps. Use a checklist as you go. Do not skip ahead, and ask the user to confirm step completion. +Use exactly this sequence of steps. Print a checklist of all steps at the start, and update it as you go. Do not skip ahead. After completing each step, ask the user to confirm before moving on. Once confirmed, update the corresponding checkbox on the tracking issue. Use exactly the commands and approaches specified in each step — do not improvise or substitute alternatives without checking with the user. + +If any earlier step reveals something that needs to be cherry-picked into the release branch, note it as a comment on the tracking issue. When you reach the cherry-pick step later, check the tracking issue comments for anything noted earlier. ## 1. Create GitHub Tracking Issue @@ -37,6 +39,8 @@ In `r/README.md`, delete everything between `` and `/,//d' r/README.md ``` +Commit this change to the `maint--r` branch. + ## 4. Review Deprecated Functions Find functions using `.Deprecated()` that may need to advance (deprecated -> defunct/removed): @@ -49,23 +53,7 @@ Review each match and decide if the deprecation should advance for this release ## 5. Evaluate Nightly Build Status -First, find the release candidate date: - -```bash -gh api repos/apache/arrow/releases --jq '.[] | select(.tag_name | contains("-rc")) | {tag_name, created_at}' -``` - -Then check R nightly builds were passing at that time: - -1. Go to https://github.com/ursacomputing/crossbow/actions -2. Click the "Logs" tab -3. Filter by the RC date -4. Filter by task status: failure -5. Look for any failing R jobs (jobs starting with `test-r-` or `r-`) - -All R jobs should have been passing at RC time. If any were failing, investigate whether they would cause CRAN rejection. - -For failed job logs, search: https://github.com/ursacomputing/crossbow/branches/all?query= +Ask the user to check that R nightly builds were passing around RC time. They can check on Zulip or at https://crossbow.arrow-dev.org/ ## 6. Check Current CRAN Check Results @@ -101,10 +89,10 @@ All URLs should pass (badges were already removed). Fix any broken links. ## 9. Polish NEWS -Review `r/NEWS.md` and polish following tidyverse style: +Review `r/NEWS.md` and polish following tidyverse style (see https://style.tidyverse.org/news.html): - Use present tense ("X now does Y", not "X did Y") -- Name contributors with `@username` if they're not a listed package author +- Name contributors with `@username` if they're not a listed package author. Listed authors (do not credit): @nealrichardson, @ianmcook, @thisisnic, @paleolimbot, @romainfrancois, @jkeane, @brycemecum, @dragosmg, @jeroenooms, @assignUser - Use categories: "New features", "Minor improvements and fixes", "Installation" (if relevant) - Keep entries concise - match the style of previous releases - Only include user-facing changes - no CI updates or internal refactoring @@ -123,7 +111,7 @@ git log --oneline apache-arrow-..HEAD | grep "\[R\]" Do NOT update version numbers - this is done automatically later. -Open a GitHub issue for the NEWS updates, submit a PR to main, then cherry-pick into the `maint--r` branch later. +Open a GitHub issue for the NEWS updates, submit a PR to main from a branch on the fork (origin, not upstream), then cherry-pick into the `maint--r` branch later. ## 10. Cherry-pick Necessary Changes diff --git a/dev/release/rat_exclude_files.txt b/dev/release/rat_exclude_files.txt index 7b3f9eebe58..db74b8066b8 100644 --- a/dev/release/rat_exclude_files.txt +++ b/dev/release/rat_exclude_files.txt @@ -103,3 +103,4 @@ ruby/red-arrow/.yardopts ruby/red-arrow-format/lib/arrow-format/org/* .github/copilot-instructions.md .github/pull_request_template.md +.claude/* diff --git a/r/PACKAGING.md b/r/PACKAGING.md index 80da1561919..67bb3274775 100644 --- a/r/PACKAGING.md +++ b/r/PACKAGING.md @@ -40,12 +40,6 @@ _Wait for the release candidate to be created._ - [ ] Create a CRAN-release branch from the release candidate commit, name the new branch `maint-X.Y.Z-r` and push to upstream. -## Prepare and Check Package That Will Be Released to CRAN - -- [ ] `git fetch upstream && git checkout maint-X.Y.Z-r && git clean -f -d`. -- [ ] Run `make build`. This copies Arrow C++ into tools/cpp, prunes some unnecessary components, and runs `R CMD build` to generate the source tarball. Because this will install the package, you will need to ensure that the version of Arrow C++ available to the configure script is the same as the version that is vendored into the R package (e.g., you may need to unset `ARROW_HOME`). -- [ ] `devtools::check_built("arrow_X.Y.Z.tar.gz")` locally. - ## Wait for Arrow Release Vote - [ ] Release vote passed