Skip to content

Releases

v2026.3.10.3

Choose a tag to compare

@github-actions github-actions released this 15 Nov 07:53
3e8108a

This release adds the issues / status_changed webhook event and an issue status field on issue payloads. Existing code that builds issue records by hand or switches exhaustively over issue events needs small changes.

⚠️ Breaking changes

  • New issues event in the sealed hierarchy: GitHubWebhookIssuesEvent now also permits GitHubWebhookIssuesStatusChangedEvent. An exhaustive switch over GitHubWebhookIssuesEvent without a default no longer compiles. Add a case GitHubWebhookIssuesStatusChangedEvent e branch.
  • status component added to issue records: GitHubWebhookIssue (in common and in issues), GitHubWebhookIssuesClosedIssue, GitHubWebhookIssuesOpenedIssue, GitHubWebhookIssuesTransferredChangesNewIssue and the other per-action issue records gained @Nullable GitHubWebhookIssueStatus status in the middle of the component list. Code that calls their canonical constructors directly (mostly tests and fixtures) must pass the new argument, null if there is no status. Records decoded from webhooks are not affected.

✨ What's new

  • Issue status events: the decoder now handles issues events with action status_changed and returns GitHubWebhookIssuesStatusChangedEvent. It carries status (the new status) and changes. changes.status().from() is the previous status or null. changes.state() and changes.stateReason() are set only when the change also closed or reopened the issue, or changed the close reason. Available in cloud and GHEC.
  • GitHubWebhookIssueStatus: new record with category, id and name, available as issue.status() on every issue payload. It is null when the issue has no status. Issue statuses are a GitHub preview feature, so only accounts enrolled in the preview receive them.

🔧 Improvements

  • Updated to common-core 7. The webhook JSON mapper is now built on the shared JsonMappers.snakeCase() base and behaves as before. Unknown enum constants still read as null, and a JSON string is still read into a collection property as a collection of one.

Full Changelog: v2026.3.10.2...v2026.3.10.3

v2026.3.10.2

Choose a tag to compare

@github-actions github-actions released this 07 Nov 10:41
94140a3

This release applies the latest webhook spec sync, types dates and ids, replaces the secret-scanning location details with one record, and moves the library onto common-core. Upgrading needs code changes if you read dates, ids or secret-scanning location details, or declare the old common-* modules.

⚠️ Breaking changes

  • Dependencies: common-util and common-json are replaced by common-core. If your module-info.java has requires common.util or common.json, use requires common.core. The old artifacts no longer arrive transitively.
  • Dates are now typed: 168 payload fields changed from String to Instant (167, for example GitHubWebhookCodeScanningAlertCreatedAlert.updatedAt and GitHubWebhookCodeScanningAlertReopenedAlert.dismissedAt) or OffsetDateTime (GitHubWebhookSimpleCommit.timestamp). Use the value directly, or call toString() for the old text.
  • Ids are now long: 11 components changed from double to long, for example GitHubWebhookProjectsV2Project.id and GitHubWebhookProjectsV2StatusUpdate.id. 16 changed from Double to Long, for example GitHubWebhookIssueDependenciesBlockedByAddedEvent.blockedIssueId and blockingIssueId.
  • Secret scanning location details: GitHubWebhookSecretScanningAlertLocationCreatedLocationDetails was a sealed interface with 13 per-location records (...DetailsBlobUrl, ...DetailsPageUrl, ...DetailsIssueTitleUrl and so on). It is now one record with nullable components (blobUrl, pageUrl, issueTitleUrl, path, startLine and so on). Replace the switch or instanceof on the old records with null checks on the components. The 13 old record types are removed.

✨ What's new

  • Actions log secret scans: GitHubWebhookSecretScanningAlertLocationCreatedLocationType has ACTIONS_LOG.
  • Custom property regex: GitHubWebhookOrganizationCustomProperty has a regex component, so its constructor changed.

Full Changelog: v2026.3.10.1...v2026.3.10.2

v2026.3.10.1

Choose a tag to compare

@github-actions github-actions released this 03 Nov 07:35
08c435a

This release syncs the webhook models with the latest GitHub OpenAPI descriptions and adds the secret_scanning_public_monitoring_alert event family. Upgrading needs code changes if you reference the enum fallback constant UNKNOWN or one of the renamed types below.

⚠️ Breaking changes

  • Enum fallback renamed: the fallback constant of 175 webhook enums changed from UNKNOWN (wire value "unknown") to UNRECOGNIZED (wire value "unrecognized"), for example GitHubWebhookCreateRefType and GitHubWebhookProjectsV2ItemContentType. Migrate GitHubWebhookCreateRefType.UNKNOWN → GitHubWebhookCreateRefType.UNRECOGNIZED in switch branches and comparisons. fromWire returns UNRECOGNIZED for a value the library does not know.
  • Exemption request metadata renamed: GitHubWebhookSecretScanningPushProtectionExemptionRequestMetadata → GitHubWebhookExemptionRequestMetadata and its ...MetadataReason enum → GitHubWebhookExemptionRequestMetadataReason. This changes the type of metadata in GitHubWebhookExemptionRequest.
  • Secret scanning alert validity renamed: GitHubWebhookSecretScanningAlertCreatedAlertValidity → GitHubWebhookPublicMonitoringAlertWebhookValidity. This changes the type of validity in GitHubWebhookSecretScanningAlertCreatedAlert.
  • Label type replaced: GitHubWebhookIssuesEditedLabel is removed and GitHubWebhookPullRequestLabeledLabel takes its place, with the same components. It is the type of label or labels in the discussion, issue labeled, unlabeled and edited, label created, deleted, edited and unarchived, and pull request labeled and unlabeled events and their payloads (for example GitHubWebhookDiscussionLabeledEvent, GitHubWebhookLabelCreatedEvent, GitHubWebhookPullRequestLabeledPullRequest).
  • Issue labels retyped: labels in GitHubWebhookIssue, GitHubWebhookIssuesClosedIssue, GitHubWebhookIssuesEditedIssue, GitHubWebhookIssuesPinnedIssue and GitHubWebhookIssuesReopenedIssue changed from List<GitHubWebhookLabel> to List<GitHubWebhookPullRequestLabeledLabel>. Update code that reads these labels as GitHubWebhookLabel.
  • Rule parameter records gained components: GitHubWebhookFilePathRestrictionParameters and GitHubWebhookMaxFileSizeParameters gained a nullable ignoredFilePaths list, and GitHubWebhookPullRequestParameters gained a nullable requireExtraApprovalForUnattributedChanges. They are trailing components, so constructor calls need one more argument (null keeps the old behavior); code that only reads webhooks is not affected.
  • Transferred issue has its own type: the newIssue component of GitHubWebhookIssuesTransferredChanges changed from GitHubWebhookIssuesPinnedIssue to the new GitHubWebhookIssuesTransferredChangesNewIssue. Update variable and method signatures that use the old type.
  • New event type in the sealed GitHubWebhookEvent: GitHubWebhookSecretScanningPublicMonitoringAlertEvent is a new permitted subtype, so an exhaustive switch over GitHubWebhookEvent without a default branch no longer compiles. Add a case for it (see What's new).

✨ What's new

  • Secret scanning public monitoring alerts: the secret_scanning_public_monitoring_alert webhook is now parsed into GitHubWebhookSecretScanningPublicMonitoringAlertEvent, with one record per action (created, dismissed, reopened, validated) and GitHubWebhookSecretScanningPublicMonitoringAlertUnknownActionEvent for any other action. The alert is GitHubWebhookPublicMonitoringAlertWebhook, including where the secret was found. GHEC only. The new package ...webhook.secretscanningpublicmonitoringalert is exported and opened in module-info.
  • Dependabot reachability: GitHubWebhookDependabotAlertFixedAlert has a new reachability component (GitHubWebhookDependabotAlertFixedAlertReachability with a verdict and an optional reason). Because it is a new record component, its canonical constructor changed; this is a response record, so code that only reads webhooks is not affected.

Full Changelog: v2026.3.10.0...v2026.3.10.1

v2026.3.10.0

Choose a tag to compare

@github-actions github-actions released this 30 Oct 17:32
405371c

What's Changed

  • feat: initial import of the typed GitHub webhook events, decoder and receiver by @piotr-janczukowicz in #1

New Contributors

Full Changelog: https://github.com/piotr-janczukowicz/github-webhook/commits/v2026.3.10.0