test

Signed-off-by: Robert Steiner <[email protected]>
adap · Aug 28, 2024 · bb5556f · bb5556f
1 parent 7ae2770
commit bb5556f
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 0 deletions.
diff --git a/.github/workflows/docker-readme.yml b/.github/workflows/docker-readme.yml
@@ -0,0 +1,56 @@
+name: Update Docker READMEs
+
+on:
+  push:
+
+jobs:
+
+
+    collect:
+      if: ${{ github.repository == 'adap/flower' }}
+      name: Collect Docker READMEs
+      runs-on: ubuntu-22.04
+      timeout-minutes: 10
+      outputs:
+        readme_files: ${{ steps.filter.outputs.readme_files }}
+      steps:
+        - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+        - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+          id: filter
+          with:
+            list-files: "json"
+            filters: |
+              readme:
+                - 'src/docker/**/README.md'
+
+        - run: echo ${{ steps.filter.outputs.readme_files }}
+
+    update:
+      if: ${{ needs.collect.outputs.readme_files != '' && toJson(fromJson(needs.collect.outputs.readme_files)) != '[]' }}
+      name: Update Docker READMEs
+      runs-on: ubuntu-22.04
+      timeout-minutes: 10
+      needs: collect
+      strategy:
+        matrix:
+          readme: ${{ fromJSON(needs.collect.outputs.readme_files) }}
+
+      steps:
+        - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+        - id: repository
+          run: |
+            echo "name==$(basename $(dirname ${{ matrix.readme }}))" >> "$GITHUB_OUTPUT"
+
+        - run: |
+            echo ${{ steps.repository.outputs.name }}
+
+        # - name: Docker Hub Description
+        #   uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0
+        #   with:
+        #     repository: flwr/
+        #     readme-filepath:
+        #     username: ${{ secrets.DOCKERHUB_USERNAME }}
+        #     password: ${{ secrets.DOCKERHUB_TOKEN }}
+
diff --git a/src/docker/clientapp/README.md b/src/docker/clientapp/README.md
@@ -0,0 +1,22 @@
+# Flower ClientApp
+
+<p align="center">
+  <a href="https://flower.ai/">
+    <img src="https://flower.ai/_next/image/?url=%2F_next%2Fstatic%2Fmedia%2Fflower_white_border.c2012e70.png&w=640&q=75" width="140px" alt="Flower Website" />
+  </a>
+</p>
+
+## Quick reference
+
+- **Learn more:**<br>
+  [Flower Docs](https://flower.ai/docs/framework/how-to-run-flower-using-docker.html)
+
+- **Where to get help:**<br>
+  [Flower Discuss](https://discuss.flower.ai), [Slack](https://flower.ai/join-slack) or [GitHub](https://github.com/adap/flower)
+
+- **Supported architectures:**<br>
+  `amd64`, `arm64v8`
+
+## Supported tags
+
+- `nightly`, `<version>.dev<YYYYMMDD>` e.g. `1.11.0.dev20240724`