search

elm-lang / elm-package

Command line tool to share Elm libraries
BSD 3-Clause "New" or "Revised" License
214 stars 66 forks source link

After bump, suggest steps for release #159

Open mgold opened 8 years ago

mgold commented 8 years ago

It's somewhat tedious to always remember that once I run elm package bump successfully, I need to run (assume I bumped to 1.7.0):

git add elm-package.json
git commit -m "1.7.0"
git tag 1.7.0
git push --follow-tags
elm package publish

This is nothing new for me (except for --follow-tags, because --tags won't push branches), but for someone who is new to git or even elm packages, printing this out after bumping would be really helpful.

I suppose the one caveat is that if there are source files uncommitted, the tagged and released version won't match what's on the author's machine. So maybe git add -u then?

It should be a simple matter of adding things to this file. I can send a PR if you like.

mgold commented 8 years ago

I've tried --follow-tags and it didn't actually push the tags. We should probably suggest git push and git push --tags separately.

For 1.0.0, the add command can be git add *.elm */*.elm elm-package.json README.md. Again it's a suggestion, people who know how to use git will take it as such, but it's a reasonable command to add things for the first commit.

mgold commented 8 years ago

git push origin master 1.7.0 seems to work. We might also verify that the user is on master.

igrep commented 8 years ago

FYI. Rubygem's rake release command, which Bundler providers, checks if there're no non-commited file before tagging and pushing. Ref: https://github.com/bundler/bundler/blob/master/lib/bundler/gem_helper.rb