NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #4376 most downloaded on npm
Generated TypeScript definitions based on community contributed JSON Schemas
Last release 2 years ago
no release in 18 months
Release timing varies
gaps range from 1 weeks to 5 months
Unknown
no stable releases
111 versions withdrawn
withdrawn after publishing
6 years old
111 releases · first in 2021
add missing property category.node_id to discussion and discussion_comment
One column per quarter.
schema: correct some schema IDs
7.5.0 (2024-04-03) Features security: Add provenance
…repository_import, repository_vulnerability_alert, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_job, workfl…
add "cancelled" as possible conclusion of a completed workflow step
declare pull_request auto_merge properties as string|null
examples: add GitHub Enterprise Server versions
add support for deployment_review event
new and updated payload examples with resulting schema changes ( #813 ) ( 9f7f7f3 ), closes #812
update wont_fix typo in secret_scanning_alert
mark action as required in secret_scanning_alert_location.created event
deps: update dependency @octokit/webhooks-types to v7
new deployment statuses for deyployment_status event
deyployment_status eventsecret_scanning_alertsecret_scanning_alert_location eventworkflow_job.waiting eventbranch_protection_rule.requested eventrequire_last_push_approval rule for branch_protection_rulequeued to possible statuses for workflow_job in workflow_job.in_progress eventpull_request.queued event was renamed to pull_request.enqueuedupdates to webhook event schemas
# 6.10.0 (2023-01-18) ### Features * new installation_target event
schema updates to workflow_job, organization.renamed events and common schemas
add schemas for registry_package event, update package event with new information
# 6.7.0 (2022-10-24) ### Features * GHAE: new project_card event
add new properties to merge_group event
add new schema for dependabot_alert event
dependabot_alert eventPullRequestReviewrepository object in payloadsdisplay_title property for workflow_runcve_id property for SecurityAdvisoryEventdisplay_title and path as requirednew pull_request.dequeued and pull_request.queued events
refactor BranchProtectionRule to have a common schema for the different rule types
correct enum values for required_conversation_resolution_level, add enum values for PullRequestReview#state
update schema descriptions for added, removed and modified files in commits (#695) (aed7be2), closes #691
update push payload descriptions
changes property can be undefined in branch_protection_rule#edited, add missing keys to changes property in branch_protection_rule#edited, new blockin
correct MergeGroupChecksRequestedEvent schema title
# 6.3.0 (2022-08-08) ### Features * new merge_group event
schemas: remove 'email' format for 'email' property in committer.schema.json
description updates for the check_suite event
add descriptions from GitHub REST API description, source_url property on package events is not a full URI
add App to the type property in the ping event, add workflow_job to App events, merge_commit_sha is not always null for pull_request.opened event
add new app events and permissions
refactor workflow_job.queued event to use the WorkflowJob common shema
update selector for payload examples
Add missing date-time format to time fields
GHES: add GHES 3.4 and 3.5, remove GHES 2.21, 2.22, 3.0
new properties on various schemas
add missing title to ProjectsV2Item schema, description updates
api.github.com: new projects_v2_item event, and some properties descriptions updates
add pull_request_review_thread examples
pull_request_review_thread examples (#619) (485e614)package (#619) (4571273)pull_request_review_thread event (#619) (0a397df)pull_request_review_thread event (#619) (eef5591)secret_scanning_alert from index.json (#619) (444cda4)waiting state to deployment_status, check_run and workflow_run event (#619) (b6d74df),skipped to workflow_run conclusion (#619) (6903932),pull_request property description on check_run event (#619) (3218b97)deps: update dependency @octokit/webhooks-types to v5
updates to repository_vulnerability_alert, check_suite, workflow_run, project, branch_protection_rule, pull_request.auto_merge_{enabled,disabled} even…
update payload examples from GitHub docs
updates to workflow_job, repository_vulnerability_alert, check_suite, deployment, deployment_status events
updates to deployment and deployment_status events, new deployment property for check_run event
new issues event example payloads
update event properties descriptions for changes in github docs URLs
new changes.base property on pull_request#edited, new merged_at property on issues common schema, new rerequestable property on check_suite#completed,
## 4.17.1 (2021-11-23) ### Bug Fixes * generate types for #594
new pull_request_review_thread event
new run_attempt, run_started_at and previous_attempt_url properties for workflow_run
keys permission for apps (#576) (579527c)run_attempt, run_started_at and previous_attempt_url properties for workflow_run (#576) (7012cb4)topics property for repository (#576) (831d811)run_attempt property on workflow_job (#576) (d87756f)allow_update_branch property on Repository (#576) (cb9d085)draft property on issue object (#576) (2dc3e74)visibility is a required field on repository (#576) (f03e1ba)repository is not always present for project_card events (#576) (06cd305)internal to allowed values for repository#visibility (#576) (5309b15)check_suite#after can be null (#576) (2281de8)branch_protection_rule event to App (#576) (4aa1c44)enum for App key permission (#576) (de51a73)api.github.com: description updates for properties of the workflow_job event
GHES: add new GHES versions 3.2 & 3.3
examples: description updates, updated payloads for workflow_job
examples: update descriptions for various events
feat: reactions property for pull_request_review_comment, issue_comment, issue, discussion, discussion_comment and release events
reactions property for pull_request_review_comment, issue_comment, issue, discussion, discussion_comment and release eventstransient_environment and production_environment properties for the deployment.created eventenvironment_url property for deplyment_status.created eventis_template property on repository common schemainstallation eventwebhooks-eventssecret property for the hook config on the meta.deleted eventdeliveries_url property to the ping eventrepository is not present when project_column is organization-widemembership is not always present in organization.deleted eventdescription updates for the push event for GHES and GitHub.AE
add/update descriptions for properties of the push event payload
Your coding agent can read these notes before it upgrades. Set up the MCP server →