From 93557d552eb5eea418eac9145e1c711bbe83f8ce Mon Sep 17 00:00:00 2001 From: Robert Steiner Date: Wed, 28 Aug 2024 19:43:46 +0200 Subject: [PATCH] test Signed-off-by: Robert Steiner --- .github/workflows/docker-readme.yml | 56 +++++++++++++++++++++++++++++ src/docker/clientapp/README.md | 22 ++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 .github/workflows/docker-readme.yml create mode 100644 src/docker/clientapp/README.md diff --git a/.github/workflows/docker-readme.yml b/.github/workflows/docker-readme.yml new file mode 100644 index 000000000000..973eba3b2a71 --- /dev/null +++ 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_path: ${{ fromJSON(needs.collect.outputs.readme_files) }} + + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + + - id: repository + run: | + echo "name=$(basename $(dirname ${{ matrix.readme_path }}))" >> "$GITHUB_OUTPUT" + + - run: | + echo ${{ steps.repository.outputs.name }} + + - name: Docker Hub Description + uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0 + with: + repository: flwr/${{ steps.repository.outputs.name }} + readme-filepath: ${{ matrix.readme_path }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + diff --git a/src/docker/clientapp/README.md b/src/docker/clientapp/README.md new file mode 100644 index 000000000000..ac50d4dc9b8f --- /dev/null +++ b/src/docker/clientapp/README.md @@ -0,0 +1,22 @@ +# Flower ClientApp + +

+ + Flower Website + +

+ +## Quick reference + +- **Learn more:**
+ [Flower Docs](https://flower.ai/docs/framework/how-to-run-flower-using-docker.html) + +- **Where to get help:**
+ [Flower Discuss](https://discuss.flower.ai), [Slack](https://flower.ai/join-slack) or [GitHub](https://github.com/adap/flower) + +- **Supported architectures:**
+ `amd64`, `arm64v8` + +## Supported tags + +- `nightly`, `.dev` e.g. `1.11.0.dev20240724`