ARROW-7801: [R][CI] Add lint and doc GitHub Action workflows #6411
Conversation
|
Thanks for opening a pull request! Could you open an issue for this pull request on JIRA? Then could you also rename pull request title in the following format? See also: |
nealrichardson
changed the title
|
Does this mean it's going to push to my fork behind my back? If so, then -1 from me. I'd rather see a CI entry that fails if the man pages weren't updated. |
There was a problem hiding this comment.
I'd rather see a CI entry that fails if the man pages weren't updated.
I think that we need it too.
@nealrichardson Could you also add it too?
Anyway, this will be useful to generate consistent man pages. (I'm not sure that generated man pages may depend on environment.)
nealrichardson
force-pushed
the
roxygen
branch
from
4a42b9c to
3148470
Compare
The CI jobs we already have will fail if the man pages don't match the code.
They shouldn't. Since there seems to be some difference of opinion as to whether this is a good idea, I'll open a thread on the mailing list before proceeding. |
|
Closing since the discussion on the mailing list showed opposition to auto-fixing things. |
…codegen #6411 tried to do this work automatically, but some were uncomfortable with that; this version instead is triggered by PR comment. Currently implemented: * R documentation (`roxygen2`, updating `r/man/*.Rd` based on docstrings in `r/R/*.R`) * clang-format on changes to `cpp/src` or `r/src` * cmake_format is currently disabled because I didn't feel like fighting further with python versions and environments; in https://github.com/nealrichardson/arrow/runs/590355718?check_suite_focus=true#step:5:34 you can see that it pip installs cmake_format but then in the next line can't find cmake_format 🤷 To trigger the build, add a comment with the message "autotune" (seemed appropriate since this is using computers to make sure our code stays in harmony). By default it will check for which files changed and only run the relevant tasks, but if you comment "autotune everything" it will run everything. Since `issue_comment` workflows are only run off the master branch, I tested this by merging these commits to master on my fork and triggering it on a PR there. See e.g. nealrichardson#2 (comment) Closes #6932 from nealrichardson/autotune2 Authored-by: Neal Richardson <neal.p.richardson@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
…codegen #6411 tried to do this work automatically, but some were uncomfortable with that; this version instead is triggered by PR comment. Currently implemented: * R documentation (`roxygen2`, updating `r/man/*.Rd` based on docstrings in `r/R/*.R`) * clang-format on changes to `cpp/src` or `r/src` * cmake_format is currently disabled because I didn't feel like fighting further with python versions and environments; in https://github.com/nealrichardson/arrow/runs/590355718?check_suite_focus=true#step:5:34 you can see that it pip installs cmake_format but then in the next line can't find cmake_format 🤷 To trigger the build, add a comment with the message "autotune" (seemed appropriate since this is using computers to make sure our code stays in harmony). By default it will check for which files changed and only run the relevant tasks, but if you comment "autotune everything" it will run everything. Since `issue_comment` workflows are only run off the master branch, I tested this by merging these commits to master on my fork and triggering it on a PR there. See e.g. nealrichardson#2 (comment) Closes #6932 from nealrichardson/autotune2 Authored-by: Neal Richardson <neal.p.richardson@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
3 participants
I'm tired of forgetting to update the rendered docs (in
r/man/), so this workflow does it for us. It's designed to run only on your fork, not on apache/arrow. It can't just work on pull requests, IIUC, because the GITHUB_TOKEN only had read permissions on a PR.This PR includes a change to the doclets in the .R source that triggers a rendering of the .Rd man pages. https://github.com/nealrichardson/arrow/runs/442280907?check_suite_focus=true is the workflow run that updated and pushed the changes. The subsequent push doesn't trigger the job to run again because of the path filtering.
In a different PR, I've removed
README.Rmd, so updating that is no longer an issue. For linting, that should be handled in the main lint job. I'll look to do it there and if that's too much trouble, I'll probably add a workflow tolint.sh --fixther/src.