The Docker image `ghcr.io/actions/actions-runner` is missing documentation
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 6.3k
- Forks
- 1.4k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 24
Description
Describe the bug
A clear and concise description of what the bug is.
- Clicking on https://github.com/actions/runner/pkgs/container/actions-runner reveals that the Docker image
ghcr.io/actions/actions-runnerhas no usage documentation. There is no documentation explaining how to configure or start the Github Runner via the Docker CLI or Docker Compose files. This appears to be a missing item in https://github.com/actions/runner/issues/367 and https://github.com/actions/runner/pull/2250 .
To Reproduce
Steps to reproduce the behavior:
Expected behavior
A clear and concise description of what you expected to happen.
- The Docker image
ghcr.io/actions/actions-runnershould have proper documentation explaining how to configure or start the Github Runner via the Docker CLI or Docker Compose files.
Runner Version and Platform
Version of your runner?
OS of the machine running the runner? OSX/Windows/Linux/...
Linux
What's not working?
Please include error messages and screenshots.
Job Log Output
If applicable, include the relevant part of the job / step log output here. All sensitive information should already be masked out, but please double-check before pasting here.
- It doesn't seem important.
Runner and Worker's Diagnostic Logs
If applicable, add relevant diagnostic log information. Logs are located in the runner's _diag folder. The runner logs are prefixed with Runner_ and the worker logs are prefixed with Worker_. Each job run correlates to a worker log. All sensitive information should already be masked out, but please double-check before pasting here.
- It doesn't seem important.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Docker package page, issue #367, and pull request #2250 to understand the existing runner image documentation and intended usage. Document how to configure and start ghcr.io/actions/actions-runner with Docker CLI and Docker Compose; done means the package has clear usage instructions for both approaches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, docker-compose
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100