Skip to content

Commit

Permalink
Updating branding, adding dev spec
Browse files Browse the repository at this point in the history
  • Loading branch information
sfoslund committed Feb 7, 2020
1 parent 99169b2 commit 9c9c7d2
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 4 deletions.
39 changes: 39 additions & 0 deletions Documentation/dev-spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# .NET Runtime Acquisition Strategy

## Common Among All Scenarios

- Users (extension authors) ensure that they have a runtime installed by calling the `acquire` command, providing a Major.Minor version to install.
- Users are expected to call us on extension startup to ensure that the runtime exists.
- Downloaded runtimes are stored in [extension global storage](https://code.visualstudio.com/api/extension-capabilities/common-capabilities#data-storage).

## Scenarios

### First Acquisition

- Resolve version by fetching release.json
- If we are offline, we will fail here.
- Check if version has been installed previously or is currently being installed
- Fetch dotnet-install script
- Install runtime via script
- Validate installation was successful
- Return path to runtime

### Subsequent Acquisitions (No Runtime Patches)

- Resolve version with the cached release.json
- We will update release.json in the background. If we are offline this will fail silently, which is fine as we can use the cached version.
- Check if version has been installed previously or is currently being installed
- As the resolved version is already installed, return path to runtime

Note: This scenario can be conducted offline successfully.

### Subsequent Acquisitions (Runtime Patche Released)

- Resolve version with the cached release.json
- We will update release.json in the background.
- **Note**: For efficiency, we do not block on release.json acquisition. This means that we may not install the most updated runtime until the following acquisition (once the release.json with the update has been acquired and cached).
- Check if version has been installed previously or is currently being installed
- Install runtime via cached install script
- We will update the install script in the background. If we are offline this will fail silently.
- Validate installation was successful
- Return path to runtime
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# .NET Authoring Tool for Extensions (Preview)
# .NET Install Tool for Extension Authors (Preview)

This extension allows acquisition of the .NET runtime specifically for VSCode extension authors. This tool is intended to be leveraged in extensions that are written in .NET and requires .NET to boot pieces of the extension (i.e. a language server). The extension is not intended to be used directly by users to install .NET for development.
This extension allows acquisition of the .NET Core runtime specifically for VSCode extension authors. This tool is intended to be leveraged in extensions that are written in .NET and requires .NET to boot pieces of the extension (i.e. a language server). The extension is not intended to be used directly by users to install .NET for development.

**This is a very early release of this tool. If you want to test it, reach out on [GitHub](https://github.com/dotnet/vscode-dotnet-runtime/issues) to discuss being in our early beta.**

Expand Down
Binary file modified images/dotnetIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"license": "MIT",
"preview": true,
"author": "Microsoft Corporation",
"displayName": ".NET Authoring Tool for Extensions",
"description": "Allows acquisition of the .NET runtime specifically for VSCode extension authors.",
"displayName": ".NET Install Tool for Extension Authors",
"description": "Allows acquisition of the .NET Core runtime specifically for VSCode extension authors.",
"icon": "images/dotnetIcon.png",
"version": "0.1.0",
"publisher": "ms-azuretools",
Expand Down

0 comments on commit 9c9c7d2

Please sign in to comment.