nautobot / cookiecutter-nautobot-app

Cookiecutter template for creating new Nautobot Apps.
https://docs.nautobot.com/projects/cookiecutter-nautobot-app/en/latest/
Apache License 2.0
14 stars 5 forks source link

App development environments should set `NAUTOBOT_LOG_DEPRECATION_WARNINGS=true` #117

Open glennmatthews opened 3 months ago

glennmatthews commented 3 months ago

Proposed Functionality

The cookiecutter (specifically development.env) should set the environment variable NAUTOBOT_LOG_DEPRECATION_WARNINGS=true as a way to warn alert developers against the use of deprecated Nautobot core APIs and classes. See also https://docs.nautobot.com/projects/core/en/stable/user-guide/administration/configuration/optional-settings/#log_deprecation_warnings.

Use Case

Developers watching the Nautobot logs while developing/testing their App will be warned by visible log messages if they use an API that has been flagged as deprecated by Nautobot core.