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 flag for rules #184

Open
rgeyer opened this issue Jul 10, 2024 · 0 comments
Open

Add a deprecation flag for rules #184

rgeyer opened this issue Jul 10, 2024 · 0 comments

Comments

@rgeyer
Copy link
Collaborator

rgeyer commented Jul 10, 2024

It should be possible to mark an existing rule as "deprecated".

This would be dependent upon the dashboard-linter being properly versioned. See #150

Replacing/Removal Reason

When deprecated, a rule would optionally reference one or more rules which replace it. If no rules replace it, a description of why the rule is being removed should be provided.

Failure on deprecated rule

When a deprecated rule fails while linting a dashboard, the deprecation message should be included. Perhaps the rule should also be decreased in severity?

.lint/Configuration tidiness

When a deprecated rule is found in the config file (.lint, likely under the "exclusions" section), a message should be presented to the user that they're excluding a deprecated rule, and they may be able to remove the exclusion.

Perhaps we also need a "disabled" flag, which would allow still searching for the rule in the config (as above), but not execute the rule.

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

No branches or pull requests

1 participant