Improve deployment webhook reliability and testability in doc projects
Open
Nobody has claimed this yet.
internal
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Deployment webhooks sent to tarantool.io can sometimes fail. We should improve the way we handle them in all doc projects, like it's already done in tarantool/doc.
- Run the deployment webhook in a separate CI step, not as part of
upload_output.sh. - Extract webhooks to files in
./webhooks/*.sh. - Add an environment file for testing webhooks.
- Retry deployment webhooks with actions/retry-step
- Print log messages from webhooks.
Affected repositories and branches:
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
Use the existing tarantool/doc implementation as the reference, then inspect upload_output.sh and the CI configuration on each listed repository and branch. Move webhook handling into ./webhooks/*.sh, add the testing environment file, configure the retry action and logging, and run the affected CI workflows to verify deployment webhooks are separate, retryable, and testable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, shell
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100