Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chkpnt committed Jan 24, 2022
1 parent 237cb45 commit 8e591ba
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ A `TrustStoreSpec` consists the following settings:

The function `checkCertificates` takes a `CheckCertsSpec`, consisting of the following settings:

| Setting | Description | Default | Type |
|----------------------------------|--------------------------------------------------------------|--------------------------------------|---------------------|
| source(directory: Any*) | The directory which is scanned for certificates and bundles. | $projectDir/src/main/certs | function |
| include(vararg patterns: String) | Filter for the source directory. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function |
| exclude(vararg patterns: String) | Exclusions for the source directory. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function |
| atLeastValidDays | Number of days the certificates have to be at least valid. | 90 | Property\<Int\> |
| checkEnabled | Should the `check`-task depend on `checkCertificates<Name>`? | true | Property\<Boolean\> |
| Setting | Description | Default | Type |
|----------------------------------|--------------------------------------------------------------------|--------------------------------------|---------------------|
| source(directory: Any*) | The directory which is scanned for certificates and bundles. | $projectDir/src/main/certs | function |
| include(vararg patterns: String) | Filter for the source directory, can be called multiple times. | ['**/*.crt', '**/*.cer', '**/*.pem'] | function |
| exclude(vararg patterns: String) | Exclusions for the source directory, can be called multiple times. | [] | function |
| atLeastValidDays | Number of days the certificates have to be at least valid. | 90 | Property\<Int\> |
| checkEnabled | Should the `check`-task depend on `checkCertificates`? | true | Property\<Boolean\> |

_\* Anything, that can be handled by [project.file(...)](https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#org.gradle.api.Project:file%28java.lang.Object%29)._

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,17 @@ class CheckCertsSpec(private val project: Project) {
}

/**
* Filter for the source directory.
* Filter for the source directory, can be called multiple times.
*
* Defaults to ['**&#47;*.crt', '**&#47;*.cer', '**&#47;*.pem'].
*/
fun include(vararg patterns: String) {
includes.addAll(patterns.toList())
}

/**
* Exclusions for the source directory.
* Exclusions for the source directory, can be called multiple times.
*
* Defaults to [].
*/
fun exclude(vararg patterns: String) {
Expand Down

0 comments on commit 8e591ba

Please sign in to comment.