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.

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

[Bug]: The roxygen auto update commit does not delete files that are deleted by roxygen #212

Closed
2 tasks done
vedhav opened this issue Feb 22, 2024 · 3 comments
Closed
2 tasks done
Labels
bug Something isn't working

Comments

@vedhav
Copy link

vedhav commented Feb 22, 2024

What happened?

In this PR the docs were not updated. The CI was able to identify this and commit the new docs. However, it did not commit the deletion of a file.

P.S It would be nice to re-run the CI because every time this happens we need to trigger the CI ourselves.

Which version(s) of R were you using?

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct.

Contribution Guidelines

  • I agree to follow this project's Contribution Guidelines.
@vedhav vedhav added the bug Something isn't working label Feb 22, 2024
@cicdguy
Copy link
Contributor

cicdguy commented Feb 22, 2024

I'm pretty sure that roxygen2::roxygenize('.')'s actions are not strictly additive. It is capable of deleting files as well.

Eg:

rm R/hello.R
> roxygen2::roxygenize('.')
Writing NAMESPACELoading r.pkg.template
Warning: Objects listed as exports, but not present in
namespace:helloplumber_apishiny_app
Writing NAMESPACE
Deleting hello.Rd, plumber_api.Rd, and shiny_app.Rd

@cicdguy
Copy link
Contributor

cicdguy commented Feb 22, 2024

It would be nice to re-run the CI because every time this happens we need to trigger the CI ourselves.

Interestingly GitHub has introduced a new set of workarounds to auto-trigger workflows on bot commits, which was previously not allowed to prevent recursive runs: https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#workarounds-to-trigger-further-workflow-runs

Maybe we can look into other alternatives. Will track that separately.

@cicdguy
Copy link
Contributor

cicdguy commented Feb 22, 2024

Done in #215

@cicdguy cicdguy closed this as completed Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants