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

Write opam-monorepo invocation into lock file #308

Closed
Leonidas-from-XIV opened this issue Jun 7, 2022 · 1 comment · Fixed by #309
Closed

Write opam-monorepo invocation into lock file #308

Leonidas-from-XIV opened this issue Jun 7, 2022 · 1 comment · Fixed by #309
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Leonidas-from-XIV
Copy link
Member

In #307 we discussed how to make the lockfiles reproducible in the presence of command line options (that are able to change the output of the lockfile in a non-trivial way). A compromise that would allow both people to overwrite values via the CLI and yet give hints how to reproduce the generated lockfile is to write the invocation of the opam-monorepo call that was used to create the lockfile into the lockfile itself.

The potential advantages are:

  1. It allows people who want to reproduce the lock file to reproduce it. At least provided they use the same version of opam-monorepo but we don't really provide cross-version reproducibility for plenty of good reasons.
  2. It serves as documentation how the lockfile came to be, so newcomers to a project using opam-monorepo are aware of it and due to the invocation written there, they have a pointer to see how to use opam-monorepo

While this feature will not be implemented in #307, this issue was created to keep track of the idea.

@Leonidas-from-XIV Leonidas-from-XIV added enhancement New feature or request good first issue Good for newcomers labels Jun 7, 2022
@NathanReb NathanReb self-assigned this Jun 7, 2022
@NathanReb
Copy link
Contributor

I'm working on it as we speak.

Following up the original discussion, I was thinking about writing it in an extension rather than a comment.

We wouldn't parse it back for now but we'll have that ability if we ever need to in the future!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants