Create a dockerized gradle task to update the generated R client documentation. #4713
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Towards #4689
This PR adds two new gradle tasks to
R/build.gradle
:rClientDoc
creates a docker image with R doc support and runs it in a container generating a tar bundle inbuild/man/man.tar.gz
with the updated documentation.updateRClientDoc
overwrites the contents ofR/rdeephaven/man
with the newly generated doc by the task above.You can run either (they have proper dependencies) like so, from the root of a
deephave-core
clone:./gradlew :R:rClientDoc
./gradlew :R:updateRClientDoc
Notes
cpp-clients-multi-base
image from thedeephaven-base-images
repository... but then we will be taxing every deephaven developer who does not need to work on R related changes with a constant tax. So I think the tradeoff right now is to make this slightly less convenient to R developers only on the specific instance when doc needs to be regenerated in favor of avoiding that tax for everybody else on any and every change.