thisisnic commented on code in PR #14678: URL: https://github.com/apache/arrow/pull/14678#discussion_r1037439615
########## r/PACKAGING.md: ########## @@ -0,0 +1,134 @@ + +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Packaging checklist for CRAN release + +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. +- [ ] 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 + 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). +- [ ] For major releases, prepare tweet thread highlighting new features + +Wait for the release candidate to be cut: + +- [ ] Release candidate! +- [ ] Create a CRAN-release branch from the release candidate commit + +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 +use the release candidate as the source. + +- [ ] Pull request to modify + [the apache-arrow autobrew formula]( https://github.com/autobrew/homebrew-core/blob/high-sierra/Formula/apache-arrow.rb) + to update the release version, SHA256 checksum of the release source file (which can be found in the same directory as the release source file), and any changes to dependencies and build steps that have changed in the + [copy of the formula we have of that formula in the Arrow repo](https://github.com/apache/arrow/blob/master/dev/tasks/homebrew-formulae/autobrew/apache-arrow.rb) +- [ ] Pull request to modify + [the apache-arrow-static autobrew formula]( https://github.com/autobrew/homebrew-core/blob/master/Formula/apache-arrow-static.rb) + to update the version, SHA, and any changes to dependencies and build steps that have changed in the + [copy of the formula we have of that formula in the Arrow repo](https://github.com/apache/arrow/blob/master/dev/tasks/homebrew-formulae/autobrew/apache-arrow-static.rb) +- [ ] Pull request to modify the + [autobrew script](https://github.com/autobrew/scripts/blob/master/apache-arrow) + to include any additions made to + [r/tools/autobrew](https://github.com/apache/arrow/blob/master/r/tools/autobrew). +- [ ] Pull request to modify the + [RTools PKGBUILD script](https://github.com/r-windows/rtools-packages/blob/master/mingw-w64-arrow/PKGBUILD) + to reflect changes in + [ci/PKGBUILD](https://github.com/apache/arrow/blob/master/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. + +- [ ] `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 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.X.X.tar.gz")` locally +- [ ] Run reverse dependency checks. Currently this is a + [manual process](https://gist.github.com/paleolimbot/630fdab1e204d70fea97633d8fa15ccb); + however, in the future it may be a crossbow nightly job. + +Wait for the official release... + +- [ ] Release vote passed! +- [ ] If the release candidate commit updated, rebase the CRAN release branch + on that commit. +- [ ] Pick any commits that were made to master 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. +- [ ] 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 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: + +- [ ] Upload the .tar.gz to [win-builder](https://win-builder.r-project.org/upload.aspx) + and confirm (with Neal, who will automatically receive an email about the results) that the check is clean Review Comment: ```suggestion - [ ] Upload the .tar.gz to [win-builder](https://win-builder.r-project.org/upload.aspx) (r-devel only) and confirm (with Neal, who will automatically receive an email about the results) that the check is clean ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
