Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[INFRA] Add a job which regenerate automatically the documentation (.Rd) on each PR #58

Open
csouchet opened this issue Oct 15, 2021 · 1 comment
Open

[INFRA] Add a job which regenerate automatically the documentation (.Rd) on each PR #58

csouchet opened this issue Oct 15, 2021 · 1 comment
Assignees
@csouchet
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Comments

@csouchet
Copy link
Member

csouchet commented Oct 15, 2021 •
edited
Loading

Add a new job who execute the command devtools::document(), and commit the change in the current PR if there is updating in the documentation.

See also #30
@csouchet csouchet added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Oct 15, 2021
@csouchet csouchet changed the title [INFRA] Add a job which regenerate automatically the documentation on each PR [INFRA] Add a job which regenerate automatically the documentation (.Rd) on each PR Oct 15, 2021
@csouchet csouchet self-assigned this Oct 15, 2021
@csouchet csouchet mentioned this issue Oct 15, 2021
Closed
@tbouffard
Copy link
Member

⚠️ our need is to ensure that the generated documentation is always up to date. A job may be a way to do it, but this is not mandatory. I suggest we rename the issue to match what we need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@csouchet csouchet

Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Projects
None yet
Milestone
No milestone
2 participants
@csouchet @tbouffard