docs: clarify that setup commands run as root and repo location #1230
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
- Add information about setup commands running as root user - Specify that repositories are cloned to /workspace directory - Add example for running commands as non-root user (e.g., for Homebrew) Co-authored-by: Jay Hack <jay@codegen.com>
- Add details about properly escaping quotes when using su command - Include examples of both single-quote and escaped double-quote approaches Co-authored-by: Jay Hack <jay@codegen.com>
Codecov Report✅ All modified and coverable lines are covered by tests. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This PR updates the setup commands documentation to clarify important environment details:
This addresses the request to make it clear in our documentation that we run everything in root and the repo is cloned to the
/workspacedirectory.