build: fix GH Codespaces building indefinitely #11981
Merged
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
- Codespaces would run indefinitely on the `onCreateCommand` and never finish
- also it would just eat up CPU hours on Codespaces, even if you closed the tab and turned off your computer
- had to manually go into Codespaces settings and turn it off after GH sent me an email that I used 24 CPU hours overnight while I was asleep 馃珷
- [`postCreateCommand`](https://containers.dev/implementors/json_reference/#lifecycle-scripts) instead runs asynchronously _after_ the container is started
- this finished fine in my Codespace
- this also lets you access the codespace very quickly as `pre-build.sh` is running async
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- link to GH Codespaces - warn about async `pre-build.sh` -- can start editing, but may want to hold off running commands - unless you know what you're doing -- you don't _necessarily_ need to wait for everything to be ready for every command, but will want that for any testing or building - instruct on how to use forwarded ports - remove old warning about Codespaces not working! Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
3 tasks
Joibel
approved these changes
Oct 11, 2023
terrytangyuan
approved these changes
Oct 11, 2023
6 tasks
8 tasks
6 tasks
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 #11423
Motivation
Make contributing easier for many users and those without too powerful local specs! Lots of folks have wanted to use it in issues and on Slack, so hopefully this should be a big help! 馃檪
onCreateCommandand never finish (seemingly due tokit? Runs indefinitely when used as anonCreateCommandin GH Codespaces聽kitproj/kit#44)Modifications
use
postCreateCommandinstead ofonCreateCommandpostCreateCommandruns asynchronously after the container is started, unlikeonCreateCommandpre-build.shis running async!add GH Codespaces instructions to the developer docs (not exactly "running locally" though... 馃 I believe you can connect a local VSCode editor to it though)
pre-build.sh-- can start editing, but may want to hold off running commandsremove old warning about Codespaces not working!
Verification
make docspassesRan it myself and got a Codespace running successfully! Screenshots:
Editor and Terminal with
kitrunning,pre-build.shcomplete and things are ready ("Finished configuring codespace" message at the bottom right):Ports tab:
UI open in a new tab connected to the codespace:
