Bug: Documentation uses the deprecated webhooks type definition package
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
The readme for @actions/github uses the deprecated package @octokit/webhooks-definitions. The current type definition package is @octokit/webhooks-types.
To Reproduce
Steps to reproduce the behavior:
- Go to the readme linked above
Expected behavior
The current type definition package is used in the documentation
Screenshots
NA
Additional context
PR incoming
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
Open the @actions/github README at the webhooks payload TypeScript definitions section and compare its package reference with the linked @octokit/webhooks-types package. Update the documentation so it names the current type definition package, then verify that the deprecated @octokit/webhooks-definitions reference no longer appears there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100