@octokit/webhooks-definitions
Advanced tools
Comparing version 3.53.3 to 3.53.4
{ | ||
"name": "@octokit/webhooks-definitions", | ||
"version": "3.53.3", | ||
"version": "3.53.4", | ||
"description": "machine-readable, always up-to-date GitHub Webhooks specifications", | ||
@@ -5,0 +5,0 @@ "keywords": [], |
@@ -9,3 +9,4 @@ # Octokit Webhooks | ||
Download the latest specification at [octokit.github.io/webhooks/index.json](https://octokit.github.io/webhooks/index.json) | ||
Download the latest specification at | ||
[octokit.github.io/webhooks/index.json](https://octokit.github.io/webhooks/index.json) | ||
@@ -231,3 +232,4 @@ ## Example | ||
You can download the latest `index.json` and `schema.json` files from [unpkg](https://unpkg.com/browse/@octokit/webhooks-definitions@3.24.0/) | ||
You can download the latest `index.json` and `schema.json` files from | ||
[unpkg](https://unpkg.com/browse/@octokit/webhooks-definitions@3.24.0/) | ||
@@ -261,3 +263,4 @@ - [`index.json`](https://unpkg.com/@octokit/webhooks-definitions/index.json) | ||
This package ships with types for the webhook events generated from the respective json schemas, which you can use like so: | ||
This package ships with types for the webhook events generated from the | ||
respective json schemas, which you can use like so: | ||
@@ -285,14 +288,25 @@ ```typescript | ||
This package updates itself using a daily cronjob running on GitHub Actions. The [`index.json`](index.json) file is generated by [`bin/octokit-webhooks.ts`](bin/octokit-webhooks.ts). Run `npm run octokit-webhooks -- --usage` for instructions. After the update is complete, run `npm run build:webhooks` and `npm run build:schema` to update `index.json` and `schema.json` files. | ||
This package updates itself using a daily cronjob running on GitHub Actions. The | ||
[`index.json`](index.json) file is generated by | ||
[`bin/octokit-webhooks.ts`](bin/octokit-webhooks.ts). Run | ||
`npm run octokit-webhooks -- --usage` for instructions. After the update is | ||
complete, run `npm run build:webhooks` and `npm run build:schema` to update | ||
`index.json` and `schema.json` files. | ||
The update script is scraping [GitHub’s Webhooks Event Types & Payloads](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads) documentation page and extracts the meta information using [cheerio](https://www.npmjs.com/package/cheerio). | ||
The update script is scraping | ||
[GitHub’s Webhooks Event Types & Payloads](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads) | ||
documentation page and extracts the meta information using | ||
[cheerio](https://www.npmjs.com/package/cheerio). | ||
For simpler local testing and tracking of changes all loaded pages are cached | ||
in the [`cache/`](cache/) folder. | ||
For simpler local testing and tracking of changes all loaded pages are cached in | ||
the [`cache/`](cache/) folder. | ||
## See also | ||
- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s GraphQL Schema with validation | ||
- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route specifications | ||
- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub App permission specifications | ||
- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s | ||
GraphQL Schema with validation | ||
- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route | ||
specifications | ||
- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub | ||
App permission specifications | ||
@@ -299,0 +313,0 @@ ## LICENSE |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
312
3858541
75242