Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Contributing.md for Prepare Release Section #18441

Merged
merged 2 commits into from
Feb 9, 2021
Merged

Update Contributing.md for Prepare Release Section #18441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54086d7
Update Contributing.md
chidozieononiwu Feb 4, 2021
d5443ba
Remove eng/scripts/Prepare-Release.ps1
chidozieononiwu Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,17 +292,14 @@ To consume the a dev package set the exact version in your project or to consume

## Preparing to a release of the new library

To update the CHANGELOG, version and release tracking information use the `.\eng\scripts\Prepare-Release.ps1` script.

The syntax is `.\eng\scripts\Prepare-Release.ps1 <package_name>`. The script would ask you for a new version or `NA` if you are not releasing in this cycle.
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.

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 Azure.Core
.\eng\scripts\Prepare-Release.ps1 Azure.Core -ReleaseDate 2020-10-01
.\eng\scripts\Prepare-Release.ps1 -PackageName "Azure.Core" -SerivceDirectory "core" -ReleaseDate "2020-10-01"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make this more simple we don't require "-PackageName" or "-ServiceDirectory" passed so I'd just remove those.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know we talked about this but if someone doesn't pass ServiceDirectory will the command still work as is?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does.

Copy link
Contributor

@pakrym pakrym Feb 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the issue matching doesn't seem to work:

.\eng\scripts\Prepare-Release.ps1 Azure.core
Source directory core

Assuming release is in February with release date 2021-02-09

Latest released version 1.8.1, library type GA
Input the new version, NA if you are not releasing, or press Enter to use use current project version '1.9.0':

Detected released type Minor

Updating versions to 1.9.0 with date 2021-02-09
Current Version: 1.9.0
WARNING: Version [1.9.0] is already present in change log with specificed ReleaseStatus [(2021-02-09)]. No Change made.
New Version: 1.9.0

The following work items exist:
Input the work item ID or press Enter to use ' - ' (fuzzy matched based on title):

Is it true that it's based on the title?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm dumb and am running the wrong script.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using only the package name doesn't work:

.\eng\common\scripts\Prepare-Release.ps1 Azure.Core
Get-PkgProperties: D:\github\azure\net\eng\common\scripts\Prepare-Release.ps1:30
Line |
  30 |  … perties -PackageName $PackageName -ServiceDirectory $serviceDirectory
     |                                                        ~~~~~~~~~~~~~~~~~
     | Cannot bind argument to parameter 'ServiceDirectory' because it is an empty string.

Source directory [  ]

Assuming release is in February with release date 02/09/2021
Input the new version, or press Enter to use use current project version '':

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. @chidozieononiwu is going to make some changes to make that optional.

```

## On-boarding New Libraries
Expand Down
295 changes: 0 additions & 295 deletions eng/scripts/Prepare-Release.ps1
View file
Open in desktop

This file was deleted.