Deprecate record_deploy command (#1500)

* Deprecate record_deploy command

* Add alternative to deprecation message

* import warnings

* [MegaLinter] Apply linters fixes

* Update newrelic/admin/record_deploy.py

Co-authored-by: Hannah Stepanek <[email protected]>

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Hannah Stepanek <[email protected]>
Co-authored-by: hmstepanek <[email protected]>

Author: 3 people

newrelic/admin/record_deploy.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import getpass
+import warnings
 
 from newrelic.admin import command, usage
 from newrelic.common import agent_http, encoding_utils
@@ -109,6 +110,15 @@ def record_deploy(
 def record_deploy_cmd(args):
     import sys
 
+    # Deprecation Warning
+    warnings.warn(
+        (
+            "The record_deploy command is deprecated and will be removed in the next major release. It is being removed in favor of other methods of creating a change tracking marker. See the documentation for replacement alternatives: https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/"
+        ),
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     if len(args) < 2:
         usage("record-deploy")
         sys.exit(1)

newrelic/newrelic.ini

@@ -187,6 +187,8 @@ browser_monitoring.auto_instrument = true
 # https://docs.newrelic.com/docs/apm/apm-ui-pages/events/thread-profiler-tool/
 thread_profiler.enabled = true
 
+# This setting has been deprecated and will be removed in the
+# next major release:
 # Your application deployments can be recorded through the
 # New Relic REST API. To use this feature provide your API key
 # below then use the `newrelic-admin record-deploy` command.