Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 2.29 KB

RELEASE.md

File metadata and controls

34 lines (23 loc) · 2.29 KB

How to Release Packages

This document covers how to do an official release of a package from this repository.

NOTE: You can only release one package at a time. If you need to release multiple packages, you will need to repeat the steps for each one.

Create GitHub release

Releases are tagged with the same version as what is built. However, you must determine ahead of time which version will be used. To do this, build the repository from the main branch and note which version was used.

D:\MSBuildSdks>msbuild dirs.proj
Microsoft (R) Build Engine version 15.7.177.53362 for .NET Framework
Copyright (C) Microsoft Corporation. All rights reserved.

  Successfully created package 'D:\MSBuildSdks\src\NoTargets\bin\Debug\Microsoft.Build.NoTargets.1.0.34-g588830f6de.nupkg'.
  Successfully created package 'D:\MSBuildSdks\src\CentralPackageVersions\bin\Debug\Microsoft.Build.CentralPackageVersions.1.0.34-g588830f6de.nupkg'.
  Successfully created package 'D:\MSBuildSdks\src\Traversal\bin\Debug\Microsoft.Build.Traversal.1.0.34-g588830f6de.nupkg'.
  
Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:05.37

In this example, the version of Microsoft.Build.CentralPackageVersions is 1.0.34.

Create a new release at https://github.com/Microsoft/MSBuildSdks/releases. The tag should be in the format of packageid.version. Using the above example, the tag would be Microsoft.Build.CentralPackageVersions.1.0.34. Release notes should contain the important commits that are relevant to that release. You can leave out commits that are not customer facing.

VSTS Build

Publishing the release will push a git tag which triggers an official build. This build definition will also create signed packages and upload them as artifacts.

VSTS Release

Once a build is complete, a VSTS Release is automatically triggered which will queue up a task to push the package to nuget.org. The publish task must be manually approved by a team member. Watch for the email notification or manually find the waiting release to approve the task. Following approval, the package should be available within 15 minutes.