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

Update rubocop to v0.52.1 for Slack plugin #59

Closed
wants to merge 4 commits into from

Conversation

nicoleheejin
Copy link

@nicoleheejin nicoleheejin commented Jan 22, 2018

Pull Request Checklist

Is this in reference to an existing issue?
Yeah! sensu-plugins/community#77

General

Purpose

Known Compatibility Issues

  • None that I'm aware of

@majormoses
Copy link
Member

Thanks for your contribution to Sensu plugins! Without people like you submitting PRs we couldn't run the project. I will review it shortly.

Special kudos for picking up security issues.

Copy link
Member

@majormoses majormoses left a comment

Choose a reason for hiding this comment

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

Overall this looks great! some minor things regarding our community contribution practices, once they are addressed I am 👍 Thank you very much for taking the time to do this.

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins

## [Unreleased]

## [3.0.1] - 2018-01-21
Copy link
Member

Choose a reason for hiding this comment

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

Per our changelog conventions all submitted changes go under ### [Unreleased] there are a couple of reasons for this:

  • There is no guarantee when a maintainer will review so the release date will likely be wrong unless we get to it in the same day
  • There is no guarantee on the review/merge order, bumping the version prior to acceptance is pretty much guaranteed to need to have the submitter rebase
  • Maintainer may disagree on how you interpret the change, for example in this case you versioned a as a patch when in fact it is a breaking change as you drop a version of ruby being supported. Even when an update is in the name of security we generally follow semver unless there is a very good reason not to such as putting the consumer at extreme risk. This is outlined as it relates to security here if you are interested in understanding how we handle these edgecases.

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins

## [Unreleased]

## [3.0.1] - 2018-01-21
### Changed
- Bumped Rubocop to 0.52.1 in response to CVE-2017-8418 (@nicoleheejin)
Copy link
Member

Choose a reason for hiding this comment

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

To keep things consistent with the other PR's we should bump it to ~> 0.51.0 which satisfies the requirement to patch the vulnerability and reduces the number of new cops to satisfy.

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins

## [Unreleased]

## [3.0.1] - 2018-01-21
### Changed
Copy link
Member

Choose a reason for hiding this comment

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

This should actually go under a ### Security header rather than changed as it makes it clear to consumers that this update is important and should be prioritized over pulling in other types of changes.

@@ -2,7 +2,7 @@ module SensuPluginsSlack
module Version
MAJOR = 3
MINOR = 0
PATCH = 0
PATCH = 1
Copy link
Member

Choose a reason for hiding this comment

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

see above comment regarding versioning pre-acceptance.

s.add_development_dependency 'rspec', '~> 3.1'
s.add_development_dependency 'rubocop', '~> 0.52.1'
Copy link
Member

Choose a reason for hiding this comment

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

This needs to be called out in the changelog under ### Breaking Changes so that we inform users on the impact and make it more obvious to reviewers and maintainers so it can be evaluated and versioned appropriately.

@nicoleheejin
Copy link
Author

awesome! I will address these changes shortly and will continue working through the list! Thank you for the feedback!

@majormoses
Copy link
Member

@nicoleheejin checking back to see if you can make those changes so we can get this merged and released.

Also looks like you now need a rebase to fix conflicts, let me know if you need help.

@majormoses
Copy link
Member

closing due to inactivity and merge conflicts.

@majormoses majormoses closed this May 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants