Add docs for wrapper-validation action

This commit is contained in:
daz
2024-04-11 09:04:13 -06:00
parent 39cecc54d0
commit fa4107aefb
3 changed files with 151 additions and 0 deletions

View File

@@ -69,3 +69,26 @@ jobs:
```
See the [full action documentation](docs/dependency-submission.md) for more advanced usage scenarios.
## The `wrapper-validation` action
The `wrapper-validation` action validates the checksums of _all_ [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) JAR files present in the repository and fails if any unknown Gradle Wrapper JAR files are found.
The action should be run in the root of the repository, as it will recursively search for any files named `gradle-wrapper.jar`.
### Example workflow
```yaml
name: "Validate Gradle Wrapper"
on: [push, pull_request]
jobs:
validation:
name: "Validation"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gradle/actions/wrapper-validation@v3
```
See the [full action documentation](docs/wrapper-validation.md) for more advanced usage scenarios.