search

lholman / OneBuild

Convention based PowerShell build for .NET http://lholman.github.io/OneBuild/
Apache License 2.0
17 stars 2 forks source link

Include GitHub release notes in generated NuGet packages #40

Open lholman opened 9 years ago

lholman commented 9 years ago

Leaning on something I previously implemented for a different library over here

There's currently no easy way for people to know what they're getting in a new release of the OneBuild nuget package.

image

Regardless of the source of the release notes we require them auto populated in to the nuspec releaseNotes element during the Invoke-Commit phase of OneBuild so they appear on nuget.org as well as in the .nuspec file, like so.

image

lholman commented 9 years ago

It goes without saying that this feature should be available for the solutions that OneBuild is building.

lholman commented 9 years ago

Slightly de-scoping here. This implementation will add the following tasks to OneBuild.build.ps1 which will be be run as dependencies of the New-Packages task.

  1. Get-GitHubRelease - To retrieve the highest numbered matching Release from Github for the current [major].[minor] build number found in VersionNumber.xml. Conditionally runs only if a value is provided for the -githubApiKey parameter
  2. Update-ReleaseNotesFromGithub - Updates the empty '' element within all .nuspec file(s), if the empty element does not exist the release notes will not be added.

Out of scope: Any automatic updating of or publishing of the GitHub release via the GitHub API.