From 48f0948cfbe91b5166b4d1ccb2e35ed4150fa19f Mon Sep 17 00:00:00 2001 From: David Claeys Date: Wed, 22 Jul 2026 10:52:31 +0200 Subject: [PATCH] update documentation --- README.md | 18 ++++++++++++++++++ dockerhub-description/README.md | 2 ++ setup-docker/README.md | 2 ++ 3 files changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c5803b --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ + +# Gitea Actions + +This repository contains a collection of GitHub/Gitea Actions that I developed for my own projects. + +The primary goal of these actions is to eliminate repetitive setup and maintenance steps that would otherwise need to be duplicated across multiple workflows.
+By centralizing these common tasks, workflows become easier to maintain, more consistent, and less error-prone. + +At the moment, these actions are primarily intended for use with Gitea runners, although some of them may also work in other compatible CI environments. + + +## Available Actions + +- **[dockerhub description](dockerhub-description/README.md)** + Updates a Docker Hub repository description while automatically installing any required dependencies missing from the runner environment. + +- **[setup docker](setup-docker/README.md)** + Installs Docker on the runner and optionally configures Docker Buildx for container build workflows. diff --git a/dockerhub-description/README.md b/dockerhub-description/README.md index d593bce..3caf3bc 100644 --- a/dockerhub-description/README.md +++ b/dockerhub-description/README.md @@ -1,3 +1,5 @@ +# dockerhub description + By default, Gitea runner environments do not include the dependencies required by [dockerhub-description](https://github.com/peter-evans/dockerhub-description).
This action is a wrapper around `dockerhub-description` that installs the required dependencies before invoking the upstream action, allowing it to run successfully on Gitea runners. diff --git a/setup-docker/README.md b/setup-docker/README.md index 1fa0118..2a5d4a7 100644 --- a/setup-docker/README.md +++ b/setup-docker/README.md @@ -1,3 +1,5 @@ +# setup docker + 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.