From 8f927e46cc6b40c8dd4408b967062d37d1241ebf Mon Sep 17 00:00:00 2001 From: Jake Wharton Date: Mon, 13 Nov 2023 10:58:44 -0500 Subject: [PATCH] Prepare version 0.5.0 --- CHANGELOG.md | 11 ++- README.md | 100 ++++++++++++----------- src/main/kotlin/watch/dependency/main.kt | 1 + 3 files changed, 63 insertions(+), 49 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 832bd04..ce4108e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ ## [Unreleased] +## [0.5.0] - 2023-11-13 + +### Added + + - The 'await' command will now display the date and time when the Maven repos were last checked. This + will only be displayed for interactive terminals, and can be disabled with `-q`/`--quiet` flag. + + ## [0.4.1] - 2022-02-03 ### Fixed @@ -52,7 +60,8 @@ - Initial release -[Unreleased]: https://github.com/JakeWharton/dependency-watch/compare/0.4.1...HEAD +[Unreleased]: https://github.com/JakeWharton/dependency-watch/compare/0.5.0...HEAD +[0.5.0]: https://github.com/JakeWharton/dependency-watch/releases/tag/0.5.0 [0.4.1]: https://github.com/JakeWharton/dependency-watch/releases/tag/0.4.1 [0.4.0]: https://github.com/JakeWharton/dependency-watch/releases/tag/0.4.0 [0.3.0]: https://github.com/JakeWharton/dependency-watch/releases/tag/0.3.0 diff --git a/README.md b/README.md index dacceeb..9ce3e37 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ the ID to the container using the `HEALTHCHECK_ID` environment variable. version: '2' services: dependency-watch: - image: jakewharton/dependency-watch:0.4 + image: jakewharton/dependency-watch:0.5 restart: unless-stopped volumes: - /path/to/config:/config @@ -118,76 +118,80 @@ services: ``` $ dependency-watch --help -Usage: dependency-watch [OPTIONS] COMMAND [ARGS]... +Usage: dependency-watch [] []... Options: -h, --help Show this message and exit Commands: - await Wait for an artifact to appear on Maven central then exit - notify Monitor Maven coordinates for new versions + await Wait for an artifact to appear in a Maven repository then exit + notify Monitor Maven coordinates in a Maven repository for new versions ``` ``` $ dependency-watch await --help -Usage: dependency-watch await [OPTIONS] COORDINATES +Usage: dependency-watch await [] Wait for an artifact to appear in a Maven repository then exit Options: - --interval DURATION Amount of time between checks in ISO8601 duration - format (default 1 minute) - --ifttt URL IFTTT webhook URL to trigger (see - https://ifttt.com/maker_webhooks) - --repo URL URL or well-known ID of maven repository to check - (default is "MavenCentral"). Available well-known IDs: - "MavenCentral", "GoogleMaven". - -h, --help Show this message and exit + --interval= Amount of time between checks in ISO8601 duration + format (default 1 minute) + --ifttt= IFTTT webhook URL to trigger (see + https://ifttt.com/maker_webhooks) + --repo= URL or well-known ID of maven repository to check + (default is "MavenCentral"). Available well-known IDs: + "MavenCentral", "GoogleMaven". + + -q, --quiet Hide 'Last checked' output + -h, --help Show this message and exit Arguments: - COORDINATES Maven coordinates (e.g., 'com.example:example:1.0.0') + Maven coordinates (e.g., 'com.example:example:1.0.0') ``` ``` $ dependency-watch notify --help -Usage: dependency-watch notify [OPTIONS] CONFIG +Usage: dependency-watch notify [] Monitor Maven coordinates in a Maven repository for new versions Options: - --interval DURATION Amount of time between checks in ISO8601 duration - format (default 1 minute) - --ifttt URL IFTTT webhook URL to trigger (see - https://ifttt.com/maker_webhooks) - --data PATH Directory into which already-seen versions are tracked - (default in-memory) - --watch Continually monitor for new versions every '--interval' - -h, --help Show this message and exit + --interval= Amount of time between checks in ISO8601 duration + format (default 1 minute) + --ifttt= IFTTT webhook URL to trigger (see + https://ifttt.com/maker_webhooks) + --data= Directory into which already-seen versions are tracked + (default in-memory) + --watch Continually monitor for new versions every '--interval' + -h, --help Show this message and exit Arguments: - CONFIG TOML file containing repositories and coordinates to watch - - Format: - - [MavenCentral] - coordinates = [ - "com.example.ping:pong", - "com.example.fizz:buzz", - ] - - [GoogleMaven] - coordinates = [ - "com.google:example", - ] - - [CustomRepo] - name = "Custom Repo" # Optional - host = "https://example.com/repo/" - coordinates = [ - "com.example:thing", - ] - - "MavenCentral" and "GoogleMaven" are two optional well-known - repositories which only require a list of coordinates. Other - repositories also require a host and can specify an optional name. + TOML file containing repositories and coordinates to watch + + Format: + + ╭──────────────────────────────────╮ + │[MavenCentral] │ + │coordinates = [ │ + │ "com.example.ping:pong", │ + │ "com.example.fizz:buzz", │ + │] │ + │ │ + │[GoogleMaven] │ + │coordinates = [ │ + │ "com.google:example", │ + │] │ + │ │ + │[CustomRepo] │ + │name = "Custom Repo" # Optional │ + │host = "https://example.com/repo/"│ + │coordinates = [ │ + │ "com.example:thing", │ + │] │ + ╰──────────────────────────────────╯ + + "MavenCentral" and "GoogleMaven" are two optional well-known + repositories which only require a list of coordinates. Other + repositories also require a host and can specify an optional name. ``` diff --git a/src/main/kotlin/watch/dependency/main.kt b/src/main/kotlin/watch/dependency/main.kt index bee1687..9b30e32 100644 --- a/src/main/kotlin/watch/dependency/main.kt +++ b/src/main/kotlin/watch/dependency/main.kt @@ -101,6 +101,7 @@ private class AwaitCommand : DependencyWatchCommand( .default(MAVEN_CENTRAL_ID) private val quiet by option("--quiet", "-q") + .help("Hide 'Last checked' output") .flag() private val coordinates by argument("COORDINATES", help = "Maven coordinates (e.g., 'com.example:example:1.0.0')")