chore(infra): add link checker, deploy manifest, error docs, and back… - #816
Open
wavyboy-build wants to merge 1 commit into
Open
wavyboy-build wants to merge 1 commit into
wavyboy-build wants to merge 1 commit into
Conversation
|
@wavyboy-build Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses a batch of four infrastructure and documentation improvements. It hardens our CI pipeline against broken links, standardizes our deployment outputs, improves developer onboarding with a new contract error reference, and makes the notification retry system safely configurable.
Key Changes
Automated Link Checker (.github/workflows/link-checker.yml): Integrated a Markdown link scanning workflow (e.g., Lychee/markdown-link-check) that fails CI on broken internal repository links but gracefully warns on external HTTP timeouts to prevent fragile builds. Added local execution instructions to the developer guide.
Deployment Manifest (scripts/deploy.ts): Updated the contract deployment routine to securely emit a deployment-manifest.json. The manifest strictly records the contract identifier, network info, and timestamp while stripping all sensitive environment variables and private keys.
Contract Error Reference (docs/contract-errors.md): Extracted all public smart contract errors into a single reference document. Each entry maps the error identifier to its plain-English meaning, triggering conditions, and expected caller remediation.
Configurable Retry Backoff (lib/notifications/): Decoupled the retry backoff parameters from the notification provider implementation. Added strict validation (using Zod/schema validation) to reject negative delays, enforce a hard upper bound on maximum wait times, and guarantee bounded retry loops. Added comprehensive unit tests covering the new configuration boundaries.
closes #707
closes #710
closes #716
closes #720