3c143286e1
Bumps the gradle group with 4 updates: [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit5), [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit5), [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit5) and [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit5). Updates `org.junit.jupiter:junit-jupiter-api` from 5.10.2 to 5.10.3 - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.10.2...r5.10.3) Updates `org.junit.jupiter:junit-jupiter-engine` from 5.10.2 to 5.10.3 - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.10.2...r5.10.3) Updates `org.junit.jupiter:junit-jupiter-params` from 5.10.2 to 5.10.3 - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.10.2...r5.10.3) Updates `org.junit.jupiter:junit-jupiter` from 5.10.2 to 5.10.3 - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/compare/r5.10.2...r5.10.3) --- updated-dependencies: - dependency-name: org.junit.jupiter:junit-jupiter-api dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gradle - dependency-name: org.junit.jupiter:junit-jupiter-engine dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gradle - dependency-name: org.junit.jupiter:junit-jupiter-params dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gradle - dependency-name: org.junit.jupiter:junit-jupiter dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gradle ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| README.md | ||
| build.gradle.kts | ||
| settings.gradle.kts | ||
| smithy-build.json | ||
README.md
Custom Validator Package
Use this package to create a custom model validator. This package can be included as a dependency in other Smithy projects to enforce API standards across multiple packages.
Building
To build this package run the following from the root of the package:
./gradlew clean build
This will generate a build directory containing the build artifacts generated by
gradle. The generated JAR file that should be used by downstream consumers can be
found at build/libs/custom-validator.jar
Customization
To customize this package, start by updating the settings.gradle.kts file and update
the rootProject.name property to the desired name of your package. Also update the
description at the top of the build.gradle.kts file.
Next, update the java class DocumentationClassValidator class to perform your desired validation.
Finally, update the io.smithy.examples.validators.DocumentationValidator entry in the
src/main/resources/META-INF/services/software.amazon.smithy.model.validation.Validator file to reflect the
new name and package of your updated validator.
Distribution
If you want to distribute the JAR file create by this package, consider adding the maven-publish plugin to the project to publish the JAR to a maven repository.