diff --git a/README.md b/README.md index 57a50b3..eed9c8f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
-# Validates Gradle Wrapper JARs +# Gradle Wrapper Validation Action This action validates the checksums of [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) JAR files present in the source tree and fails if unknown Gradle Wrapper JAR files are found. @@ -39,7 +39,23 @@ If any are found that do not match the SHA-256 checksums of our official release Simply add this action to your workflow **after** having checked out your source tree and **before** running any Gradle build: ```yaml -uses: eskatos/gradle-wrapper-check@releases/v1 +uses: gradle/wrapper-validation-action@releases/v1 +``` + +Here's a sample complete workflow you can add to your repositories: + +**`.github/workflows/gradle-wrapper-validation.yml`** +```yaml +name: "Validate Gradle Wrapper" +on: [push, pull_request] + +jobs: + validation: + name: "Validation" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: eskatos/gradle-wrapper-check@releases/v1 ``` ## Reporting Failures diff --git a/action.yml b/action.yml index 5cc5eeb..c3c843a 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ -name: 'Gradle Wrapper Check' -description: 'Check Gradle Wrapper Files' +name: 'Gradle Wrapper Validation' +description: 'Validates Gradle Wrapper JAR Files' author: 'Gradle' inputs: allow-snapshots: