Skip to content

Commit 07bf4d7

Browse files
authored
Update README.md
1 parent 8ab8a66 commit 07bf4d7

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,22 @@ For example:<br>
4848
## 🔧 Configuration
4949

5050
Typically the script doesn't need any configuration, but you can change some of the settings if required.
51-
You can do this by editing your local copy of the `gh-doccs` file and editing the values of the variables at the top of the script.
51+
You can do this by editing your local copy of the `gh-doccs` file and editing the values of the variables at the top of the script.
52+
53+
```bash
54+
REPO="github/docs-internal"
55+
DEVCONTAINER=".devcontainer/devcontainer.json"
56+
TIMEOUT="3h"
57+
MACHINE="xLargePremiumLinux" # To list available machine types for a repo use:
58+
# gh api --jq ".machines[].name" repos/OWNER/REPONAME/codespaces/machines
59+
LOCATION="" # e.g. EastUs|SouthEastAsia|WestEurope|WestUs2
60+
# Leave empty for automatic location selection.
61+
# To list current available locations see: gh cs create --help
62+
RETENTION="720h"
63+
OPEN_IN_BROWSER=false # Set to true to open the codespace in a browser, or false to open in VS Code.
64+
REQUEST_BRANCH=true # Set to true to request a branch name, or false to use the default branch.
65+
```
66+
5267
For example, by default `LOCATION` is an empty string, but you can set this to a particular location
5368
(e.g. `EastUs` or `SouthEastAsia` or `WestEurope` or `WestUs2`).
5469

0 commit comments

Comments
 (0)