This is an automated email from the ASF dual-hosted git repository.
thisisnic pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 5bb21117e4 MINOR: [R] Update docs on release process (#35429)
5bb21117e4 is described below
commit 5bb21117e4a06ab36f283eeb36f0ca1dc68eb6ea
Author: Nic Crane <[email protected]>
AuthorDate: Wed May 10 10:12:37 2023 +0200
MINOR: [R] Update docs on release process (#35429)
I've rearranged a few sections, added some extra headers, and moved the
autobrew/rtools steps up further as it makes sense to do these ASAP once the
release has been confimed.
Authored-by: Nic Crane <[email protected]>
Signed-off-by: Nic Crane <[email protected]>
---
r/PACKAGING.md | 55 +++++++++++++++++++++++++++----------------------------
1 file changed, 27 insertions(+), 28 deletions(-)
diff --git a/r/PACKAGING.md b/r/PACKAGING.md
index 2de82e60ae..6cfa903650 100644
--- a/r/PACKAGING.md
+++ b/r/PACKAGING.md
@@ -23,28 +23,25 @@
For a high-level overview of the release process see the
[Apache Arrow Release Management
Guide](https://arrow.apache.org/docs/developers/release.html#post-release-tasks).
-Before the release candidate is cut:
-
-- [ ] [Create a GitHub issue](https://github.com/apache/arrow/issues/new/)
- entitled `[R] CRAN packaging checklist for version X.X.X`
- and copy this checklist to the issue.
-- [ ] Evaluate the status of any failing
- [nightly tests and nightly packaging
builds](http://crossbow.voltrondata.com). 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.
+## Before the release candidate is cut
+
+- [ ] [Create a GitHub issue](https://github.com/apache/arrow/issues/new/)
entitled `[R] CRAN packaging checklist for version X.X.X` and copy this
checklist to the issue.
+- [ ] Evaluate the status of any failing [nightly tests and nightly packaging
builds](http://crossbow.voltrondata.com). 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](https://cran.rstudio.org/web/checks/check_results_arrow.html)
-- [ ] Ensure the contents of the README are accurate and up to date
-- [ ] Run `urlchecker::url_check()` on the R directory at the release candidate
+- [ ] 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](https://style.tidyverse.org/news.html#news-release) but do
**not** update version numbers (this is done automatically later).
- [ ] Run preliminary reverse dependency checks using `archery docker run
r-revdepcheck`.
-- [ ] For major releases, prepare tweet thread highlighting new features
+- [ ] For major releases, prepare tweet thread highlighting new features.
Wait for the release candidate to be cut:
-- [ ] Release candidate!
+## After release candidate has been cut
- [ ] Create a CRAN-release branch from the release candidate commit
+## Optional: PRs for autobrew and rtools (release candidate)
+
Make pull requests into the [autobrew](https://github.com/autobrew) and
[rtools-packages](https://github.com/r-windows/rtools-packages) repositories
used by the configure script on MacOS and Windows. These pull requests will
@@ -68,7 +65,7 @@ use the release candidate as the source.
[ci/PKGBUILD](https://github.com/apache/arrow/blob/main/ci/scripts/PKGBUILD),
uncommenting the line that says "uncomment to test the rc".
-Prepare and check the .tar.gz that will be released to CRAN.
+## Prepare and check the .tar.gz that will be released to CRAN.
- [ ] `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
@@ -79,9 +76,20 @@ Prepare and check the .tar.gz that will be released to CRAN.
- [ ] `devtools::check_built("arrow_X.X.X.tar.gz")` locally
- [ ] Run reverse dependency checks using `archery docker run r-revdepcheck`.
-Wait for the official release...
-
+## Release vote
- [ ] Release vote passed!
+
+## PRs for autobrew and rtools (official release)
+
+Create new autobrew and r-windows PRs such that they use the *release*
+instead of the *release candidate*:
+
+- [ ] PR into autobrew/homebrew-core (apache-arrow autobrew formula)
+- [ ] PR into autobrew/homebrew-core (apache-arrow-static autobrew formula)
+- [ ] PR into autobrew/scripts
+- [ ] PR into r-windows/rtools-packages
+
+## Generate R package to submit to CRAN
- [ ] 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
@@ -94,18 +102,11 @@ Wait for the official release...
jobs against the CRAN-specific release branch.
- [ ] Regenerate arrow_X.X.X.tar.gz (i.e., `make build`)
-Create new autobrew and r-windows PRs such that they use the *release*
-instead of the *release candidate*; ensure linux binary packages are available:
-
-- [ ] PR into autobrew/homebrew-core (apache-arrow autobrew formula)
-- [ ] PR into autobrew/homebrew-core (apache-arrow-static autobrew formula)
-- [ ] PR into autobrew/scripts
-- [ ] PR into r-windows/rtools-packages
+Ensure linux binary packages are available:
- [ ] Ensure linux binaries are available in the artifactory:
https://apache.jfrog.io/ui/repos/tree/General/arrow/r
-Check binary Arrow C++ distributions specific to the R package:
-
+## Check binary Arrow C++ distributions specific to the R package
- [ ] Upload the .tar.gz to
[win-builder](https://win-builder.r-project.org/upload.aspx) (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](https://ftp.opencpu.org/rtools/ucrt64/),
[here](https://ftp.opencpu.org/rtools/mingw64/), and
[here](https://ftp.opencpu.org/rtools/mingw32/).
@@ -115,14 +116,12 @@ Check binary Arrow C++ distributions specific to the R
package:
hosted binaries are used
- [ ] `devtools::check_built("arrow_X.X.X.tar.gz")` locally one more time (for
luck)
-Submit!
-
+## CRAN submission
- [ ] Upload arrow_X.X.X.tar.gz to the
[CRAN submit page](https://xmpalantir.wu.ac.at/cransubmit/)
- [ ] Confirm the submission email
Wait for CRAN...
-
- [ ] Accepted!
- [ ] Tag the tip of the CRAN-specific release branch
- [ ] Add a new line to the matrix in the [backwards compatability
job](https://github.com/apache/arrow/blob/main/dev/tasks/r/github.linux.arrow.version.back.compat.yml)
