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.

Sign up for GitHub

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

Jump to bottom

Deprecated decorator for module params #3505

Open
miqm opened this issue Jul 7, 2021 · 5 comments · May be fixed by #15330
Open

Deprecated decorator for module params #3505

miqm opened this issue Jul 7, 2021 · 5 comments · May be fixed by #15330
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone
Selenium

Comments

@miqm
Copy link
Collaborator

miqm commented Jul 7, 2021

Is your feature request related to a problem? Please describe.
When developing module packs sometimes we need to remove a parameter (or replace it with a new one) , keeping old one for some time until users switch to new one.

Describe the solution you'd like
I'd like to have a @deprecated('description') decorator that I can place on parameter so bicep during compile time will throw warning and the VSCode extension will visually indicate on the module params that this one is deprecated - both in usages inside module and on value assignments.
@miqm miqm added the enhancement New feature or request label Jul 7, 2021
@ghost ghost added the Needs: Triage 🔍 label Jul 7, 2021
@anthony-c-martin
Copy link
Member

Great suggestion!

@alex-frankel alex-frankel added this to the Committed Backlog milestone Jul 7, 2021
@alex-frankel alex-frankel mentioned this issue Apr 10, 2023
Closed
@alex-frankel
Copy link
Collaborator

Might be a separate issue, but looks like we will also need a way to mark the modules themselves as deprecated. I'm assuming there is some way to do this in the OCI manifest annotations.

@jeskew jeskew mentioned this issue Sep 13, 2023
Open
@jeskew jeskew added the good first issue Good for newcomers label Feb 6, 2024
@mrossi-kmx
Copy link

Just encountered a use case for this on my team. We maintain a common registry of Bicep modules for many development teams in our org. Occasionally we want to remove a parameter without breaking teams who use the latest version. A decorator resulting in a warning log message during deployment would be an effective additional channel to communicate plans for deprecating a parameter.

@jtracey93
Copy link

@alex-frankel was speaking with @anthony-c-martin based off of the community call today where we talked about the "Deprecation" guidance in AVM, and this feels like it could very easily simplify our guidance and decrease the risk of "paper cuts" by AVM module consumers.

Any chance we can bump this up to get implemented sooner rather than later (please 😁)?

@alex-frankel
Copy link
Collaborator

I will add it to our list to triage for our [Se] planning (which should be wrapping up today), but I would guess we won't be able to prioritize this anytime soon. Is there anyone on the AVM side that would be interested in contributing here? We'd be very happy to help ramp anyone up to help with this.

@github-project-automation github-project-automation bot moved this to Todo in Bicep Oct 16, 2024
@alex-frankel alex-frankel linked a pull request Nov 8, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Bicep
Status: Todo
Milestone
Selenium
Development

Successfully merging a pull request may close this issue.

[WIP] Support for @deprecated() decorator Azure/bicep
6 participants
@jeskew @miqm @alex-frankel @anthony-c-martin @jtracey93 @mrossi-kmx