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

Deprecate `collector` attribute #211

Merged
merged 2 commits into from Apr 26, 2017

Conversation

Projects
None yet
2 participants
@chris-rock
Collaborator

chris-rock commented Apr 26, 2017

Description

Changes the name of the collector attribute to reporter. This is a non-breaking change, because the fallback has been implemented already: https://github.com/chef-cookbooks/audit/blob/master/libraries/helper.rb#L128-L136

Fixes #205

@chris-rock chris-rock changed the title from Deprecate `collector` attribute to WIP: Deprecate `collector` attribute Apr 26, 2017

@chris-rock chris-rock changed the title from WIP: Deprecate `collector` attribute to Deprecate `collector` attribute Apr 26, 2017

deprecate collector attribute in favor of reporter
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
@arlimus

Just a tiny improvement to phrasing, everything else looks great thank you!
I understand that this change is to be in line with the internal terms that are used across all InSpec projects.

README.md Outdated
@@ -5,6 +5,21 @@ The `audit` cookbook allows you to run InSpec profiles as part of a Chef Client
Version 2.0 of the audit cookbook is based on an idea from [Michael Hedgpeth](https://github.com/chef-cookbooks/audit/issues/70). Under the hood it uses [Chef handler](https://docs.chef.io/handlers.html) instead of Chef resources now.
Note: With version 3.1.0, we are deprecating the use `collector` attribute and use the term `reporter`. The following

This comment has been minimized.

@arlimus

arlimus Apr 26, 2017

Contributor

slight phrasing improvement suggestion:

Note: With version 3.1.0 the use of the `collector` attribute is deprecated. Please use `reporter` instead. The `collector` attribute will be removed in the next major version.
update readme
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
@arlimus

yay 🎊

@arlimus arlimus merged commit 33f2199 into master Apr 26, 2017

2 checks passed

DCO This commit has a DCO Signed-off-by
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@arlimus arlimus removed the in progress label Apr 26, 2017

@arlimus arlimus deleted the chris-rock/deprecate-collector-naming branch Apr 26, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment