Skip to content

Commit fc76896

Browse files
Merge pull request #129 from Shopify/update-readme-with-release-instructions
Update README.md with release instructions and new packagecloud source
2 parents 855fc5a + 2e49121 commit fc76896

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

.github/workflows/ruby.yml

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
- name: Install dependencies
2525
run: |
2626
bundle config path vendor/bundle
27+
bundle config frozen true
2728
bundle install --jobs 4 --retry 3
2829
- name: Set up database
2930
run: bundle exec rails db:setup

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ A Rails engine for queuing and managing maintenance tasks.
77
Add this line to your application's Gemfile:
88

99
```ruby
10-
gem 'maintenance_tasks'
10+
source 'https://packages.shopify.io/shopify/gems' do
11+
gem 'maintenance_tasks'
12+
end
1113
```
1214

1315
And then execute:
@@ -86,3 +88,13 @@ end
8688
```
8789

8890
The Job class **must inherit** from `MaintenanceTasks::TaskJob`.
91+
92+
## Releasing new versions
93+
94+
This gem is published to packagecloud. The procedure to publish a new version:
95+
96+
* Update `spec.version` in `maintenance_tasks.gemspec`.
97+
* Run `bundle install` to bump the `Gemfile.lock` version of the gem.
98+
* Open a PR and merge on approval.
99+
* Create a [release on GitHub](https://help.github.com/articles/creating-releases/) with a version number that matches the version defined in the gemspec.
100+
* Deploy via [Shipit](https://shipit.shopify.io/shopify/maintenance_tasks/packagecloud) and see the new version on https://gems.shopify.io/packages/.

0 commit comments

Comments
 (0)