Skip to content

Commit 8ad7c74

Browse files
samruddhikhandalegithub-actions
andauthored
Automated documentation update (#688)
Automated documentation update [skip ci] Co-authored-by: github-actions <[email protected]>
1 parent 96c1eea commit 8ad7c74

File tree

1 file changed

+73
-5
lines changed

1 file changed

+73
-5
lines changed

src/dotnet/README.md

Lines changed: 73 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,99 @@
11

22
# Dotnet CLI (dotnet)
33

4-
Installs the .NET CLI. Provides option of installing sdk or runtime, and option of versions to install. Uses latest version of .NET sdk as defaults to install.
4+
This Feature installs the latest .NET SDK, which includes the .NET CLI and the shared runtime. Options are provided to choose a different version or additional versions.
55

66
## Example Usage
77

88
```json
99
"features": {
10-
"ghcr.io/devcontainers/features/dotnet:1": {}
10+
"ghcr.io/devcontainers/features/dotnet:2": {}
1111
}
1212
```
1313

1414
## Options
1515

1616
| Options Id | Description | Type | Default Value |
1717
|-----|-----|-----|-----|
18-
| version | Select or enter a dotnet CLI version. (Available versions may vary by Linux distribution.) | string | latest |
19-
| runtimeOnly | Install just the dotnet runtime if true, and sdk if false. | boolean | false |
20-
| installUsingApt | If true, it installs using apt instead of the release URL | boolean | true |
18+
| version | Select or enter a .NET SDK version. Use 'latest' for the latest version, 'lts' for the latest LTS version, 'X.Y' or 'X.Y.Z' for a specific version. | string | latest |
19+
| additionalVersions | Enter additional .NET SDK versions, separated by commas. Use 'latest' for the latest version, 'lts' for the latest LTS version, 'X.Y' or 'X.Y.Z' for a specific version. | string | - |
20+
| dotnetRuntimeVersions | Enter additional .NET runtime versions, separated by commas. Use 'latest' for the latest version, 'lts' for the latest LTS version, 'X.Y' or 'X.Y.Z' for a specific version. | string | - |
21+
| aspNetCoreRuntimeVersions | Enter additional ASP.NET Core runtime versions, separated by commas. Use 'latest' for the latest version, 'lts' for the latest LTS version, 'X.Y' or 'X.Y.Z' for a specific version. | string | - |
2122

2223
## Customizations
2324

2425
### VS Code Extensions
2526

2627
- `ms-dotnettools.csharp`
2728

29+
## Configuration examples
2830

31+
Installing only the latest .NET SDK version (the default).
32+
33+
``` json
34+
{
35+
"features": {
36+
"ghcr.io/devcontainers/features/dotnet:2": "latest" // or "" or {}
37+
}
38+
```
39+
40+
Installing an additional SDK version. Multiple versions can be specified as comma-separated values.
41+
42+
``` json
43+
{
44+
"features": {
45+
"ghcr.io/devcontainers/features/dotnet:2": {
46+
"additionalVersions": "lts"
47+
}
48+
}
49+
```
50+
51+
Installing specific SDK versions.
52+
53+
``` json
54+
{
55+
"features": {
56+
"ghcr.io/devcontainers/features/dotnet:2": {
57+
"version": "6.0",
58+
"additionalVersions": "7.0, 8.0"
59+
}
60+
}
61+
```
62+
63+
Installing a specific SDK feature band.
64+
65+
``` json
66+
{
67+
"features": {
68+
"ghcr.io/devcontainers/features/dotnet:2": {
69+
"version": "6.0.4xx",
70+
}
71+
}
72+
```
73+
74+
Installing a specific SDK patch version.
75+
76+
``` json
77+
{
78+
"features": {
79+
"ghcr.io/devcontainers/features/dotnet:2": {
80+
"version": "6.0.412",
81+
}
82+
}
83+
```
84+
85+
Installing only the .NET Runtime or the ASP.NET Core Runtime. (The SDK includes all runtimes so this configuration is only useful if you need to run .NET apps without building them from source.)
86+
87+
``` json
88+
{
89+
"features": {
90+
"ghcr.io/devcontainers/features/dotnet:2": {
91+
"version": "none",
92+
"dotnetRuntimeVersions": "latest, lts",
93+
"aspnetCoreRuntimeVersions": "latest, lts",
94+
}
95+
}
96+
```
2997

3098
## OS Support
3199

0 commit comments

Comments
 (0)