GH-49380: [R] Remove hidden CI test chunks from setup.Rmd to fix r-de…#49381
GH-49380: [R] Remove hidden CI test chunks from setup.Rmd to fix r-de…#49381vanshaj2023 wants to merge 1 commit intoapache:mainfrom
Conversation
jonkeane
left a comment
There was a problem hiding this comment.
Thanks for the PR, but these changes aren't what we want to do here (they actually remove one of the parts of the devdocs test we want to test. And I am nearly certain they wouldn't do what we expect them to do in the release-branch circumstance anyway.
r/vignettes/developers/setup.Rmd
Outdated
| ``` | ||
|
|
||
| ```{bash, save=run & !sys_install & macos} | ||
| ```bash |
There was a problem hiding this comment.
We don't want to remove these chunks here (or the , save=run & !sys_install & macos) — if you look at the text above these two blocks are intending to set up the circumstance where we "need to make sure that you don't let R link to your system
library when building arrow".
|
Thanks for the review and clarification! |
I honestly don't — the last time I investigated the things that the devdocs did avoided linking to the system arrow, but if that has stopped we would need to figure out what a better way is to ensure that system error is not linked to... |
… fix r-devdocs ABI mismatch
bac2f71 to
fc0e6f9
Compare
|
Also, FWIW, you might have better luck if you branch from a release branch temporarily so you can run crossbow tests on this branch... |
Rationale for this change
The
r-devdocscrossbow CI job fails during the gap between the C++ release (published to apt) and the R package release (CRAN). Two hidden bash chunks insetup.Rmdwere silently installing the releasedlibarrow-devfrom apt during CI, overwriting the version built from the git checkout. Since the R package (arrow.so) was compiled against the newer git-builtlibarrow, loading it against the older apt version caused an undefined symbol ABI mismatch error.What changes are included in this PR?
Removes the hidden CI test chunks from
r/vignettes/developers/setup.Rmd:brew install apache-arrowapt install libarrow-dev(root cause of the ABI mismatch)MAKEFLAGS="LDFLAGS="example from an executable knitr chunk to a plainbashcode block preserves the documentation example without executing it in CIAre these changes tested?
No, the fix removes the broken test logic from the vignette. As noted by @thisisnic, this type of testing should live in proper CI infrastructure, not embedded as hidden code in documentation.
Are there any user-facing changes?
No. The rendered documentation is unchanged the
MAKEFLAGS="LDFLAGS="example remains visible in the "Multiple versions of libarrow" troubleshooting section.