This projects helps you generating release notes for the awesome Github Release Notes feature.
addSbtPlugin("de.mukis" % "pitchman-release-notes-generator" % "0.1")
Thanks to autoplugins you can now just run
releaseNotes v1.0 v2.0
to generate release notes in your target folder.
releaseNotesLanguageby defaultMarkDownreleasenotesFilenameby defaultreleaseNotes.mdreleaseNotesPreviousTag, set by thereleaseNotescommandreleaseNotesCurrentTag, set by thereleaseNotescommandrenderCommiters, should a commiter list be rendered.trueby defaultrenderPullRequests, should a pull request list be renderedtrueby defaultrenderFixedIssues, should a fix issues list be renderedtrueby default
Furthermore you can define a few more things in the Pitchman scope.
target in Pitchman. Where to put the releaseNotes file. By defaulttarget in Compileorgnization in Pitchman. Used as github user, or organization in github/user/repo. By defaultorganization in Compilename in Pitchman. Used as github project name in github/user/repo. By defaultname in Compile
- Update the highlights notes in
hand-written.md. - run
sbt -Dfile.encoding=UTF-8 console, and then:
runMain pitchman.github.Generator -gh user/repo -p v1.0 -n v1.1 -l /home/user/git/repo