Skip to content

fix: update ref to deprecated package #2089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: update ref to deprecated package #2089

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09fbea2
fix: update ref to deprecated package
GauBen Jun 16, 2025
733915a
type import
GauBen Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ const newIssue = await octokit.rest.issues.create({

## Webhook payload typescript definitions

The npm module `@octokit/webhooks-definitions` provides type definitions for the response payloads. You can cast the payload to these types for better type information.
The npm module `@octokit/webhooks-types` provides type definitions for the response payloads. You can cast the payload to these types for better type information.

First, install the npm module `npm install @octokit/webhooks-definitions`
First, install the npm module `npm install @octokit/webhooks-types`

Then, assert the type based on the eventName
```ts
import * as core from '@actions/core'
import * as github from '@actions/github'
import {PushEvent} from '@octokit/webhooks-definitions/schema'
import {PushEvent} from '@octokit/webhooks-types'

if (github.context.eventName === 'push') {
const pushPayload = github.context.payload as PushEvent
Expand Down