https://github.com/stefansundin/github-release-party

:gem: :octocat: Create GitHub releases when you deploy to Fly. (Gem)
https://github.com/stefansundin/github-release-party

gem github heroku

Last synced: 18 days ago
JSON representation

:gem: :octocat: Create GitHub releases when you deploy to Fly. (Gem)

• Host: GitHub
• URL: https://github.com/stefansundin/github-release-party
• Owner: stefansundin
• Created: 2015-04-27T06:21:39.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-01-06T05:20:17.000Z (10 months ago)
• Last Synced: 2024-10-11T00:54:45.244Z (about 1 month ago)
• Topics: gem, github, heroku
• Language: Ruby
• Homepage: https://rubygems.org/gems/github-release-party
• Size: 46.9 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# github-release-party

> Automatically create GitHub releases when you deploy.

I use this gem to automatically create GitHub releases when I deploy. Creating releases helps your users/coworkers/boss to keep up with what's new.

The gem includes rake tasks to deploy to Fly and Heroku. Please submit any improvements as issues.

Example result:

- Release page: https://github.com/stefansundin/rssbox/releases

- RSS Feed: https://github.com/stefansundin/rssbox/releases.atom

## Installation

### Setup

You first need to [create a GitHub access token](https://github.com/settings/tokens) to create the releases (limit the scope to `repo`). Keep your token secure (don't put it in public repos).

You need to set the environment variable `GITHUB_RELEASE_TOKEN` to token. A good place to do this is in your `.bash_profile`:

```bash

export GITHUB_RELEASE_TOKEN=token12345

```

### App

Add the gem to your Gemfile:

```ruby

group :development do

  gem "github-release-party", require: false

end

```

This gem is cryptographically signed, you can verify the installation with:

```bash

gem cert --add <(curl -Ls https://raw.githubusercontent.com/stefansundin/github-release-party/main/certs/stefansundin.pem)

gem install github-release-party -P MediumSecurity

```

Require the `fly` task in your `Rakefile`:

```ruby

environment = ENV["APP_ENV"] || ENV["RACK_ENV"] || "development"

if environment == "development"

  require "github-release-party/tasks/fly"

end

```

Then deploy with:

```bash

rake deploy

```

You also get `rake deploy:force`, `rake deploy:tag`, and `rake deploy:retag`.

When deploying, a tag `fly/vXXX` (where `XXX` is the Fly version number) will be created, and then a GitHub release will be created for it.

`rake deploy:tag` can be run if you deployed to fly manually.

If this gem updates the message format it uses for the releases, you can run `rake deploy:retag` to update the text in the tags and releases.

### Heroku

_Note: I no longer use Heroku so there are no guarantees that this will continue to work._

Require the `heroku` task in your `Rakefile`:

```ruby

environment = ENV["APP_ENV"] || ENV["RACK_ENV"] || "development"

if environment == "development"

  require "github-release-party/tasks/heroku"

end

```

In normal use, the Heroku toolbelt is not required. The release number is read from the git push output. Your Heroku remote must be named `heroku`.