Skip to content

Commit 4236bdf

Browse files
authored
Merge pull request #308 from yahonda/document-codespaces-stop-restart
Document how to stop and restart a Codespace
2 parents 058f95a + a32932d commit 4236bdf

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,38 @@ The first-time build takes several minutes (Oracle image pull +
5757
Instant Client setup + `bundle install`). Subsequent starts of the
5858
same Codespace are much faster.
5959

60+
#### Stopping and restarting your Codespace
61+
62+
Codespaces are billed for compute time while they are running, and for
63+
storage while they are stopped. Stop your Codespace when you take a
64+
break so you are not billed for an idle machine; your files, installed
65+
gems, and Oracle Database state are preserved across stop/start. See
66+
GitHub's documentation on [stopping and starting a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)
67+
for full details.
68+
69+
Ways to stop a Codespace:
70+
71+
- **From the GitHub web UI** — go to <https://github.com/codespaces>,
72+
click the **** menu next to the Codespace, and choose **Stop
73+
codespace**.
74+
- **From the VS Code Command Palette** (browser or desktop, while
75+
connected to the Codespace) — run **Codespaces: Stop Current
76+
Codespace**.
77+
- **From the `gh` CLI**`gh codespace stop` (interactive picker) or
78+
`gh codespace stop -c <codespace-name>`. List your Codespaces with
79+
`gh codespace list`.
80+
81+
Codespaces also stop automatically after a period of inactivity (30
82+
minutes by default). You can change the timeout under
83+
[Codespaces settings](https://github.com/settings/codespaces).
84+
85+
To resume work, open the Codespace again from
86+
<https://github.com/codespaces> or with `gh codespace code`; the
87+
environment, the Oracle Database container, and any uncommitted changes
88+
come back as you left them. When you no longer need the Codespace,
89+
delete it from the same UI or with `gh codespace delete` to stop being
90+
billed for storage.
91+
6092
### Prerequisites
6193

6294
- [Docker](https://www.docker.com/get-started) installed and running

0 commit comments

Comments
 (0)