Skip to content

Commit

Permalink
update description
Browse files Browse the repository at this point in the history
  • Loading branch information
maximtop committed Apr 27, 2024
1 parent 0d9b1e1 commit 27bc896
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand All @@ -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.

0 comments on commit 27bc896

Please sign in to comment.