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 version / Git commit comment to generated deny.toml #690

Open
Marcono1234 opened this issue Aug 3, 2024 · 0 comments
Open

Add version / Git commit comment to generated deny.toml #690

Marcono1234 opened this issue Aug 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Marcono1234
Copy link
Contributor

Is your feature request related to a problem? Please describe.
cargo deny init creates a default deny.toml for that version, and it is quite verbose.

The problem is if you later update cargo-deny and also want to (manually) update deny.toml based on the deny.template.toml for that cargo-deny version, it is a bit difficult to find out what you customized originally because you cannot easily see from which template version deny.toml was originally generated.

Describe the solution you'd like
The generated deny.toml (or even deny.template.toml) should have a comment at the top mentioning the cargo-deny version or Git commit for which it was generated.

This way when you manually want to update it later, you can diff with the deny.template.toml file on GitHub from that version to easily see what you had customized.

Even better might be if it included a GitHub URL of deny.template.toml so that you directly know what to compare with. For example:

# Based on https://github.com/EmbarkStudios/cargo-deny/blob/0.16.0/deny.template.toml
# (diff with that version to see what has been manually changed here)

# This template contains all of the possible sections and their default values

# ...

Describe alternatives you've considered
none

@Marcono1234 Marcono1234 added the enhancement New feature or request label Aug 3, 2024
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

1 participant