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

Deterministic output #202

Open
o0Ignition0o opened this issue Aug 17, 2022 · 1 comment
Open

Deterministic output #202

o0Ignition0o opened this issue Aug 17, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@o0Ignition0o
Copy link
Contributor

Is your feature request related to a problem? Please describe.

We have been (successfully, tysm! ❤️) using cargo about to generate our licenses.html file for a while, and we love it so much we have had a CI step that ensures the licenses.html file is always up to date.

We currently do that by invoking cargo about generate in CI and checking if there's a diff.

CI sometimes turns red, and after a bit of investigation it seems like the licenses.html file generation isn't deterministic.

Describe the solution you'd like

Would you be open to receiving a PR that makes licenses.html file generation deterministic?

I haven't dug too much yet (I wanted to first make sure this would fit your goals, and you'd be open to receiving a PR first), but this may involve having a (possibly gated) "preserve-order" feature on serde_json, but it might be a bit more involved.

Describe alternatives you've considered

We haven't considered any alternatives yet, but we'd be happy to discuss this if there's an other way to make sure licenses are always in sync :)

Thanks a lot! :)

@Jake-Shadle
Copy link
Member

The output (or rather, the inputs to the template) is definitely supposed to be deterministic, so any PR fixing non-determinism would be welcomed.

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

No branches or pull requests

2 participants