From 427ad86654ec2016145df0c2175e18113b4faee1 Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Wed, 28 Apr 2021 11:24:50 -0700 Subject: [PATCH] Update prepare-release docs --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17779f9a9dacf..6a6902f17d337 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -324,15 +324,16 @@ As you can see in the example below, we want to use the `Azure.Data.Tables` vers ## Preparing a new library release -To prepare a package for release you should make use of `.\eng\common\scripts\Prepare-Release.ps1` script passing it appropriate arguments for the package intended for release as well as the release date. This script will correctly update the package version in the repo as well as update DevOps release work items for that release. +To prepare a package for release you should make use of `.\eng\common\scripts\Prepare-Release.ps1` script passing it appropriate arguments for the package intended for release. This script will correctly update the package version and changelog in the repo as well as update the DevOps release work items for that release. -If you are releasing out-of-band please use the `-ReleaseDate` parameter to specify the release data. `ReleaseDate` should be in `yyyy-MM-dd` format. - -Example invocations: - -```powershell -.\eng\scripts\Prepare-Release.ps1 -PackageName "Azure.Core" -SerivceDirectory "core" -ReleaseDate "2020-10-01" ``` +.\eng\common\scripts\Prepare-Release.ps1 [] [] [-ReleaseTrackingOnly] +``` + +- `` - Should match the full exact package name for the given ecosystem (i.e. "Azure.Core", "azure-core", "@azure/core", etc). +- `` - Optional: Should be the exact directory name where the package resides in the repo. This is usually the same as the service name in most cases (i.e. "sdk" e.g. "core"). The parameter is optional and if provided will help speed-up the number of projects we have to parse to find the matching package project. +- `` - Optional: provide a specific date for when you plan to release the package. If one isn't given then one will be calculated based on the normal monthly shipping schedule. +- `` - Optional: Switch that if passed will only update the release tracking data in DevOps and not update any versioning info or do validation in the local repo. ## On-boarding New Libraries @@ -523,4 +524,4 @@ For more information on how we version see [Versioning](https://github.com/Azure ## Breaking Changes -For information about breaking changes see [Breaking Change Rules](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md) \ No newline at end of file +For information about breaking changes see [Breaking Change Rules](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md)