Case study
Linux Foundation Hyperledger Fabric
Fixed Fabric's documentation link checker: regexes, response limit, and timeout. Revised the patch after maintainer review; merged upstream.
By Mishal ShanavasUpdated
- What was going on
- Fabric runs a scheduled workflow to check links across several documentation versions. Its regexes and workflow settings meant some checks were not doing what they appeared to do.
- What I did
- I corrected the regexes and job names, reduced the response buffer, and added timeouts. A maintainer caught an exclusion that was too broad; I tested the edge case and narrowed it.
- How it turned out
- The revised patch was merged upstream. The review was a good reminder that a link checker is only useful if its exclusions are as carefully tested as its matches.
Technical details
- Corrected version, hostname, and character-range regexes without hiding valid documentation links.
- Reduced an INT32_MAX response buffer to a practical limit and added a 45-minute job timeout based on observed runs.
- Responded to maintainer review by narrowing an over-broad exclusion before the change was merged upstream.
GoGitHub ActionsCI/CDHyperledger Fabric