actions / actions/runner

Documentation request: file_commands and other mounted volumes

Open
#766 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
C#
Stars
6.3k
Forks
1.4k
Avg merge
1d 16h
Merged PRs (30d)
24

Description

#684 added /github/file_commands to the list of volumes available in the Runner. I cannot find any documentation about this volume, or any documentation with a list of volumes mounted that includes file_commands.

I request documentation on all mounted volumes: their names and what they contain and/or are to be used for. From the code at https://github.com/actions/runner/blob/8279ae9a709dd2df948171d4bc87cf45d4879090/src/Runner.Worker/Handlers/ContainerActionHandler.cs#L171-L174

it appears the following volumes are available (I would like documentation on each one):

  • /github/home
  • /github/workflow
  • /github/file_commands
  • /github/workspace

If such documentation already exists, please provide direct hyperlinks to it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/Runner.Worker/Handlers/ContainerActionHandler.cs at the referenced lines and verify the four listed mounted volumes: /github/home, /github/workflow, /github/file_commands, and /github/workspace. Document each volume's name and contents or intended use, and provide direct links if equivalent documentation already exists.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, github-actions
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.