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 a deprecation notice mechanism #123

Open
volks73 opened this issue Nov 8, 2020 · 2 comments
Open

Add a deprecation notice mechanism #123

volks73 opened this issue Nov 8, 2020 · 2 comments
Assignees

Comments

@volks73
Copy link
Owner

volks73 commented Nov 8, 2020

As highlighted in #113, a mechanism for notifying users of deprecations and migrations might be needed. At least a consistent and documented process is needed. From #113 comments:

This does highlight that a general deprecation mechanism/process is probably needed. How do other Cargo subcommands handle this? We need to be able to make changes and evolve without fear while minimizing technical debt but without constantly breaking things for everyone. The goal of a tool is to make less work for everyone. Maybe when a command is executed, like the create (default) command, WARN statements with all deprecations are printed, but we add a --surpress-deprecations flag? This would hide the notices, or it could work in the reverse (--show-deprecations) and be silent by default? Hmm, maybe this could be tied to the --nocapture flag, such that if the output is not captured, the deprecation notices are printed along with the output from the WiX applications?

@volks73
Copy link
Owner Author

volks73 commented Nov 8, 2020

I am currently favoring the adding deprecation notices to the --nocapture flag as this flag is generally only used during debugging and errors. The deprecation notices would then help during debugging when the cargo-wix subcommand is updated and things break. Basically, it would provide some breadcrumbs to follow for resolution.

@roblabla
Copy link
Contributor

roblabla commented Nov 8, 2020

Maybe when a command is executed, like the create (default) command, WARN statements with all deprecations are printed, but we add a --surpress-deprecations flag?

If we go down this route, we should allow individual deprecation notices to be silenced, otherwise you could miss new deprecation notices when all you wanted was to shut down old irrelevant notices.

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

No branches or pull requests

2 participants