Skip to content

Commit 966ca8d

Browse files
authored
Add docs for codespaces.openFiles (devcontainers#105)
1 parent 3ce3182 commit 966ca8d

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

supporting.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,34 @@ If your Codespaces project needs additional permissions for other repositories,
9797

9898
```json
9999
"customizations": {
100-
// Configure properties specific to Codespaces.
101-
"codespaces": {
102-
"repositories": {
103-
"my_org/my_repo": {
104-
"permissions": {
105-
"issues": "write"
106-
}
100+
// Configure properties specific to Codespaces.
101+
"codespaces": {
102+
"repositories": {
103+
"my_org/my_repo": {
104+
"permissions": {
105+
"issues": "write"
107106
}
108107
}
109108
}
109+
}
110110
}
111111
```
112112

113+
You can customize which files are initially opened when the codespace is created:
114+
```json
115+
"customizations": {
116+
// Configure properties specific to Codespaces.
117+
"codespaces": {
118+
"openFiles": [
119+
"README"
120+
"src/index.js"
121+
]
122+
}
123+
}
124+
```
125+
126+
The paths are relative to the root of the repository. They will be opened in order, with the first file activated.
127+
113128
Note that currently Codespaces reads these properties from devcontainer.json, not image metadata.
114129

115130
#### <a href="#codespaces-specific-limitations" name="codespaces-specific-limitations" class="anchor"> Product specific limitations </a>

0 commit comments

Comments
 (0)