Skip to content

Commit

Permalink
Merge pull request #129 from Shopify/update-readme-with-release-instr…
Browse files Browse the repository at this point in the history
…uctions

Update README.md with release instructions and new packagecloud source
  • Loading branch information
adrianna-chang-shopify authored Nov 3, 2020
2 parents 855fc5a + 2e49121 commit fc76896
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/ruby.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ jobs:
- name: Install dependencies
run: |
bundle config path vendor/bundle
bundle config frozen true
bundle install --jobs 4 --retry 3
- name: Set up database
run: bundle exec rails db:setup
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ A Rails engine for queuing and managing maintenance tasks.
Add this line to your application's Gemfile:

```ruby
gem 'maintenance_tasks'
source 'https://packages.shopify.io/shopify/gems' do
gem 'maintenance_tasks'
end
```

And then execute:
Expand Down Expand Up @@ -86,3 +88,13 @@ end
```

The Job class **must inherit** from `MaintenanceTasks::TaskJob`.

## Releasing new versions

This gem is published to packagecloud. The procedure to publish a new version:

* Update `spec.version` in `maintenance_tasks.gemspec`.
* Run `bundle install` to bump the `Gemfile.lock` version of the gem.
* Open a PR and merge on approval.
* Create a [release on GitHub](https://help.github.com/articles/creating-releases/) with a version number that matches the version defined in the gemspec.
* Deploy via [Shipit](https://shipit.shopify.io/shopify/maintenance_tasks/packagecloud) and see the new version on https://gems.shopify.io/packages/.

0 comments on commit fc76896

Please sign in to comment.