Skip to content
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.

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

🤖📯 Octokit webhooks changed #751

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

🤖📯 Octokit webhooks changed #751

wants to merge 221 commits into from

Conversation

octokitbot
Copy link
Collaborator

I found new changes on GitHub’s Webhooks Event Types & Payloads and want to let you know about it 👋🤖

I can't tell if the changes are fixes, features or breaking changes. You'll have to figure that out on yourself and adapt the commit messages accordingly to trigger the right release, see our commit message conventions.
If there are any new events added, follow the steps outlined in order to create the required schemas.
If there were only description updates, or new properties added, simply modify the appropriate schemas and commit them to this PR. Don't forget to generate the types as well.

@octokitbot octokitbot added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Dec 15, 2022
Copy link
Member

@wolfy1339 wolfy1339 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs format has changed, the script needs to be updated to try to restore the most functionality

@wolfy1339
Copy link
Member

With the changes to the docs, there are no longer any example payloads available.

I think the automatic updater should be retired, and a new script that opens an issue when a new event is found be put in it's place instead.

I believe this would be the best going forward until #470 is resolved

@wolfy1339
Copy link
Member

According to github/docs#22726, the payloads will eventually get restored. They have an internal issue tracking this.

@gr2m
Copy link
Contributor

gr2m commented Feb 6, 2025

@wolfy1339 this PR is way outdated and can be closed, right? Webhooks schemas are now derived from the OpenAPI spec?

@wolfy1339
Copy link
Member

The update workflow has been broken ever since the GitHub docs switched over to OpenAPI for Webhooks.
I did manage to actually get some updates going.
Probot is close to complete for the new version that switches to OpenAPI, so this repository can be archived when that is done

@gr2m
Copy link
Contributor

gr2m commented Feb 6, 2025

Probot is close to complete for the new version that switches to OpenAPI, so this repository can be archived when that is done

Ahh, types for webhooks are now generated directly in https://github.com/octokit/webhooks.js, right?

I think it might still make seens to keep this repository and make it work again in order to support webhook types for the GHES and GHEC. Basically replicate the setup we have for the REST API methods

@wolfy1339
Copy link
Member

Types for webhooks are generated either in this repository or https://github.com/octokit/openapi-webhooks

Starting with @octokit/webhooks v13 it uses the OpenAPI spec.

Probot currently is on v12

@wolfy1339
Copy link
Member

Since we lost the payloads from the docs, the update script has lost some of it's purpose. It can only return the listed properties

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

4 participants