Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add runAsHostUser docs #438

Merged
merged 3 commits into from
Nov 25, 2023
Merged

Add runAsHostUser docs #438

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55ab058
Add runAsHostUser docs
AndrewKahr Nov 21, 2023
e0f46d8
Update docs/03-github/04-builder.mdx
GabLeRoux Nov 21, 2023
9e7f864
Merge branch 'main' into add-runAsHostUser
AndrewKahr Nov 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/03-github/04-builder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,17 @@ This is useful if your manifest has a dependency on a private GitHub repo.

_**required:** `false`_ _**default:** `""`_

#### runAsHostUser

Run the container as the host user based on the file permissions of the cloned project that gets
mounted to the container. This is useful if you are using a self-hosted runner and need the
generated files from the container to be owned by the same user as the runner host. This solves most
permission errors without requiring the runner agent to run as root. This option shouldn't be needed
on Github Hosted runners as the systems are automatically wiped each run so we default to `false`.
Self-Hosted runners generally will want to set this to `true`.

_**required:** `false`_ _**default:** `false`_

#### chownFilesTo

User and optionally group (user or user:group or uid:gid) to give ownership of the resulting build
Expand Down