knplabs/github-api

Fixed

• Fix handling of 422 responses where errors is a string (GrahamCampbell) #1164

Added

• Add API to rerequest a check run (Spea) #1141
• List pull requests associated with a commit (lmjhs) #1146

Added

• Fix implicit nullable types to avoid PHP 8.4 warnings (eiriksm, acrobat) #1144
• Add API endpoints to interact with organization roles (glaubinix) #1143
• Copilot Usage Endpoints (anthony-webart) #1142
• Fix type error in ResultPager::fetch (nunoplopes) #1132

Fixed

• Handle case of GitHub returning 204 No Content in some scenarios (tomcorbett) #1135

Added

• Allow php-http/cache-plugin v2 (GrahamCampbell) #1134

Added

• Test against php 8.3 (sergiy-petrov) #1124
• feat: Secret Scanning Alerts (haridarshan) #1114
• feat: User Migration (haridarshan) #1115

Changed

• General chores (acrobat) #1125

Fixed

• Fix detection of secondary rate limit (mathieudz) #1126

Added

• feat: Support for Organization Runners (haridarshan, renovate[bot]) #1101
• allow psr/http-message v2 (LordSimal) #1122

Changed

• Fixed branch alias (GrahamCampbell) #1109

Added

• Added environment variables & secrets (Froxz) #1104
• Added Org & Repository variables (Froxz) #1106
• Deployment branch policies (Froxz) #1108

Changed

• Test on PHP 8.2 (GrahamCampbell) #1105

Fixed

• Bugfix creating env (Froxz) #1107

Added

• Add vulnerability alerts endpoints (andreia) #1096
• Added environments (Froxz) #1103

Changed

• Create authorization removed from docs (rafasashi) #1090
• Setup dependabot for github action workflows (acrobat) #1098
• Bump actions/checkout from 2 to 3 (dependabot[bot]) #1099
• Bump ramsey/composer-install from 1 to 2 (dependabot[bot]) #1100

Added

• Add the ability to download raw file, needed when size > 1MB (genintho) #1075
• Feat: Support new Team Repositories Endpoint (iBotPeaches) #1082
• App: add hook endpoints (glaubinix) #1086
• Add sync a fork branch with the upstream repository (DAGpro) #1084

Changed

• Fix return types in phpdoc for Assignees and ReviewRequest (rob006) #1078
• Fixed several typos and grammar errors (AndrewDawes) #1088

Added

• Deployments: added missing 'delete deployment' endpoint (clxmstaab) #991

Changed

• phpdoc: fix typo (clxmstaab) #993

Fixed

• fixed php warning in GithubExceptionThrower (clxmstaab, acrobat) #992

Changed

• Improved bc check (acrobat) #982
• Correctly link to github actions docs and fix backlinks (acrobat) #983
• Add missing repo hooks documentation (acrobat) #987
• Fix incorrect public key documentation (acrobat) #988
• Fixed incorrect parameters in apps docs (acrobat) #989

Fixed

• Deployments: use proper media-type for in_progress/queued, inactive state (staabm) #979
• backported #979 into 2.x (staabm) #981
• [952] doc - Specify lcobucci/jwt version, fix deprecation (amacrobert-meq, acrobat) #953
• Replace deprecated organization team repository add/remove urls (acrobat) #985

Fixed

• ExceptionThrower: adjust rate limit detection (glaubinix) #959

Added

• Mark some classes as final (acrobat) #954

Added

• Add parameters to PullRequest commits method (seanmtaylor) #938
• Actions (#872) (lexor) #939
• automated security endpoints (#868) (lexor) #944

Changed

• Update apps.md (clarkeash) #936

Fixed

• Throw exception for graphql errors (acrobat) #941

Added

• Improve checks api implementation (acrobat) #932

Changed

• Missing auth method in list of omitted passwords. (tobyS) #933
• Improve github actions setup (acrobat) #935

Added

• Add support for SSO errors coming from the API (eiriksm) #913
• Add OutsideCollaborators api (Matth--) #925
• Add support for creating a repo dispatch event (Nyholm) #931

Changed

• Fix: Wrong PHPDoc description (OskarStark) #922
• Adding GitHub authentication to GraphQL documentation (legionth) #927

Fixed

• Use RFC3986 for building URI query strings (GrahamCampbell) #908
• Fix call to test a webhook method (morrislaptop) #915

Added

• Prepare deprecation of authentication methods (acrobat) #870
• Add Support For GitData Reference Matching Methods (nickpoulos) #875
• Make invalid request error more clear (acrobat) #880
• Show user by ID (genintho) #894
• add additional check run methods (bobeagan, acrobat) #865

Changed

• Added phpstan (clxkoders) #871
• Increase phpstan to level 4 (acrobat) #874
• [Documentation] Add Missing Children to Pull Request Index (jimlind) #877
• [Documentation] Include links to Pull Request Children on Pull Request Doc. (jimlind) #878
• Fix typo in /lib/Github/Api/RateLimit.php (yoonper) #886
• Don't use deprecated auth in examples (GrahamCampbell) #892
• Removed shadow-cat (GrahamCampbell) #893
• Don't urlencode integer values (acrobat) #895
• phpstan level 6 fixes (acrobat, GrahamCampbell) #897

Fixed

• fix: use new media type for branch protections (iBotPeaches) #881
• Added missing 'machine-man-preview' accept headers (vovayatsyuk) #883
• Fix broken roave/bc-check test (acrobat) #890
• Fixed incorrect MissingArgumentException parent constructor values (acrobat) #896
• Added AUTH_ACCESS_TOKEN to allowed methods (GrahamCampbell) #899

Added

• Replace deprecated Organization\Teams api calls (lolos) #860
• Add sort and direction for fetching organizations repos (pgrimaud) #863
• Added parameters to Repo/milestones() method (dereuromark) #856

Fixed

• Remove incorrect MissingArgumentException in Labels api (bobeagan) #861

Changed

• Fix typos in test/Github/Tests/Api/RepoTest.php (pgrimaud) #862
• further detail on ResultPager parameters (sepiariver) #843
• fix phpdoc in labels api (staabm) #854
• fix api link in Issue\Labels::add() phpdoc (staabm) #853

Added

• Support the new authorizations API
• Repo community profile API endpoint
• Support for draft PRs
• Missing Apps endpoints
• Test against php 7.4

Changed

• Allow create & remove to set and remove requests for teams

Fixed

• Fixed bug in handling of validation errors
• Updated docs to not use deprected string parameter in issue assignee call

Added

• Support for HTTPlug 2.0 and PSR-18
• Add support for GitHub Checks
• Add support for GitHub Pages
• Add support to update a Pull Request Review
• Add support to get specific revision of a gist
• Added a 4th argument $parameters to PullRequest::files()
• Added Accept headers to Github Apps

Removed

• Active support for HHVM
• Support for PHP <7.1

Changed

• Allow tags to be created without the Tagger object
• When updating DeployKeys we will first remove existing then add a new DeployKey

Fixed

• In Trees we should check if array_key_exists('sha', $tree) instead of isset to avoid issues with null. (#822)

Deprecated

• Passing an integer ($page) as 4th arugment in Comments::all() is deprecated. It should be an array.

Added

• Support for Miscellaneous Licenses (#744)
• Structured Limit objects for rate limiting API (#733)
• Support for getting star creation timestamps in activity/starring endpoint (#729)

Fixed

• Added missing has_projects parameter to repo create (#752)
• Proper type hinting for magic methods (#758)
• Allow symlink to files to be downloaded (#751)

Changed

• Fix of PHP version in readme (#747)
• Fix documentation to get release for a tag (#755)
• Declare all used properties in RateLimitResource class (#762)
• Set correct property and return types (#764)
• Fixed install docs broken after 2.0 release of httplug lib (#767)

Fixed

• Convert the assignee parameter to array to avoid getting a 422 error on github (#738)
• Fix GraphQL test warnings when they do not assert anything (#735)

Changed

• Check for BC breaks during the travis build (#734)

Added

• Support for "before" parameter on Notification API (#724)

Changed

• Allow unspecified event when creating review (#723)

Fixed

• Adjust: installationn access token endpoint (#731)
• Fixed "get single label" example and add correct example for getting issue's labels (#732)
• Add comment about Key constructor argument (#722)

Added

• API endpoint Github\Api\Repo::transfer()
• API endpoint Github\Api\Notification::markThreadRead()
• API endpoint Github\Api\Search::topics()

Fixed

• Make sure to always reset the "per page" in Github\ResultPager::fetchAll().

Added

• Allow our HTTP plugins to show up in the Symfony web profiler page. (#687)
• Repository documentation to current user (#671)
• Add collaborator permission call (#678)
• Add missing parameters for User/CurrentUser Repositories (#684)
• Pimp the readme with badge poser (#686)

Fixed

• Typo in assignee documentation
• Missing use statement in security example
• Fixed phpdoc typo (#695)
• Replace use of deprecated api to the correct one in the security docs (#697)

Changed

• Updated requirements in readme (#689)

Added

• Phpunit 6 compatibility
• Github\Api\AbstractApi::setPage() to allow you to set the page on all endpoints.
• Support for query parameters and request headers on Github\Api\User::following and Github\Api\User::followers
• API endpoint Github\Api\CurrentUser\Emails::allPublic()
• API endpoint Github\Api\Search::commits()
• API endpoint Github\Api\Miscellaneous\CodeOfConduct
• API endpoint Github\Api\Repo::topics()
• API endpoint Github\Api\Repo::replaceTopics()

Fixed

• Fixed bug in PathPrepend plugin where "api/vX" could be duplicated.

Changed

• Improved documentation and doc blocks

Removed

• Dropped support for php 5.5

Deprecated

The following endpoints were deprecated by Github and are also deprecated in the client:

• Github\Api\Repo::find()
• Github\Api\User::find()
• Github\Api\Issue::find()

Added

• Support for graphql api variables (#612)
• Added missing branch protection methods (#616)
• Helper function fromFile to get GraphQL queries from a file (#628)
• Extra parameter params to collaborators api calls (#623)
• Documentation for GitData API (#613)

Fixed

• Remove body as a required parameter when creating an issue (#624)
• Minor fixes in example code (#617)

Added

• Stable support for graphql api (V4) (#593)
• Stable support for apps (previously integrations) (#592)
• Repo::events()

Fixed

• Incorrect link in repository search docs (#594)
• Added the required parameter $message on Review::dismiss.

Added

• Integrations::configure to allow accessing early access program endpoints.
• Add support for pagination and parameters in the pull request comments
• Add the ability to fetch user installations (CurrentUser::installations)
• Allow getting repo info by id (Repo::showById)
• Allow fetching repositories for a specific installation and user (CurrentUser::repositoriesByInstallation)

Changed

• PullRequest\Review and PullRequest\ReviewRequest is now part of the official API. No need to call configure.

Fixed

• Issue where we serve the wrong cached response. We vary on authorization header now.

Added

• PullRequest::status
• Throw InvalidArgumentException on PullRequest::merge when wrong merge method is used.
• Added Protection::configure

Changed

• First argument to Integrations::listRepositories() is now optional.
• Moved tests from "functional" to "integration"

Added

• API support for Pull Request Review Requests.
• API support for Traffic.
• API support for issue Assignees.
• API support for Miscellaneous Gitignore and Emojis.
• Added endpoints for issue lock, unlock and issue label show.
• Added more parameters to User::starred.
• Fluid interface by allowing configure() to return $this.
• configure() support for issues API.

Fixed

• Cache issue where some requests are not cached
• Issue with User::all() creates a query with double question marks.

Added

• Add support for retrieving a single notification info using his ID
• Add a function to get user organizations
• Added GraphQL support
• Add page variable to organization repo list (Organization::repositories())
• Add support for pull request review.
• Add support for adding branch protection.

Fixed

• Bug with double slashes when using enterprise URL.
• Bug when headers not being passed to request (#529)

Added

• Support for JWT authentication
• API for Organization\Members
• API for Integrations
• API for Repo\Cards
• API for Repo\Columns
• API for Repo\Projects
• API for User\MyRepositories
• Methods in Repo API for frequency and participation

Changed

• ApiLimitExceedException::__construct has a new second parameter for the remaining API calls.
• First parameter of Github\Client has changed type from \Http\Client\HttpClient to Github\HttpClient\Builder. A factory class was also added. To upgrade you need to change:

// Old way does not work:
$github = new Github\Client($httpClient);

// New way will work:
$github = new Github\Client(new Github\HttpClient\Builder($httpClient));
$github = Github\Client::createWithHttpClient($httpClient);

• Renamed the currentuser DeployKeys api class to PublicKeys to reflect to github api name.

Added

• HTTPlug to decouple from Guzzle
• Github\Client::getLastResponse was added
• Support for PSR-6 cache
• Github\Client::addPlugin and Github\Client::removePlugin
• Github\Client::getApiVersion
• Github\Client::removeCache

Changed

• Uses of Github\HttpClient\HttpClientInterface is replaced by Http\Client\HttpClient ie the constructor of Github\Client.
• We use PSR-7's representation of HTTP message instead of Guzzle\Http\Message\Response and Guzzle\Http\Message\Request.
• Github\Client::addHeaders was added instead of Github\Client::setHeaders
• Signature of Github\Client::useCache has changed. First argument must be a CacheItemPoolInterface
• We use PSR-4 instead of PSR-0

Removed

• Support for PHP 5.3 and 5.4
• Github/HttpClient/HttpClientInterface was removed
• Github/HttpClient/HttpClient was removed
• All classes in Github/HttpClient/HttpClient/Listener/* were removed
• Github/HttpClient/CachedHttpClient was removed
• All classes in Github/HttpClient/Cache/* were removed

No change log before this version