rbi 0.3.8 → 0.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e8a26f05eff609245be847ff291cfd456b86e0a11aa85c496bcdcbaf8c202b5b
4
- data.tar.gz: f1eb34ff26a99f6b1b20edfaec281db99559cce730e3c0cdbf0d8c75a8e6ee91
3
+ metadata.gz: 5c3c0c783365e22f77fdee8bc3ece4169fd2a5c51b6e912adc279878a1808507
4
+ data.tar.gz: 24a244adfb855ac354c3f84a9bc367c906286afc915935098df4e22db40905f2
5
5
  SHA512:
6
- metadata.gz: 9cbe3f72073f2813cef4744b57849d8725eab8ed19df9b14d7d7571f795dd90ca925645eed50f62ff86d8a387a5e845a516a7dfc097593788e9b27c6d6489edd
7
- data.tar.gz: 72e11ed844915a8965f3a0db4f76b7cb3b6e22e6eb7848bcf2f5484a415bdf79fd7c552c811b279cb006121179c8ebc1cfa58bcbe3d95e2089fec02f1f8ab8a0
6
+ metadata.gz: 1a2822c823f19508eb06c7c9e70753ef7c1284c0477c626aa986fbba2967b028c6d2dc4caede8c2f6b6d2037ff36803bd02d449d2a88a7ce07c44d2e9ddc6f4c
7
+ data.tar.gz: f93c69e41c77d06b0df42f3b65e9a64016e48a78b9d203ed8e1b364bd05aea2559a343f620d9aef5d92f0d5ade5d21bbcaeb260b0d8d2899dc8dfd23c03b5710
data/README.md CHANGED
@@ -54,10 +54,26 @@ end
54
54
 
55
55
  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
56
56
 
57
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
58
-
59
57
  This repo uses itself (`rbi`) to retrieve and generate gem RBIs. You can run `dev rbi` to update local gem RBIs with RBIs from the central repo.
60
58
 
59
+ ## Releasing
60
+
61
+ ### Bump the gem version
62
+
63
+ - [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/rbi/version.rb)
64
+ - [ ] Run `bundle install` to update the version number in `Gemfile.lock`
65
+ - [ ] Commit this change with the message `Bump version to vx.y.z`
66
+ - [ ] Push this change directly to main or open a PR
67
+
68
+ ### Create a new tag
69
+
70
+ - [ ] Locally, create a new tag with the new version number: `git tag vx.y.z`
71
+ - [ ] Push this tag up to the remote `git push origin vx.y.z`
72
+
73
+ ### Release workflow will run automatically
74
+
75
+ We have a [release workflow](https://github.com/Shopify/rbi/actions/workflows/release.yml) that will publish your new gem version to rubygems.org via [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/). This workflow must be approved by a member of the Ruby and Rails Infrastructure team at Shopify before it will run. Once it is approved, it will automatically publish a new gem version to rubygems.org and create a new GitHub release.
76
+
61
77
  ## Contributing
62
78
 
63
79
  Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rbi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Shopify/rbi/blob/master/CODE_OF_CONDUCT.md).