1. Script execution detection in matrix-generator.js -
Added fileURLToPath import and updated comparison
2. Script execution detection in incremental-validator.js -
Added fileURLToPath import and updated comparison
3. Script execution detection in link-extractor.js - Added
fileURLToPath import and updated comparison
4. Script execution detection in comment-generator.js -
Added fileURLToPath import and updated comparison
Medium Priority Issues (Fixed):
5. Extracted duplicated URL transformation logic - Created
shared utility module and updated both files to use it
6. Fixed cache key strategy - Updated GitHub workflow to
use content-based hashing instead of base SHA
Changes Made:
- 4 JavaScript files: Updated with robust script execution
detection using fileURLToPath
- 1 utility module: Created
/.github/scripts/utils/url-transformer.js for shared logic
- 2 files: Updated to use the shared URL transformation
utility
- 1 workflow file: Improved cache key strategy for better
cache hit rates
- Add GitHub Actions for automated link validation on PRs
- Implement incremental validation with caching (30-day TTL, configurable)
- Add matrix generator for parallel validation strategy
- Create comprehensive TESTING.md documentation
- Add cache manager with configurable TTL via env var or CLI
- Implement smart link extraction and validation
- Add PR comment generator for broken link reports
- Update Cypress tests to use incremental validation
- Consolidate testing docs from CONTRIBUTING.md to TESTING.md
Key improvements:
- Cache-aware validation only checks changed content
- Parallel execution for large changesets
- Detailed PR comments with broken link reports
- Support for LINK_CACHE_TTL_DAYS env var
- Local testing with yarn test:links
- Reduced false positives through intelligent caching
helper-scripts directory to:
1. Main helper-scripts/README.md:
Updated to describe
generate-release-notes.js instead of
the old bash script, including new
configuration options and examples.
2. helper-scripts/common/README.md:
Updated to describe the JavaScript
version with all its new features like
configuration files,
integrated/separated formats, and PR
link options.
3. helper-scripts/influxdb3-monolith/RE
ADME.md: Completely updated to reflect
the actual JavaScript scripts present
(audit-cli-documentation.js and
apply-cli-patches.js) instead of the
non-existent bash scripts, updated
prerequisites, examples, and workflow
documentation.
scripts
- Supports special case for local development mode
- Provides helpful error messages with available tags
- Can be used as CLI tool or imported module
Now you can run specific audits directly:
# Run specific audits
gh act workflow_dispatch -j cli-3-enterprise
gh act workflow_dispatch -j cli-3-core
gh act workflow_dispatch -j api-3-cloud-dedicated
# Run with custom version
gh act workflow_dispatch -j cli-3-enterprise --input
version=3.1.0
# Run all audits (scheduled behavior)
gh act workflow_dispatch
Jason Stirnaman