Skip to content

Commit

Permalink
Add documentation of using docker
Browse files Browse the repository at this point in the history
Merge in CI/github-actions-runner from feature/example-3 to master

* commit '610797c3bffdfd6893eb0e11ca3f9ad710c900f8':
  add how to use with docker description
  fix stage
  • Loading branch information
maximtop committed Apr 26, 2024
2 parents 71ab21f + 610797c commit c9b5d85
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ FROM node:20.12.2-bookworm-slim AS runtime
COPY --from=builder /app/dist/bin/index.js /usr/local/bin/github-actions-runner
RUN chmod +x /usr/local/bin/github-actions-runner

ENTRYPOINT ["/bin/sh"]
ENTRYPOINT ["github-actions-runner"]
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,27 @@ 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:
```bash
docker pull ghcr.io/adguard/github-actions-runner:latest
```
To run the Docker image, you can use the following command:
```bash
docker run --rm -it ghcr.io/adguardteam/githubactionsrunner:latest run-action \
--repo "AdguardTeam/GithubActionsRunner" \
--workflow "build.yml" \
--branch "master" \
--rev "abc1234" \
--artifacts-path "./downloads" \
--commit-timeout 300 \
--branch-timeout 300 \
--verbose
```
## 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.
2 changes: 1 addition & 1 deletion bamboo-specs/example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ variables:
dockerNode: ghcr.io/adguardteam/githubactionsrunner:master

stages:
- Build:
- Test:
manual: false
final: false
jobs:
Expand Down

0 comments on commit c9b5d85

Please sign in to comment.