Skip to content

[4.x] Add the Secret Scanning API package - #84

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

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

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 $github->secretScanning (alerts, alert locations, push-protection bypasses, scan history) with secretScanning->customPatterns and secretScanning->pushProtection (17 operations).

Notes for review

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.

36 new tests.

Documentation Changes Required

Adds docs/secret-scanning.md. The @property-read line in Github.php and the link from docs/index.md are added together for all new packages in #67, to keep these PRs from conflicting with each other.

🤖 Generated with Claude Code

Adds $github->secretScanning (alerts, alert locations, push protection
bypasses, scan history) with the sub-packages customPatterns and
pushProtection, covering every non-enterprise operation of the
secret-scanning REST category, with tests and docs.

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