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

Notes on how to release a new gem version #117

Merged
merged 2 commits into from
Feb 21, 2014
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,23 @@ bundle
rake test
```

## Releasing a new version

This section is for gem maintainers to cut a new version of the gem.

* update lib/html/pipeline/version.rb to next version number X.X.X following [semver](http://semver.org).
* update CHANGELOG.md. Get latest changes with `git log --oneline vLAST_RELEASE..HEAD | grep Merge`
* on the master branch, run:

```sh
$ git commit -m "bump vX.X.X"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like @rsanheim's idea of removing $, so the lines are copy/pastable. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just automate the whole thing like we do for Octokit?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pengwynn love it. Commit incoming.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for automation.

$ git tag vX.X.X
$ git push origin master
$ git push --tags
$ gem build html-pipeline.gemspec
$ gem push html-pipeline-X.X.X.gem
```

## Contributing

1. [Fork it](https://help.github.com/articles/fork-a-repo)
Expand Down