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
Use enums for the action field in GitHub Webhooks #3127
Comments
If you agree, I can make this change |
That seems safe to me. |
nice, will send a PR your way! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Issue Description:
Many GitHub webhooks contain the action field, which is enumerated. For example, in the GitHub documentation for webhook payloads and events, the check_run event includes an action property that can take on values such as "completed", "created", "requested_action", and "rerequested". However, in the library, these fields are currently represented as free-form strings. In my opinion, making these enums would be more user-friendly.
Proposed Solution
A rudimentary example of how this can be done is as follows (go play ground link)
The text was updated successfully, but these errors were encountered: