Skip to content

[4.x] Add pull request reviews and review requests - #68

Open
Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-github-pulls-reviews
Open

Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-github-pulls-reviews

Conversation

@Hackwar

@Hackwar Hackwar commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Part of bringing joomla/github up to the current GitHub REST API (phases 1–3 of the modernisation plan). Purely additive: no existing method changes signature or behaviour.

Adds two sub-packages of Pulls:

  • $github->pulls->reviews (Pulls\Reviews, 8 methods): getList, create, get, edit, delete, getListComments, dismiss, submit.
  • $github->pulls->reviewRequests (Pulls\ReviewRequests, 4 methods): getList, request, remove, rerequest.

src/Package/Pulls.php only gains the two @property-read lines.

Notes for review

  • The reviewer endpoints require "reviewers or team_reviewers"; they are explicit array $reviewers = [], array $teamReviewers = [] parameters, and empty lists are left out of the body.
  • Deleting a pending review returns the deleted review (200), so delete() returns an object.

How it was built

Generated from GitHub's official OpenAPI description (github/rest-api-description, api.github.com). Every non-deprecated operation of the category is covered; /enterprises/* endpoints are left out, as the library targets github.com.

Conventions shared by all package PRs: path parameters first, then required body fields, then array $options (optional body fields), array $filters (optional query parameters) and $page, $limit for paginated endpoints; free-form path segments are rawurlencode()d; create-or-update operations are called createOrUpdate…; 204 responses return nothing, 302 downloads return the Location URL, "check" endpoints return a boolean.

Testing Instructions

vendor/bin/phpunit: every new method has a success test (HTTP verb, exact URL and query, exact JSON body, return value) and a failure test. phpcs and phpstan report no errors.

26 new tests.

Documentation Changes Required

Adds docs/pulls-reviews.md. The link from docs/index.md is added together with all other new pages in #67.

🤖 Generated with Claude Code

Adds the Pulls\Reviews sub-package (list, create, get, update, delete
pending, list comments, dismiss and submit reviews) and the
Pulls\ReviewRequests sub-package (list, request, remove and re-request
reviewers), with tests and docs/pulls-reviews.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

1 participant