Browse Source

Update version numbers and installation instructions. (#1309)

pull/1311/head
Phillip Hoff 4 years ago
committed by GitHub
parent
commit
c7bcc18b4d
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 18
      docs/getting_started.md
  2. 2
      docs/recipes/githubactions_aks.md
  3. 2
      eng/Versions.props

18
docs/getting_started.md

@ -4,28 +4,28 @@ Tye is a tool that makes developing, testing, and deploying microservices and di
## Installing Tye
1. Install [.NET Core 3.1](<https://dot.net>).
1. Install [.NET 6.0](<https://dot.net>).
> .NET Core 3.1 is required for the current release of Tye (`0.10.0`). Going forward, both recent CI builds as well as future releases of Tye will require .NET 6.
> Tye currently requires .NET 6 but earlier releases (`0.10.0` and earlier) require .NET Core 3.1.
1. Install tye via the following command:
```text
dotnet tool install -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
dotnet tool install -g Microsoft.Tye --version "0.11.0-alpha.22111.1"
```
OR if you already have Tye installed and want to update:
```text
dotnet tool update -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
dotnet tool update -g Microsoft.Tye --version "0.11.0-alpha.22111.1"
```
> If using Mac with both `arm64` and `x64` .NET SDKs, you may need to supply the `-a x64` parameter when installing Tye as it requires the x64 version of .NET Core 3.1.
> If using earlier versions of Tye on Mac with both `arm64` and `x64` .NET SDKs, you may need to supply the `-a x64` parameter when installing Tye as those versions require the x64 version of .NET Core 3.1.
>
> Example:
>
> ```
> dotnet tool install -a x64 -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
> dotnet tool install -a x64 -g Microsoft.Tye --version "0.10.0-alpha.21420.1
> ```
> If using Mac and, if getting "command not found" errors when running `tye`, you may need to ensure that the `$HOME/.dotnet/tools` directory has been added to `PATH`.
@ -48,13 +48,13 @@ Tye is a tool that makes developing, testing, and deploying microservices and di
This will install the newest available build from our CI.
```txt
dotnet tool install -g Microsoft.Tye --version "0.11.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json
dotnet tool install -g Microsoft.Tye --version "0.12.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6/nuget/v3/index.json
```
If you already have a build installed and you want to update, replace `install` with `update`:
```txt
dotnet tool update -g Microsoft.Tye --version "0.11.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json
dotnet tool update -g Microsoft.Tye --version "0.12.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6/nuget/v3/index.json
```
> :bulb: Note that the version numbers for our CI builds and released packages will usually be different.
@ -66,7 +66,7 @@ If you are using CI builds of Tye we also recommend using CI builds of our libra
<configuration>
<packageSources>
<clear />
<add key="dotnet5" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json" />
<add key="dotnet6" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6/nuget/v3/index.json" />
<add key="nuget" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>

2
docs/recipes/githubactions_aks.md

@ -61,7 +61,7 @@ Next, ensure that Tye and its dependent .NET runtime are installed.
- name: 🛠 Install Tye tools
run: |
dotnet tool install -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
dotnet tool install -g Microsoft.Tye --version "0.11.0-alpha.22111.1"
```
Using the name of the registry and the [Azure docker action](https://github.com/Azure/docker-login) to login to your registry. This step is needed prior to running the `deploy` command which will build and push the images to the registry.

2
eng/Versions.props

@ -2,7 +2,7 @@
<Project>
<PropertyGroup>
<!-- This repo version -->
<VersionPrefix>0.11.0</VersionPrefix>
<VersionPrefix>0.12.0</VersionPrefix>
<PreReleaseVersionLabel>alpha</PreReleaseVersionLabel>
<!-- Opt-out repo features -->
<UsingToolXliff>false</UsingToolXliff>

Loading…
Cancel
Save