Docker Hub の Build triggers の使い方


Docker Hub の (Remote) Build triggers の使い方がよく分からなかったので調べました。

Docker Hubには外部からリクエストをPOSTすることでAutomated Buildを実行する「Build triggers」という設定がBuildタブの「Configure Automated Builds」の中にあるのですが(下記画像参照)、どうもDocker v19.03現在時点で、その使い方の詳細が消えてしまっているようです。(現在のドキュメントにも記載されていません。)

昔のドキュメントをさかのぼってみるとv17.06時点のドキュメントには書いてありました。(オリジナルサイズの画像はリンク先へ)

よく見ると「Trigger Url」の形式も変わっています。(昔のTrigger TokenはTrigger Urlに含まれたように見えます。)どこかの時点で仕様が変わったのだと思いますがよくわかりませんでした。Trigger Urlは変わっていますが、JSONパラメータは同じものが使えるようです。少なくともTrigger by Source tag named v1.1すべて動作することを確認しました。buildまたはdocker_tagはBUILD RULESの定義にマッチするものが反応し、source_typeは指定したブランチ/タグをpushした時と同じように反応するようです。(注意 もしかしたらJSONパラメータは将来廃止する or 廃止されたという意図なのかもしれないので注意した方がいいかもしれません。)

ちなみに現在のTrigger Urlの形式 https://hub.docker.com/api/build/v1/source/ で検索してもBuild triggersの情報はあまり見つかりませんが、古い形式である https://registry.hub.docker.com/ trigger あたりを検索キーワードとすると見つかると思います。

検索&コピペ用に画像のExamplesの内容をテキスト化しておきます。

# Trigger all tags/branchs for this automated build.
$ curl -H "Content-Type: application/json" --data '{"build": true}' -X POST https://

# Trigger by docker tag name
$ curl -H "Content-Type: application/json" --data '{"docker_tag": "master"}' -X POST https://

# Trigger by Source branch named staging
$ curl -H "Content-Type: application/json" --data '{"source_type": "Branch", "source_name": "staging"}' -X POST https://

# Trigger by Source tag named v1.1
$ curl -H "Content-Type: application/json" --data '{"source_type": "Tag", "source_name": "v1.1"}' -X POST https://


curl --data build=true -X POST https://registry.hub.docker.com/u/svendowideit/testhook/trigger/be579c
82-7c0e-11e4-81c4-0242ac110020/

おまけ

勢い余って、Build triggers をCLIで実行するツールを作ってみたけど、curlで十分だし使わない気がするなぁ。