From 27bc896552db44d2e8c7af371a88e28a7cbd09e7 Mon Sep 17 00:00:00 2001 From: Maxim Topciu Date: Sat, 27 Apr 2024 12:24:55 +0300 Subject: [PATCH] update description --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6b63240..5868157 100644 --- a/README.md +++ b/README.md @@ -61,18 +61,20 @@ github-actions-runner run-action \ --verbose ``` -### Docker: -This CLI tool is also available as a Docker image, which can be used to run the tool in a containerized environment. -The Docker image can be pulled from the GitHub Container Registry: +### Docker +This CLI tool is available as a Docker image, enabling its use in containerized environments. There are two Docker images available, each serving different use cases. + +#### Standard Docker Image +The standard Docker image includes an `ENTRYPOINT` to simplify command execution. You can pull it from the GitHub Container Registry and run it like this: ```bash docker pull ghcr.io/adguard/github-actions-runner:latest ``` -To run the Docker image, you can use the following command: +To run the image, use the following command: ```bash -docker run --rm -it ghcr.io/adguardteam/githubactionsrunner:latest run-action \ +docker run --rm -it ghcr.io/adguard/github-actions-runner:latest run-action \ --repo "AdguardTeam/GithubActionsRunner" \ --workflow "build.yml" \ --branch "master" \ @@ -83,5 +85,20 @@ docker run --rm -it ghcr.io/adguardteam/githubactionsrunner:latest run-action \ --verbose ``` +#### Docker Image without ENTRYPOINT +This alternative Docker image doesn't set an `ENTRYPOINT`, providing more flexibility for advanced use cases. Pull it from the GitHub Container Registry and run it like this: + +```bash +docker pull ghcr.io/adguard/github-actions-runner:latest-ci +``` + +To run the image, you need to specify the command manually: + +```bash +docker run --rm -it ghcr.io/adguard/github-actions-runner:latest-ci /bin/sh +``` + +In this mode, you can execute commands manually inside the container or create custom entry points for specific workflows. + ## Contributing Contributions to extend the functionality or improve the tool are welcome. Please refer to the project's repository on GitHub to submit issues or pull requests.