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

Make verifyAndReceive accept a string name. #1056

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jyasskin
Copy link

As naturally comes from the relevant HTTP header.

Resolves the easy half of #1055


Before the change?

  • Callers have to do an unchecked cast from string to either any or the unexported WebhookEventName type.

After the change?

  • Callers can pass the HTTP header directly into verifyAndReceive()

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
    Kinda: I removed the cast from the middleware, so it'll break if the stricter type is re-introduced.
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
    This type constraint doesn't seem to have been documented.

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

As naturally comes from the relevant HTTP header.
Copy link
Contributor

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339
Copy link
Member

wolfy1339 commented Sep 20, 2024

The WebhookEventName is actually exported in the types.ts file.

import type { WebhookEventName } from "@octokit/webhooks/types";

Note: there is no file extension on the import path

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants