feat: use new types from @octokit/webhooks-definitions

[G-Rath]

Here it is 🎉

There's a few things to polish off and discuss before landing this, but the bulk of it is done so making the PR now.

• we're missing some events in our schema definitions.
• I've done a big rename of the types so that they're more accurate (have exported the renamed types under their old names too to be less breaking).
• I've improved the types in places so that they're accurate
• have refactored the type generation script into TS - happy to move it back to JS, or to convert the other scripts into TS
  • I tried originally trying to build the type via types, but it's just too hard (if at all possible) - you can get close with 4.1 features, but even then it's a lot of work for TS to do meaning IDE autocompletion suffers vs us just generating a static type
• probably something else I've forgotten to mention 😅

I'm breaking some things out into their own little PRs where possible.

[G-Rath]

I think we're good to go - note this'll be rebased at least twice when I merge in #403 & #410, so approves won't stick until then

While I've marked everything in the old generated payloads as deprecated, I'd like to delete them asap.
Also, there's probably a couple of redundant type aliases in there that could be cleaned up, but shouldn't be a big deal if that happens later.

[oscard0m]

I don't feel confident enough to give an approval but, for what I read, everything looks good to me :)

[gr2m]

While I've marked everything in the old generated payloads as deprecated, I'd like to delete them asap.

Should these deprecations be part of this PR or did they already happen?

@octokit/webhooks has several deprecated APIs, we can cut a breaking release anytime and get rid of them all at once.

[G-Rath]

I've pinned the version constraint for @octokit/webhooks-definitions to be an exact version, and updated the update workflow to update the constraint with the latest version.

The reason for this is that otherwise it can be updated by anything that regenerates the lockfile, which we've got renovate doing every week, but we need to make sure generate-types is run every time the version of this package changes which won't happen so it's PRs will always fail CI.

[gr2m]

My understanding is that we can merge this in as a feature release, as it does not introduce any breaking changes? If so, +1 for merging from me. Otherwise please let me know what the breaking changes are. If breaking changes are TypeScript types only we can release a feature release, I don't consider TypeScript type changes breaking changes as they don't affect production code, they only occur at build time

[G-Rath]

Alright, let's do this! we can fix up any issues in post 😎

[G-Rath]

Error: src/event-handler/index.ts(10,17): error TS4058: Return type of exported function has or is using name 'BaseWebhookEvent' from external module "/home/runner/work/webhooks.js/webhooks.js/src/types" but cannot be named.

well, that's odd. I'll see if I can figure out what's going wrong.

[G-Rath]

I know why this is breaking - will have a PR up shortly

[github-actions]

🎉 This PR is included in version 7.22.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀