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.

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

Include GitHub release notes in generated NuGet packages #40

Open
lholman opened this issue Feb 11, 2015 · 2 comments
Open

Include GitHub release notes in generated NuGet packages #40

lholman opened this issue Feb 11, 2015 · 2 comments

Comments

@lholman
Copy link
Owner

lholman commented Feb 11, 2015

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 lholman added this to the v1.1 milestone Feb 11, 2015
@lholman lholman modified the milestones: v1.1, v1.2 Jul 9, 2015
@lholman
Copy link
Owner Author

lholman commented Jul 13, 2015

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

@lholman lholman changed the title Add release notes to OneBuild NuGet package when publishing Add release notes to OneBuild NuGet package Jul 15, 2015
@lholman
Copy link
Owner Author

lholman commented Jul 15, 2015

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.

@lholman lholman changed the title Add release notes to OneBuild NuGet package Include GitHub release notes in generated NuGet packages Jul 15, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant