chore(README.md): add instructions for local iteration without a Git repo #342
Conversation
This file contains 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
mafredri
approved these changes
Sep 10, 2024
README.md
Outdated
| docker run -it --rm -e ENVBUILDER_INIT_SCRIPT='/usr/games/cowsay "happy hacking"' -v $PWD:/workspaces/empty ghcr.io/coder/envbuilder:latest | ||
| ``` | ||
|
|
||
| If your `devcontainer.json` is not present in the root of the workspace folder, |
| @@ -53,6 +53,32 @@ Exit the container, and re-run the `docker run` command... after the build compl | |||
| > If you need to bypass this behavior for any reason, you can bypass this safety check by setting | |||
| > `ENVBUILDER_FORCE_SAFE=true`. | |||
|
|
|||
| If you don't have a remote Git repo or you want to quickly iterate with some | |||
| local files, simply omit `ENVBUILDER_GIT_URL` and instead mount the directory | |||
| containing your code to `/workspaces/empty` inside the Envbuilder container. | |||
There was a problem hiding this comment.
Is empty a magic name here? Or does any name work?
There was a problem hiding this comment.
Updated to also mention ENVBUILDER_WORKSPACE_FOLDER.
mtojek
approved these changes
Sep 10, 2024
Agreed, we could probably start with a simple GitHub pages setup. |
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.
Fixes #164