From 069c6913e55f2ffbf4870705c2ccbe688daccf97 Mon Sep 17 00:00:00 2001 From: hiroki osame Date: Sat, 14 Aug 2021 01:02:25 -0400 Subject: [PATCH] docs: update deprecated types package Update deprecated @octokit/webhooks-definitions to @octokit/webhooks-definitions --- packages/github/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/github/README.md b/packages/github/README.md index 30e6a68e..b271864a 100644 --- a/packages/github/README.md +++ b/packages/github/README.md @@ -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`](https://github.com/octokit/webhooks/tree/master/payload-types#readme) 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 type {PushEvent} from '@octokit/webhooks-types' if (github.context.eventName === 'push') { const pushPayload = github.context.payload as PushEvent