Initial commit
Some checks failed
CI-integ-test-full / caching-integ-tests (push) Failing after 32s
CI-integ-test-full / other-integ-tests (push) Failing after 29m15s
Update Wrapper checksums file / Update checksums (push) Failing after 3m7s
CI-codeql / Analyze (javascript-typescript) (push) Failing after 10m7s
Some checks failed
CI-integ-test-full / caching-integ-tests (push) Failing after 32s
CI-integ-test-full / other-integ-tests (push) Failing after 29m15s
Update Wrapper checksums file / Update checksums (push) Failing after 3m7s
CI-codeql / Analyze (javascript-typescript) (push) Failing after 10m7s
This commit is contained in:
31
wrapper-validation/README.md
Normal file
31
wrapper-validation/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
## 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`.
|
||||
|
||||
> [!NOTE]
|
||||
> Starting with v4 the `setup-gradle` action will automatically [perform wrapper validation](../docs/setup-gradle.md#gradle-wrapper-validation)
|
||||
> on each execution.
|
||||
>
|
||||
> If you are using `setup-gradle` in your workflows, it is unlikely that you will need to use the `wrapper-validation` action.
|
||||
|
||||
### 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@v4
|
||||
```
|
||||
|
||||
See the [full action documentation](../docs/wrapper-validation.md) for more advanced usage scenarios.
|
||||
29
wrapper-validation/action.yml
Normal file
29
wrapper-validation/action.yml
Normal file
@@ -0,0 +1,29 @@
|
||||
name: 'Gradle Wrapper Validation'
|
||||
description: 'Validates Gradle Wrapper JAR Files'
|
||||
author: 'Gradle'
|
||||
|
||||
inputs:
|
||||
min-wrapper-count:
|
||||
description: 'Minimum number expected gradle-wrapper.jar files found in the repository. Non-negative number. Higher number is useful in monorepos where each project might have their own wrapper.'
|
||||
required: false
|
||||
default: '1'
|
||||
allow-snapshots:
|
||||
description: 'Allow Gradle snapshot versions during checksum verification. Boolean, true or false.'
|
||||
required: false
|
||||
default: 'false'
|
||||
allow-checksums:
|
||||
description: 'Accept arbitrary user-defined checksums as valid. Comma separated list of SHA256 checksums (lowercase hex).'
|
||||
required: false
|
||||
default: ''
|
||||
|
||||
outputs:
|
||||
failed-wrapper:
|
||||
description: 'The path of the Gradle Wrapper(s) JAR that failed validation. Path is a platform-dependent relative path to git repository root. Multiple paths are separated by a | character.'
|
||||
|
||||
runs:
|
||||
using: 'node20'
|
||||
main: '../dist/wrapper-validation/main/index.js'
|
||||
|
||||
branding:
|
||||
icon: 'shield'
|
||||
color: gray-dark
|
||||
Reference in New Issue
Block a user