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

Add client methods for the Checks API #1101

Merged
merged 19 commits into from
Jan 17, 2019
Merged

Add client methods for the Checks API #1101

merged 19 commits into from
Jan 17, 2019

Conversation

laserlemon
Copy link
Contributor

@laserlemon laserlemon commented Jan 17, 2019

Addresses: #1074 and #1075

👋 Hello! This pull request is functionally complete, but still a work in progress due to documentation. I'd like to get your 👀 on the naming and implementation while I round out the docs. I tried to stick to existing conventions as much as possible, but please let me know if there are any changes you'd like to see. Thank you! 💛

Update: The build was failing for unrelated reasons. The latest version of Bundler is 2.0.1 but the gemspec specified Bundler ~> 1.0. I've expanded that requirement to include Bundler 2.x. I've also taken the liberty of adding Ruby 2.6 to the build and to the list of supported Rubies. I'm happy to remove that if you prefer! 💚

Update 2: Documentation is finished and this is ready for review! 💙

To-Do

  • Test and add methods for the six available Check Run endpoints
  • Test and add methods for the five available Check Suite endpoints
  • Check coverage/index.html for 💯% code coverage
  • Write method documentation
  • Run bundle exec rake doc:yard to test documentation coverage

Copy link
Member

@tarebyte tarebyte left a comment

Choose a reason for hiding this comment

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

The naming looks fine to me, thanks @laserlemon!

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'octokit/version'

Gem::Specification.new do |spec|
spec.add_development_dependency 'bundler', '~> 1.0'
spec.add_development_dependency 'bundler', '>= 1', '< 3'
Copy link
Member

Choose a reason for hiding this comment

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

💖

@tarebyte tarebyte merged commit 5bf2325 into octokit:master Jan 17, 2019
@tarebyte tarebyte mentioned this pull request Jan 17, 2019
@laserlemon laserlemon mentioned this pull request Jan 17, 2019
@timoschilling
Copy link

@tarebyte can we get a new release with this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants