Releases: octokit/octokit.rb
Releases · octokit/octokit.rb
v4.13.0
Bug fixes
Documentation
Support for new preview headers
Testing fixes
v4.12.0
v4.11.0
v4.10.0
Graduated preview periods
- #1020 Remove preview warning for marketplace API
- #1041 Remove marketplace preview warnings (we mean it, this time)
- #1042 Remove preview warning for Repository Invitations API
- #1047 Rework request review API to support team reviewers
Support for new endpoints
Bugfixes
- #1025 Fix contributors endpoint for empty repos
- #1034 Duplicate option to prevent mutating original
- #1018 Convert OCTOKIT_SSL_VERIFY_MODE environment variable to integer
Enhancements
v4.9.0
Bugfixes
- #1006 Use Addressable::URI instead of stdlib URI for normalization
- #1003 Fix pagination of GitHub App endpoints
- #1000 Call dup on arguments before mutating
Documentation changes
- #969 Document the steps necessary to cut a release
- #972 Url to the review API was wrong
- #973 Fix pull_requests_comments example documentation
- #985 Add tag_name to update_release documentation
- #989 Command example fix in documentation.
- #1008 Fixes documentation for getting single issue comment
- #1011 Fix example call to Octokit.label
Enhancements
Maintenance
Support for additional API endpoints
v4.8.0
Support for additional API endpoints
- #885 Topics API
- #884 Get a single Installation
- #894 Add assignees
- #895 Find user installations
- #929 Marketplace listings API
- #928 Nested Teams API
- #938 Get user's marketplace purchases
- #932 GitHub Apps API
APIs taken out of preview
Enhancements
- #886 Allow reviews and review comments to be paginated
- #899 Expose response_headers and response_body on error objects
- #877 Improve error message when
Octokit::Repository.newfails - #958 Update add/remove installations methods to use non-deprecated endpoints
- #892 Move integrations endpoints across to apps
Bugfixes
- #876 Remove destructive assignment for repository
- #966 Fix apps client for GitHub Enterprise installs (new endpoints in this release, but still)
Note about Rubinius support
We have been unable to get a Rubinius build working for CI for quite some time, meaning that Rubinius support has been spotty or non-existent. In this release we finally stopped trying. This isn't directly backwards-incompatible since it already wasn't working, but it does feel a bit iffy.
If you happen to use Rubinius and know how to get this working on Travis, we'd be delighted to review a pull request that adds it back in.
v4.7.0
- #837 Fix passing options to all_organizations
- #841 Add new methods from the most recent org memberships API enhancements
- #851 Fix application requests for non dotcom hosts
- #858 Don't mutate the options variable passed to API calls
- #871 Add support to prerelease Integrations API
- #874 Handle PR Review errors
- #860 Implement Review Preview API
- #869 Use Organization.path for organization membership method
- #880 Fix incorrect mimetype for integrations in PREVIEW_TYPES
- #881 Change several occurrences of
Hash#merge!
v4.6.0
Library Changes
#829 Sawyer dependency loosened to support new release 'sawyer', '>= 0.5.3', '~> 0.8.0' Thank you @andrew
Updated Methods
- #protect_branch
required_status_checkparameter is no longer required, which makes the method call signature changed.required_status_checkcan be passed in the options hash. - #unprotect_branch returns a boolean value now
New Methods
#820 Projects APIs https://developer.github.com/v3/projects/
- #projects List projects for a repository
- #create_project Create a Project
- #org_projects List Organization Projects
- #create_org_project Create Organization Project
- #project Get a Repository Project
- #update_project Update a Project
- #delete_project Delete a Project
- #project_columns List a Project's Columns
- #create_project_column Create a Project Column
- #project_column Get a Project Column
- #update_project_column Update a Project Column
- #delete_project_column Delete a Project Column
- #move_project_column Move a Project Column
- #column_cards List Column Cards
- #create_project_card Create a Project Card
- #project_card Get a Project Card
- #update_project_card Update a Project Card
- #move_project_card Move a Project Card
- #delete_project_card Delete a Project Card
#824 Traffic APIs https://developer.github.com/v3/repos/traffic/
- #top_referrers Get the top 10 referrers over the last 14 days.
- #top_paths Get the top 10 popular contents over the last 14 days.
- #views Get the total number of views and breakdown per day or week for the last 14 days.
- #clones Get the total number of clones and breakdown per day or week for the last 14 days.
v4.4.1
v4.4.0
Regression notice
#815 #pages method was incorrectly updated to require the new preview header. Fix released in v4.4.1
Library changes
- #777 This impacts all methods that pass a repository parameter. Change Repository.validate_owner_and_name! to use URI::ABS_URI instead the deprecated URI.regexp
- #752 Use octokit_warn instead of warn in Preview.warn_preview
- #761 Octokit::AccountSuspended for 403 responses @koglinjg
New methods
- #748 Add support for Source Import APIs @LizzHale
https://developer.github.com/v3/migration/source_imports/ - #814 #799 New method Repositories.branch_protection to get a branch's protection status
https://developer.github.com/v3/repos/branches/#get-branch-protection - #770 Add Issues#lock and Issues#unlock @davidcelis
https://developer.github.com/v3/issues/#lock-an-issue
https://developer.github.com/v3/issues/#unlock-an-issue - #816 Add Pages.pages_build to get specific page build by ID https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build
Updated Methods
- #733 Support getting Milestones by repository id @stmllr
- #739 Escape options values in authorize_url @shvaikalesh
- #705 #704 Support API urls in Repository#from_url
- #780 Dup options in #create_repo method before mutating the hash @davidcpell
- #815 Change Pages.pages to use preview media type to gain additional data. Add Pages.request_page_build for https://developer.github.com/v3/repos/pages/#request-a-page-build
- #797 Change #upload_assets to read files in read only mode @trevorrowe
- #743 Add deprecation warning for when :permission parameter is passed to Organizations.create_team. Assign team repository permissions with Organizations.add_team_repository instead.
- #805 *_stats methods return nil on timeout when : retry_wait is used. Previously returned empty Sawyer::Resource. @etiennebarrie
- #819 #protect_branch Enable branch protection without enforcing required_status_checks. @mgreensmith
Documentation Edits
- #750 Fix typo in README.md @blunderdome
- #804 @kei-s #create_pull_request_comment_reply
- #817 Fix .decline_repository_invitation API doc url
- #742 Fix Default.middleware documentation comment @v-kolesnikov
- #754 Add Table of contents to README.md