Add management of DockerHub mondoo/cnquery & mondoo/cnspec Descriptio…

…ns (#424) * Add missing mondoo Docker Org overfile texts Signed-off-by: Ben Rockwood <[email protected]> * Add action steps to update cnquery and cnspec Signed-off-by: Ben Rockwood <[email protected]> * Version update for readmes Signed-off-by: Ben Rockwood <[email protected]> * Allow manual invocation Signed-off-by: Ben Rockwood <[email protected]> --------- Signed-off-by: Ben Rockwood <[email protected]>
mondoohq · Jan 24, 2024 · d277568 · d277568
1 parent 5185a4d
commit d277568
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 0 deletions.
diff --git a/.github/workflows/dockerhub_docs.yml b/.github/workflows/dockerhub_docs.yml
@@ -1,6 +1,7 @@
 name: Update Docker Hub docs
 
 on:
+  workflow_dispatch:
   push:
     branches:
     - main
@@ -34,4 +35,20 @@ jobs:
           repository: mondoo/client
           readme-filepath: ./dockerhub/mondoo/client.md
 
+      - name: Update mondoo/cnquery DockerHub docs
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: mondoo/cnquery
+          readme-filepath: ./dockerhub/mondoo/cnquery.md
+
+      - name: Update mondoo/cnspec DockerHub docs
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: mondoo/cnspec
+          readme-filepath: ./dockerhub/mondoo/cnspec.md
+
 
diff --git a/dockerhub/mondoo/cnquery.md b/dockerhub/mondoo/cnquery.md
@@ -0,0 +1,25 @@
+
+```
+  ___ _ __   __ _ _   _  ___ _ __ _   _
+ / __| '_ \ / _` | | | |/ _ \ '__| | | |
+| (__| | | | (_| | |_| |  __/ |  | |_| |
+ \___|_| |_|\__, |\__,_|\___|_|   \__, |
+  mondoo™      |_|                |___/
+```
+
+# Quick reference
+
+* Basic use: ```docker run mondoo/cnquery <args>```
+* Source Code: https://github.com/mondoohq/cnquery
+* Release Notes: https://mondoo.com/releases/
+* Documentation: [mondoo.com/docs/cnquery/](https://mondoo.com/docs/cnquery/)
+* Where to get help: [Mondoo Community GitHub Discussions](https://github.com/orgs/mondoohq/discussions)
+* Dockerfile Source: https://github.com/mondoohq/cnquery/blob/main/Dockerfile
+* Where to file issues: https://github.com/mondoohq/cnquery/issues
+* Mondoo Client Binary Downloads (Non-Container):  https://releases.mondoo.com/cnquery/
+* Supported Architectures: `amd64`, `i386`, `arm32v6`, `arm32v7`, and `arm64`
+
+# Supported tags
+- `latest` - always pinned to the latest release
+- `9` - always pinned to the latest release for a given major version
+- `9.1.0` - always pinned to a specific release
diff --git a/dockerhub/mondoo/cnspec.md b/dockerhub/mondoo/cnspec.md
@@ -0,0 +1,25 @@
+```
+  ___ _ __  ___ _ __   ___  ___
+ / __| '_ \/ __| '_ \ / _ \/ __|
+| (__| | | \__ \ |_) |  __/ (__
+ \___|_| |_|___/ .__/ \___|\___|
+   mondoo™     |_|
+```
+
+
+# Quick reference
+
+* Basic use: ```docker run mondoo/cnspec <args>```
+* Source Code: https://github.com/mondoohq/cnspec
+* Release Notes: https://mondoo.com/releases/
+* Documentation: [mondoo.com/docs/cnspec/](https://mondoo.com/docs/cnspec/)
+* Where to get help: [Mondoo Community GitHub Discussions](https://github.com/orgs/mondoohq/discussions)
+* Dockerfile Source: https://github.com/mondoohq/cnspec/blob/main/Dockerfile
+* Where to file issues: https://github.com/mondoohq/cnspec/issues
+* Binary Downloads (Non-Container):  https://releases.mondoo.com/cnspec/
+* Supported Architectures: `amd64`, `i386`, `arm32v6`, `arm32v7`, and `arm64`
+
+# Supported tags
+- `latest` - always pinned to the latest release
+- `9` - always pinned to the latest release for a given major version
+- `9.1.0` - always pinned to a specific release