From 8c2783f4ef695e393b1c0bda3173244dbe330f4c Mon Sep 17 00:00:00 2001 From: David Claeys Date: Wed, 22 Jul 2026 09:02:27 +0200 Subject: [PATCH] update documentation and update setup docker action --- dockerhub-description/README.md | 24 +++++++++++++++++++++++- setup-docker/README.md | 22 +++++++++++++++++++++- setup-docker/action.yaml | 16 +++++++++++++++- 3 files changed, 59 insertions(+), 3 deletions(-) diff --git a/dockerhub-description/README.md b/dockerhub-description/README.md index 221ba9f..12e0a87 100644 --- a/dockerhub-description/README.md +++ b/dockerhub-description/README.md @@ -3,7 +3,29 @@ This action is a wrapper around `dockerhub-description` that installs the requir The wrapper then invokes the upstream action using the same inputs, making it a drop-in replacement. -usage: + +## Inputs + + +This action supports the same inputs as the upstream [`dockerhub-description`](https://github.com/peter-evans/dockerhub-description) action. + + +| Input | Required | Description | +|---------|----------|-------------| +| `username` | Yes | Docker Hub username. | +| `password` | Yes | Docker Hub password or access token. | +| `repository` | Yes | Docker Hub repository name (`username/repository`). | +| `short-description` | No | Repository short description. | +| `readme-filepath` | No | Path to the README file to publish. Defaults to `./README.md`. | +| `enable-url-completion` | No | Enable automatic URL completion in the README content. | + + +For a complete and up-to-date list of supported inputs, refer to the upstream project documentation: + +- [`dockerhub-description`](https://github.com/peter-evans/dockerhub-description) + + +## Usage ```yaml name: Update docker hub description diff --git a/setup-docker/README.md b/setup-docker/README.md index 0336574..eec608c 100644 --- a/setup-docker/README.md +++ b/setup-docker/README.md @@ -1,10 +1,30 @@ By default, many Gitea runner environments do not include a Docker installation.
This can be problematic because Docker is required by many container-related workflows, including building, tagging, and publishing container images. -This action installs the required dependencies before invoking the underlying action, making it easier to run Docker-based workflows on Gitea runners without duplicating setup steps in every repository. +This action installs Docker when required and optionally configures Docker Buildx for modern image build workflows. Existing Docker installations are automatically detected and reused. +This allows container-based workflows to run consistently across Gitea runners without requiring every repository to implement its own Docker setup logic. +## Inputs + +| Name | Description | Default | +|------|-------------|---------| +| `setup-buildx` | Configure Docker Buildx after Docker installation. | `true` | + +## Usage + +### Install Docker with Buildx (default) ```yaml - name: Setup docker uses: https://git.claeyscloud.com/david/gitea-actions/setup-docker@main `` + +### Install Docker without Buildx + +```yaml +- name: Setup Docker + uses: https://git.claeyscloud.com/david/gitea-actions/setup-docker@main + with: + setup-buildx: false +``` +This installs Docker if required but skips Docker Buildx configuration \ No newline at end of file diff --git a/setup-docker/action.yaml b/setup-docker/action.yaml index 1faedb4..8c44a0d 100644 --- a/setup-docker/action.yaml +++ b/setup-docker/action.yaml @@ -4,6 +4,16 @@ description: | Install Docker on the runner environment This action uses Docker's official convenience installation script at https://get.docker.com/ + By default, Docker Buildx is also configured to provide support for modern Docker build workflows, including multi-platform image builds, advanced caching, and BuildKit features. + Existing Docker installations are detected automatically and will not be reinstalled. + +inputs: + setup-buildx: + description: Setup Docker Buildx + required: false + default: "true" + + runs: using: composite @@ -19,4 +29,8 @@ runs: curl -fsSL https://get.docker.com | sh echo "Docker installed:" docker --version - fi \ No newline at end of file + fi + + - name: Set up Docker Buildx + if: inputs.setup-buildx == 'true' + uses: docker/setup-buildx-action@v3