gradle / gradle/develocity-build-validation-scripts
Document CI automation for Build Validation Scripts
- Dominant language
- Shell
- Stars
- 115
- Forks
- 23
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 6
Description
A Build Validation Scripts best practice is to automate these to run in CI to proactively detect cache regressions. It would be good to document the approach as well as the best practices. The doc should include, but is not limited to:
- Which experiments to automate
- The cadence on which they should automate them
- How to do so (via `--fail-if-not-fully-cacheable`)
- Pointing users towards our GitHub Actions integration
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the repository's Build Validation Scripts documentation and GitHub Actions integration first. Identify the experiments and automation cadence that should be covered, explain use of --fail-if-not-fully-cacheable, and link users to the GitHub Actions integration. Done means the documented approach covers these points and gives users enough guidance to automate cache-regression checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, shell
- Domain
- build-system, ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100