playfulprogramming / playfulprogramming/hoof
Report check status when importing from a pull request
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 9
- Forks
- 7
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
See: API endpoints for check runs (these should be available on the installation octokit client - will need to be added to the github-api exports)
Hoof should create a check run at the start of the WEBHOOK_PULL_REQUEST job, and hold onto the returned check ID while the jobs are completed.
If the sync jobs triggered by WEBHOOK_PULL_REQUEST fail for any reason, use the PATCH endpoint to update the run, and indicate e.g. "Failed to process posts/example" as the summary.
Contributor guide
No contributing guide indexed for this repository
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 with the WEBHOOK_PULL_REQUEST job and inspect the github-api exports, using the linked GitHub check-runs API documentation to identify the required endpoints. Done means the job creates a check run at the start, retains its check ID, and PATCHes a failure summary such as "Failed to process posts/example" when a sync job fails.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100