@actions/GitHub - TypeScript Definition for WebHookPayload is limited
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Please can the WebHookPayload interface/type definition be updated to support more properties from GitHub Webhook/payloads such as Push event.
To get details about the commit/s and the files added, modified and deleted, which is useful for a linting tool to know which files to lint, as opposed to running it over an entire repository which could be quite slow if it contains lots of files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the TypeScript WebHookPayload interface or type definition and inspect how Push event payloads are represented. Compare the current definition with the GitHub webhook payload properties needed for commit details and added, modified, and deleted files. Done means those properties are represented for consumers such as linting tools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100