aboutsummaryrefslogtreecommitdiff
path: root/src/dotnet/scripts/vendor/README.md
diff options
context:
space:
mode:
authorSteven <steven.liekens@gmail.com>2023-09-11 21:16:24 +0300
committerGitHub <noreply@github.com>2023-09-11 21:16:24 +0300
commit96c1eea40fc97b471ba0b33fcc79273c7ce586c7 (patch)
tree1ac35df447d38c00cb35e07a7b876dc985fc1329 /src/dotnet/scripts/vendor/README.md
parent038bed3d58a84885da8a008b80905da17d57a543 (diff)
Use dotnet-install.sh in .NET feature (#628)feature_dotnet_2.0.0
* Use dotnet-install.sh in .NET feature * Use latest.version files * Cleanup runtime args * Use latest.version files in tests as well * Improve tests, remove code duplication * Add stderr helper * Validate version inputs * Use suggested description Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Shorter version description Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Shorter version description Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Clean up apt lists * Verify 7.0 is latest * Fix PATH, add test for .NET global tools * Include a copy of dotnet-install.sh in the Feature * Configure useful env variables * Use stringly typed booleans * Keep imperative writing style in option hints * Update maintainers Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Move dotnet-install.sh into a vendor directory * Refactor variables * Amend * Amend 2 * Use default options from devcontainer-feature.json * Add back variables * Fix shellchek warning in fetch_latest_sdk_version * Inline install_version function * Fix ShellCheck warnings * Improve CSV parsing * Default to latest when configuring an empty version * Add support for runtime-only configurations * Move 'none' check higher up * Deduplicate helper functions, sort into files * Address the user more directly in NOTES * Remove unnecessary defaults * Replace feature -> Feature Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Add update-dotnet-install-script workflow * Apply suggestions from code review Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com> * Don't skip ci for automated script update --------- Co-authored-by: Samruddhi Khandale <samruddhikhandale@github.com>
Diffstat (limited to 'src/dotnet/scripts/vendor/README.md')
-rw-r--r--src/dotnet/scripts/vendor/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/dotnet/scripts/vendor/README.md b/src/dotnet/scripts/vendor/README.md
new file mode 100644
index 0000000..181b537
--- /dev/null
+++ b/src/dotnet/scripts/vendor/README.md
@@ -0,0 +1,27 @@
+### **IMPORTANT NOTE**
+
+Scripts in this directory are sourced externally and not maintained by the Dev Container spec maintainers. Do not make changes directly as they might be overwritten at any moment.
+
+## dotnet-install.sh
+
+`dotnet-install.sh` is a copy of <https://dot.net/v1/dotnet-install.sh>. ([Script reference](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script))
+
+Quick options reminder for `dotnet-install.sh`:
+
+- `--version`: `"latest"` (default) or an exact version in the form A.B.C like `"6.0.413"`
+- `--channel`: `"LTS"` (default), `"STS"`, a two-part version in the form A.B like `"6.0"` or three-part form A.B.Cxx like `"6.0.1xx"`
+- `--quality`: `"daily"`, `"preview"` or `"GA"`
+- The channel option is only used when version is 'latest' because an exact version overrides the channel option
+- The quality option is only used when channel is 'A.B' or 'A.B.Cxx' because it can't be used with STS or LTS
+
+Examples
+
+```
+dotnet-install.sh [--version latest] [--channel LTS]
+dotnet-install.sh [--version latest] --channel STS
+dotnet-install.sh [--version latest] --channel 6.0 [--quality GA]
+dotnet-install.sh [--version latest] --channel 6.0.4xx [--quality GA]
+dotnet-install.sh [--version latest] --channel 8.0 --quality preview
+dotnet-install.sh [--version latest] --channel 8.0 --quality daily
+dotnet-install.sh --version 6.0.413
+``` \ No newline at end of file