docker-library · tianon · May 17, 2024 · May 9, 2024 · May 9, 2024 · May 16, 2024
diff --git a/.ci/check-metadata.sh b/.ci/check-metadata.sh
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+cd "$(dirname "$(readlink -f "$BASH_SOURCE")")/.."
+
+# metadata.sh takes directories with a 'metadata.json' in them
+# metadata.json is expected in every repo
+# "." so that the canonical source metadata.json is checked too
+./metadata.sh */ .
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -46,3 +46,8 @@ jobs:
           fetch-depth: 0
       - run: .ci/check-pr-no-readme.sh
     if: ${{ github.event_name == 'pull_request' }}
+  metadata:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: .ci/check-metadata.sh
diff --git a/README.md b/README.md
@@ -61,6 +61,7 @@ After opening your Pull Request the changes will be checked by an automated `mar
 -	Create a `license.md` (required)
 -	Create a `maintainer.md` (required)
 -	Create a `github-repo` (required)
+-	Create a `metadata.json` (required)
 -	Add a `logo.png` (recommended)
 
 Optionally:
@@ -128,6 +129,18 @@ The image is automatically scaled to a 120 pixel square for the top of the Docke
 
 This file should contain a link to the maintainers of the Dockerfile.
 
+## `metadata.json`
+
+This file contains data about the repo for Docker Hub. The minimum file is defined below. `./metadata.sh [repo-name]` must be used to correctly format it (use `-w` to apply its suggested format changes). Only three sorted unique Docker Hub categories are allowed. `metadata.json` in the root contains the list of categories to choose from. See descriptions for the categories on the [Docker docs site](https://docs.docker.com/docker-hub/repos/categories/).
+
+```json
+{
+    "hub": {
+         "categories": []
+    }
+}
+```
+
 ## `README-short.txt`
 
 This is the short description for the Docker Hub, limited to 100 characters in a single line.

diff --git a/adminer/metadata.json b/adminer/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/aerospike/metadata.json b/aerospike/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/almalinux/metadata.json b/almalinux/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/alpine/metadata.json b/alpine/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/alt/metadata.json b/alt/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/amazoncorretto/metadata.json b/amazoncorretto/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/amazonlinux/metadata.json b/amazonlinux/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/api-firewall/metadata.json b/api-firewall/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "api-management"
+    ]
+  }
+}
diff --git a/arangodb/metadata.json b/arangodb/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/archlinux/metadata.json b/archlinux/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/backdrop/metadata.json b/backdrop/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "content-management-system"
+    ]
+  }
+}
diff --git a/bash/metadata.json b/bash/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "developer-tools"
+    ]
+  }
+}
diff --git a/bonita/metadata.json b/bonita/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/buildpack-deps/metadata.json b/buildpack-deps/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "developer-tools"
+    ]
+  }
+}
diff --git a/busybox/metadata.json b/busybox/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/caddy/metadata.json b/caddy/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "web-servers"
+    ]
+  }
+}
diff --git a/cassandra/metadata.json b/cassandra/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/centos/metadata.json b/centos/metadata.json
@@ -0,0 +1,5 @@
+{
+  "hub": {
+    "categories": []
+  }
+}
diff --git a/chronograf/metadata.json b/chronograf/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "monitoring-and-observability"
+    ]
+  }
+}
diff --git a/cirros/metadata.json b/cirros/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/clearlinux/metadata.json b/clearlinux/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/clefos/metadata.json b/clefos/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/clojure/metadata.json b/clojure/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/composer/metadata.json b/composer/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "developer-tools"
+    ]
+  }
+}
diff --git a/consul/metadata.json b/consul/metadata.json
@@ -0,0 +1,5 @@
+{
+  "hub": {
+    "categories": []
+  }
+}
diff --git a/convertigo/metadata.json b/convertigo/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/couchbase/metadata.json b/couchbase/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/couchdb/metadata.json b/couchdb/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/crate/metadata.json b/crate/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/dart/metadata.json b/dart/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/debian/metadata.json b/debian/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/docker/metadata.json b/docker/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "developer-tools"
+    ]
+  }
+}
diff --git a/drupal/metadata.json b/drupal/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "content-management-system"
+    ]
+  }
+}
diff --git a/eclipse-mosquitto/metadata.json b/eclipse-mosquitto/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "message-queues"
+    ]
+  }
+}
diff --git a/eclipse-temurin/metadata.json b/eclipse-temurin/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/eggdrop/metadata.json b/eggdrop/metadata.json
@@ -0,0 +1,5 @@
+{
+  "hub": {
+    "categories": []
+  }
+}
diff --git a/elasticsearch/metadata.json b/elasticsearch/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "databases-and-storage"
+    ]
+  }
+}
diff --git a/elixir/metadata.json b/elixir/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/emqx/metadata.json b/emqx/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "message-queues"
+    ]
+  }
+}
diff --git a/erlang/metadata.json b/erlang/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "languages-and-frameworks"
+    ]
+  }
+}
diff --git a/express-gateway/metadata.json b/express-gateway/metadata.json
@@ -0,0 +1,5 @@
+{
+  "hub": {
+    "categories": []
+  }
+}
diff --git a/fedora/metadata.json b/fedora/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "operating-systems"
+    ]
+  }
+}
diff --git a/flink/metadata.json b/flink/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "data-science"
+    ]
+  }
+}
diff --git a/fluentd/metadata.json b/fluentd/metadata.json
@@ -0,0 +1,7 @@
+{
+  "hub": {
+    "categories": [
+      "monitoring-and-observability"
+    ]
+  }
+}
diff --git a/friendica/metadata.json b/friendica/metadata.json
@@ -0,0 +1,5 @@
+{
+  "hub": {
+    "categories": []
+  }
+}