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

Log deprecation message for recipes using easy_install. #585

Merged
merged 2 commits into from
Mar 7, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions recipes/ddtrace-python.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
# NB: This recipe is compatible with Chef <= 12 only. If you're using Chef 13 or higher
# please refer to the README of the cookbook.

log 'message' do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason to use the resource instead of Chef::Log? (genuine question, didn't know about the resource)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not any, I've changed to use Chef::Log as I see there is already many usage of it in the repo, I prefer to stick with known things.

message 'This recipe will be deprecated in version 3.0.0 of the cookbook. See README.md chapter ddtrace-python for more infos.'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chapter -> section

infos -> info

Also, can you remind the name of the cookbook in the message? (datadog cookbook). Generally useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 👍
I've also repeated the recipe name.

level :warn
end

easy_install_package 'ddtrace' do
version node['datadog']['ddtrace_python_version']
end
5 changes: 5 additions & 0 deletions recipes/dogstatsd-python.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,9 @@
# NB: This recipe is compatible with Chef <= 12 only. If you're using Chef 13 or higher
# please refer to the README of the cookbook.

log 'message' do
message 'This recipe will be deprecated in version 3.0.0 of the cookbook. See README.md chapter dogstatsd-python for more infos.'
level :warn
end

easy_install_package 'dogstatsd-python'