include synopsis and description in opam 2 metadata

Signed-off-by: Anil Madhavapeddy <[email protected]>

Author: avsm

datakit-bridge-github.descr

@@ -37,3 +37,12 @@ build: [
   ["dune" "runtest" "tests/%{name}%"] {with-test}
 ]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "A bidirectional bridge between the GitHub API and Datakit"
+description: """
+The package provides a bi-directional bridge between the GitHub API
+and Datakit, so you can talk to the GitHub API using filesystem and
+Git-like commands only. The `datakit-github` programs can start a
+webhook server to listen for GitHub events in real time, and project
+it into a Git repository. It also monitors that Git repository for
+user-provided changes, and translate them into GitHub API calls.
+"""

datakit-bridge-github.opam

@@ -22,3 +22,25 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "DataKit Local-Git bridge"
+description: """
+This service is a drop-in replacement for the DataKit-GitHub bridge
+that instead just monitors a local Git repository. It is useful for
+testing a new DataKitCI configuration without having to configure
+GitHub integration first.
+
+The local bridge monitors the state of one or more local Git
+repositories, writing the current head of each branch to
+DataKit. DataKitCI can be configured to run the CI tests against the
+project each time a commit is made.
+
+Once you are happy with the way the CI is working, you can replace
+this service with the GitHub bridge service to have the CI test a
+project hosted on GitHub instead.
+
+Unlike the GitHub bridge, this service:
+
+- only reports on branches, not tags or pull requests;
+- does not report build statuses from other CI systems; and
+- does not push the statuses set by the CI anywhere.
+"""

datakit-bridge-local-git.descr

@@ -44,3 +44,11 @@ build: [
   ["dune" "runtest" "ci/tests"] {with-test}
 ]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "Continuous Integration service using DataKit"
+description: """
+DataKitCI is a continuous integration service that monitors your
+GitHub project and tests each branch, tag and pull request. It
+displays the test results as status indicators in the GitHub UI. It
+keeps all of its state and logs in DataKit, rather than a traditional
+relational database, allowing review with the usual Git tools.
+"""

datakit-bridge-local-git.opam

@@ -20,3 +20,4 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "A library for Datakit clients over 9P"

datakit-ci.opam

@@ -23,3 +23,4 @@ build: [
   ["dune" "runtest" "tests/datakit-git"] {with-test}
 ]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "A library for connecting Datakit client using Git"

datakit-client-9p.opam

@@ -18,3 +18,9 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "A library to construct Datakit clients"
+description: """
+The library currently only provides only a 9p client to talk to
+Datakit, but other filesystem protocols will be available in the
+future.
+"""

datakit-client-git.opam

@@ -22,3 +22,4 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "Abstraction of the GitHub API, suitable for DataKit clients"

datakit-client.descr

@@ -17,3 +17,4 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "Build Datakit servers using the 9P filesystem protocol"

datakit-client.opam

@@ -19,3 +19,10 @@ depends: [
 ]
 build: ["dune" "build" "-p" name "-j" jobs]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "A library to write Datakit servers"
+description: """
+The library exposes a VFS interface, that servers can use to write
+introspection libraries -- for instance to expose runtime parameters
+over 9p. The library does not depend on Irmin so is relatively
+lightweight to embed in any application.
+"""

datakit-github.descr

@@ -44,3 +44,4 @@ build: [
   ["dune" "runtest" "tests/datakit-9p"] {with-test}
 ]
 dev-repo: "git+https://github.com/moby/datakit.git"
+synopsis: "Orchestrate applications using a Git-like dataflow"