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

Deprecate collector attribute #211

Merged
merged 2 commits into from
Apr 26, 2017
Merged

Conversation

chris-rock
Copy link
Contributor

@chris-rock 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 Deprecate collector attribute WIP: Deprecate collector attribute Apr 26, 2017
@chris-rock chris-rock force-pushed the chris-rock/deprecate-collector-naming branch from dad20fb to 6b07567 Compare April 26, 2017 12:24
@chris-rock chris-rock changed the title WIP: Deprecate collector attribute Deprecate collector attribute Apr 26, 2017
@chris-rock chris-rock force-pushed the chris-rock/deprecate-collector-naming branch from 6b07567 to 0416d82 Compare April 26, 2017 12:42
Copy link
Contributor

@arlimus arlimus left a comment

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Signed-off-by: Christoph Hartmann <[email protected]>
Copy link
Contributor

@arlimus arlimus left a comment

Choose a reason for hiding this comment

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

yay 🎊

@arlimus arlimus merged commit 33f2199 into master Apr 26, 2017
@arlimus arlimus deleted the chris-rock/deprecate-collector-naming branch April 26, 2017 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants