/dependency-watch

Script to wait for an artifact to appear in a Maven repository or to monitor coordinates for new versions.

Primary LanguageKotlinApache License 2.0Apache-2.0

Dependency Watch

Script to wait for an artifact to appear on Maven Central or to monitor coordinates for new versions.

Just release a new artifact and want to know when you can start using it?

dependency-watch await com.example:example:1.1.0 && say "Example 1.1.0 is available!"

Pipe to a notification, email, HTTP request, sound, or anything else your heart desires.

Monitor

The notify subcommand allows you to monitor multiple groupId/artifactId coordinates at once.

Create a config.toml with a coordinate list.

[MavenCentral]
coordinates = [
  "com.example:example",
  "com.jakewharton:dependency-watch",
]

You can also monitor Google's maven repository with the table name "GoogleMaven". Monitor custom repositories by adding a 'host' key and optional 'name'.

[CustomRepo]
name = "Custom Repo" # Optional!
host = "https://example.com/repo/"
coordinates = [
  "com.example:thing",
]

Pass the config file and a --data directory to store already-seen versions across invocations:

dependency-watch notify --data data config.toml

The notify subcommand will check for any new versions once and then exit. Run with --watch to continuously check every minute. Use --interval to adjust the check period.

Slack

The --slack option accepts a Slack webhook URL to notify when a new version is found.

The message will look like this:

New artifact in (repository name)

(version) of (groupId):(artifactId)

Teams

The --teams option accepts a Teams webhook URL to notify when a new version is found.

The message will look like this:

New artifact in (repository name)

(version) of (groupId):(artifactId)

IFTTT

The --ifttt option accepts an IFTTT webhook URL to notify when a new version is found. This notification can then be redirected to Twitter, Slack, email, printers, light bulbs, and hundreds of other places.

The event will have the following data set:

  • Value1: The maven repository name
  • Value2: The groupId:artifactId pair (e.g., com.example:example)
  • Value3: The new versions that was seen (e.g., 1.1.0)

Install

Mac OS

brew install JakeWharton/repo/dependency-watch

Other

Download ZIP from latest release and run bin/dependency-watch or bin/dependency-watch.bat.

Docker

The container runs the tool using cron on a specified schedule and will notify IFTTT.

Docker Image Version Docker Image Size

The container looks in /config for any *.toml files, but only one is supported.

docker run -it --rm
    -v /path/to/config:/config \
    -v /path/to/data:/data \
    -e "CRON=0 * * * *" \
    -e "NOTIFY_IFTTT=..." \
    jakewharton/dependency-watch:0.4

To be notified when sync is failing visit https://healthchecks.io, create a check, and specify the ID to the container using the HEALTHCHECK_ID environment variable.

Docker Compose

version: '2'
services:
  dependency-watch:
    image: jakewharton/dependency-watch:0.5
    restart: unless-stopped
    volumes:
      - /path/to/config:/config
      - /path/to/data:/data
    environment:
      - "CRON=0 * * * *"
      - "NOTIFY_IFTTT=..."
      #Optional:
      - "HEALTHCHECK_ID=..."
      - "PUID=..."
      - "PGID=..."

Usage

$ dependency-watch --help
Usage: dependency-watch [<options>] <command> [<args>]...

Options:
  -h, --help  Show this message and exit

Commands:
  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>

  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".

  -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')
$ dependency-watch notify --help
Usage: dependency-watch notify [<options>] <config>

  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

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.

License

Copyright 2020 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.