search

shipshapecode / ember-cli-release

Ember CLI addon for versioned release management
MIT License
90 stars 18 forks source link

How to create a full-fledged GitHub release #26

Open elwayman02 opened 8 years ago

elwayman02 commented 8 years ago

Right now ember release seems to create the following undesirable situation:

releases_ _plyfe_ember-social

You'll note that github adds them as releases but doesn't show the message or show that they are the latest release

What I want is for the command to generate an actual release ala:

releases_ _elwayman02_ember-cli-opinionated

Am I missing some config option that will do this?

rwjblue commented 8 years ago

ember release does git tagging and pushes that to github (which they display as you have in the first image). This repo does not use the GH API to create "GitHub Release" descriptions and whatnot (the latter screenshots). It should be fairly straightforward to add in as a afterPush hook (see this example that publishes to npm upon ember release for an example of how to use the hook).

I'm not certain that there is a good default to use for the description and whatnot, so I don't know that we can do this automatically if we detect that the repo is a github repo...

slindberg commented 8 years ago

"Full-fledged" Github releases are metadata associated with a tag that resides only in Github (not in your git repo). AFAIK, to create them requires using Github's API, which I haven't spent much time looking into.

I'm not opposed to adding support for this out of the box per-se, but it is something that is highly dependent on the particular project (so would be difficult to make a one-size-fits-all solution). For instance, in our app we create Github releases from tags created by ember-cli-release with lots more information about the release.

elwayman02 commented 8 years ago

@slindberg maybe this would be best added as an example in the readme, much like the auto-publish code. I can investigate this a bit next week maybe.

slindberg commented 8 years ago

@elwayman02 :+1:

I haven't given it much thought because I've never used the Github API and didn't want to deal with authentication. If you can whip up an example, I think it'd be an excellent addition to the readme.

MiguelMadero commented 7 years ago

I tried semantic-release-cli and it does that. I think we can bring some of those ideas to this addon.

Also, is there a reason why publish isnt the default for public modules?