Netflix / unleash

Professionally publish your JavaScript modules in one keystroke

Home Page:http://netflix.github.io/unleash/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Populate Github release with changelog for each tag / release that is created

micahr opened this issue · comments

Adding the changelog for a release to the releases tab in Github would be very helpful. The changelog file is useful, but not everyone checks it. Adding the changelog notes plus allowing for a Title to be provided when "unleashing" a new release would be a nice addition.

@micahr that would be really cool, never thought of that. Thanks for the suggestion.

👍

  • create github app for token et al
  • obtain git(hub) user
  • ensure repo-type/repoType is github
  • check if user passed title, come up with default otherwise (version, name, commit et al)
  • check if user passed body, use CHANGELOG entries otherwise
  • determine github org & repo name from git remote
  • use tag name used already
  • pass all of the above to ghreleases#create

https://www.npmjs.com/package/ghreleases
https://developer.github.com/v3/repos/releases/#create-a-release

Great job you are doing there!

Just a thought, but instead of going through all the GitHub-specific stuff, what about if the changelog (perhaps just for the last release) is added to the commit message for the tag? This would (a) not require any GitHub auth, but would also support other git providers (BitBucket, GitLab, etc). I've tested with `git tag -m "some message" and I see that GitHub doesn't support markdown in the tag message, but it does show the message upon expanding the ellipsis next to the tag name.

btw, thanks for unleash -- I've written my own release stuff with gulp before, but this is (a) way simple to use and (b) does the tagging bit that I never got to 👍