For a high-level overview of the release process see the Apache Arrow Release Management Guide.
- Create a GitHub issue entitled
[R] CRAN packaging checklist for version X.X.X
and copy this checklist to the issue. - Review deprecated functions to advance their deprecation status, including removing preprocessor directives that no longer apply (search for
ARROW_VERSION_MAJOR
in r/src). - Evaluate the status of any failing nightly tests and nightly packaging builds. These checks replicate most of the checks that CRAN runs, so we need them all to be passing or to understand that the failures may (though won't necessarily) result in a rejection from CRAN.
- Check current CRAN check results
- Ensure the contents of the README are accurate and up to date.
- Run
urlchecker::url_check()
on the R directory at the release candidate. commit. Ignore any errors with badges as they will be removed in the CRAN release branch. - Polish NEWS but do not update version numbers (this is done automatically later). You can find commits by, for example,
git log --oneline aa057d0..HEAD | grep "\[R\]"
- Run preliminary reverse dependency checks using
archery docker run r-revdepcheck
. - For major releases, prepare tweet thread highlighting new features.
Wait for the release candidate to be cut:
- Create a CRAN-release branch from the release candidate commit, name the new branch e.g.
maint-X.X.X-r
and push to upstream
-
git fetch upstream && git checkout release-X.X.X-rcXX && git clean -f -d
- Run
make build
. This copies Arrow C++ into tools/cpp, prunes some unnecessary components, and runsR 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 unsetARROW_HOME
). -
devtools::check_built("arrow_X.X.X.tar.gz")
locally - Run reverse dependency checks using
archery docker run r-revdepcheck
.
- Release vote passed!
- If the release candidate commit updated, rebase the CRAN release branch on that commit.
- Pick any commits that were made to main since the release commit that were needed to fix CRAN-related submission issues identified in the above steps.
- Remove badges from README.md
- Run
urlchecker::url_check()
on the R directory - Create a PR entitled
WIP: [R] Verify CRAN release-10.0.1-rc0
. Add a comment@github-actions crossbow submit --group r
to run all R crossbow jobs against the CRAN-specific release branch. - Run
Rscript tools/update-checksums.R <libarrow version>
to download the checksums for the pre-compiled binaries from the ASF artifactory into the tools directory. - Regenerate arrow_X.X.X.tar.gz (i.e.,
make build
)
Ensure linux binary packages are available:
- Ensure linux binaries are available in the artifactory: https://apache.jfrog.io/ui/repos/tree/General/arrow/r
- Upload the .tar.gz to win-builder (r-devel only) and confirm (with Nic, who will automatically receive an email about the results) that the check is clean. This step cannot be completed before Jeroen has put the binaries in the MinGW repository, i.e. here, here, and here.
- Upload the .tar.gz to MacBuilder and confirm that the check is clean
- Check
install.packages("arrow_X.X.X.tar.gz")
on Ubuntu and ensure that the hosted binaries are used -
devtools::check_built("arrow_X.X.X.tar.gz")
locally one more time (for luck)
- Upload arrow_X.X.X.tar.gz to the CRAN submit page
- Confirm the submission email
Wait for CRAN...
- Accepted!
- Tag the tip of the CRAN-specific release branch with
r-universe-release
- Add a new line to the matrix in the backwards compatability job
- (patch releases only) Update the package version in
ci/scripts/PKGBUILD
,dev/tasks/homebrew-formulae/autobrew/apache-arrow.rb
,r/DESCRIPTION
, andr/NEWS.md
- (CRAN-only releases) Rebuild news page with
pkgdown::build_news()
and submit a PR to the asf-site branch of the docs site with the contents ofarrow/r/docs/news/index.html
replacing the current contents ofarrow-site/docs/r/news/index.html
- (CRAN-only releases) Bump the version number in
r/pkgdown/assets/versions.json
, and update this on the theasf-site
branch of the docs site too. - Update the packaging checklist template to reflect any new realities of the packaging process.
- Wait for CRAN-hosted binaries on the CRAN package page to reflect the new version
- Tweet!