Skip to content

docs: Change root to Top Level Directory #4174

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

Closed
wants to merge 2 commits into from
Closed

docs: Change root to Top Level Directory #4174

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8d4f6e
Update runners.md
stuartp44 Oct 8, 2024
66ad415
docs: Change root to Top Level Directory
stuartp44 Oct 8, 2024
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
2 changes: 1 addition & 1 deletion docs/modules/runners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Runner module (root)
# Runner module (Top Level Directory)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In terraform term we speaking about modules, the ones below the first level (parten / top-level / root) are called submodule. When would like to make it explict here, would prefer to keep it short (so it renders nice). Either parent or top-level.

Suggested change
# Runner module (Top Level Directory)
# Runner module (Top Level)

Copy link
Member

@npalm npalm Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see PR for a suggestion https://github.com/philips-labs/terraform-aws-github-runner/pull/4175


This module creates resources in your AWS infrastructure, and EC2 instances for hosting the self-hosted runners on-demand. IAM permissions are set to a minimal level, and could be further limited by using permission boundaries. Instances permissions are limited to retrieve and delete the registration token, access the instance's own tags, and terminate the instance itself. By nature instances are short-lived, we strongly suggest to use ephemeral runners to ensure a safe build environment for each workflow job execution.

Expand Down