diff --git a/.github/workflows/docker-readme.yml b/.github/workflows/docker-readme.yml new file mode 100644 index 000000000000..7b2930604aa5 --- /dev/null +++ b/.github/workflows/docker-readme.yml @@ -0,0 +1,33 @@ +name: Update Docker READMEs + +on: + push: + +jobs: + + + update: + if: ${{ github.repository == 'adap/flower' }} + name: Update Docker READMEs + runs-on: ubuntu-22.04 + timeout-minutes: 10 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + + - uses: dorny/paths-filter@v3 + id: filter + with: + filters: | + readme: + - 'src/docker/**/README.md' + + - run: echo ${{ steps.filter.outputs.changes }} + + # - 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 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`