diff --git a/docs/README.md b/docs/README.md index 57a036d2..6545e631 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,8 @@ |**[Logging with Elastic Stack](recipes/logging_elastic.md)** | Using Elastic Stack for logging. |**[Logging with Seq](recipes/logging_seq.md)** | Using Seq for logging. |**[Using Dapr with Tye](recipes/dapr.md)** | Using `tye` for local development and deployment with a [Dapr](https://dapr.io) application. - +|**[Using Azure Functions with Tye](recipes/azure_functions.md)** | Using `tye` for local development with Azure Functions +|**[AKS and Github Actions](recipes/githubactions_aks.md)** | Learn how to deploy an application to AKS with Github Actions ## Reference documentation diff --git a/docs/getting_started.md b/docs/getting_started.md index 37654954..63434ef0 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -8,13 +8,13 @@ Tye is a tool that makes developing, testing, and deploying microservices and di 2. Install tye via the following command: ```text - dotnet tool install -g Microsoft.Tye --version "0.3.0-alpha.20319.3" + dotnet tool install -g Microsoft.Tye --version "0.4.0-alpha.20371.1" ``` OR if you already have Tye installed and want to update: ```text - dotnet tool update -g Microsoft.Tye --version "0.3.0-alpha.20319.3" + dotnet tool update -g Microsoft.Tye --version "0.4.0-alpha.20371.1" ``` ## Next steps @@ -28,13 +28,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.4.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json +dotnet tool install -g Microsoft.Tye --version "0.5.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/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.4.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json +dotnet tool update -g Microsoft.Tye --version "0.5.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json ``` > :bulb: Note that the version numbers for our CI builds and released packages will usually be different. diff --git a/docs/recipes/githubactions_aks.md b/docs/recipes/githubactions_aks.md index 19e90eca..d42be9cb 100644 --- a/docs/recipes/githubactions_aks.md +++ b/docs/recipes/githubactions_aks.md @@ -1,6 +1,6 @@ # Deployment to Azure Kubernetes Service using GitHub Actions -Github Actions gives you the flexibilty to build automated workflows and deployments based on actions. There are now Kubernetes actions to get deployments to AKS. This is a simple recipe on how to use tye with Azure Kuberntes Service, Azure Container Service and GitHub Actions. +Github Actions gives you the flexibility to build automated workflows and deployments based on actions. There are now Kubernetes actions to get deployments to AKS. This is a simple recipe on how to use tye with Azure Kubernetes Service, Azure Container Service and GitHub Actions. ## Setting up AKS @@ -138,7 +138,7 @@ jobs: - name: 🛠 Install Tye tools run: | - dotnet tool install -g Microsoft.Tye --version "0.3.0-alpha.20319.3" + dotnet tool install -g Microsoft.Tye --version "0.4.0-alpha.20371.1" - name: 🔐 Login to ACR uses: Azure/docker-login@v1 diff --git a/docs/tutorials/hello-tye/00_run_locally.md b/docs/tutorials/hello-tye/00_run_locally.md index 0678841e..bfa72a37 100644 --- a/docs/tutorials/hello-tye/00_run_locally.md +++ b/docs/tutorials/hello-tye/00_run_locally.md @@ -126,7 +126,7 @@ Now that we have two applications running, let's make them communicate. By defau 4. Add a reference to the `Microsoft.Tye.Extensions.Configuration` package to the frontend project ```txt - dotnet add frontend/frontend.csproj package Microsoft.Tye.Extensions.Configuration --version "0.3.0-*" + dotnet add frontend/frontend.csproj package Microsoft.Tye.Extensions.Configuration --version "0.4.0-*" ``` 5. Now register this client in `frontend` by adding the following to the existing `ConfigureServices` method to the existing `Startup.cs` file: diff --git a/eng/StagingRelease.md b/eng/StagingRelease.md new file mode 100644 index 00000000..0eb01370 --- /dev/null +++ b/eng/StagingRelease.md @@ -0,0 +1,13 @@ +# Guide on releasing tye + +## Releasing binary + +1. Grab latest build off dnceng/internal. +2. Download it locally. +3. `dotnet nuget push --source https://api.nuget.org/v3/index.json -k + +## Updating repo to next version + +- Update [getting started](/docs/getting_started.md) and other places in tutorial to just released version. +- Update [Working with CI builds](docs/getting_started.md) with next version. +- Update [Version.props](eng/Versions.props) to next version. \ No newline at end of file diff --git a/eng/Versions.props b/eng/Versions.props index 12c2fd41..1f9eb374 100644 --- a/eng/Versions.props +++ b/eng/Versions.props @@ -2,7 +2,7 @@ - 0.4.0 + 0.5.0 alpha false