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

Add renv.lock validation hook #558

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

jrdnbradford
Copy link

Any interest in adding a hook like this?

When used correctly, you should never really have to worry that your renv.lock file does not fit the schema. But in practice, especially with collaborators, you may want an extra check that no one has accidentally edited fields as this can cause difficult to diagnose errors. Never hurts to have an automated check!

{renv} doesn't actually provide a schema, but I believe I've provided one that fits it. It may need to go into its own file instead of being a string, but I couldn't get the tests to pass when I had it in inst/.

@lorenzwalthert
Copy link
Owner

Interesting. However, I think I'd only want to support this hook if {renv} officially provided a schema. Did you talk to Kevin about it or open an issue for it?

@lorenzwalthert
Copy link
Owner

Also, please note that before submitting new PRs, discussion in an issue is encouraged as per our CONTRIBUTING.md.

@jrdnbradford
Copy link
Author

Ah, apologies, embarrassing that I missed that.

Looks like this is the current state of what the {renv} maintainers think about having a schema:

The renv.lock lockfile is a JSON file, and while no schema is provided, you should be able to infer the structure from the existing fields.

I can open an issue to see if there's any interest. If not, I/you can close this PR.

@lorenzwalthert
Copy link
Owner

Yes, please open one and see what happens. I would like to offload the task of updating the schema upstream as well as how to deal with an evolving schema. These are core {renv} functionalities. As a strategy of last resort, you can also implement this hook in your own hook repo instead of here. It’s not too much work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants