Skip to content

Commit 516a709

Browse files
authored
docs: update RELEASING.md (#1763)
1 parent 37d9d9a commit 516a709

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

RELEASING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,25 @@
55
3. Run `bundle install` to ensure the `Gemfile.lock` file is up to date.
66
4. Update `NEWS.md` to reflect the changes since last release.
77
A useful GitHub URL to compare the changes is:
8-
<https://github.com/thoughtbot/factory_bot/compare/vLAST_VERSION...main>
8+
`https://github.com/thoughtbot/factory_bot/compare/vLAST_VERSION...main`
99
5. Commit the changes.
1010
Note: As there shouldn't be code changes, CI doesn't need to run.
1111
You can add `[ci skip]` to the commit message to skip it.
12-
6. Tag the release: `git tag -s vVERSION`
12+
6. Create a Pull Request, get it reviewed, and merge it to the `main` branch once approved.
13+
7. Back on your machine, switch to the `main` branch and tag the latest commit with the release version: `git tag -s vVERSION`
1314
- We recommend the [_quick guide on how to sign a release_] from git ready.
14-
7. Push changes: `git push && git push --tags`
15-
8. Build and publish:
15+
8. Push your changes: `git push && git push --tags`
16+
9. If you haven't already, add yourself as an owner of the `factory_bot` gem on [rubygems.org](https://rubygems.org/) using [the guide in the thoughtbot handbook](https://github.com/thoughtbot/handbook/blob/main/operations/services/rubygems.md#managing-rubygems)
17+
10. Build and publish the gem:
1618

1719
```bash
1820
gem build factory_bot.gemspec
1921
gem push factory_bot-VERSION.gem
2022
```
2123

22-
9. Add a new GitHub release using the recent `NEWS.md` as the content. Sample
23-
URL: <https://github.com/thoughtbot/factory_bot/releases/new?tag=vVERSION>
24-
10. Announce the new release, making sure to say "thank you" to the contributors who helped shape this version!
25-
thoughtbotters can refer to the handbook for announcements guidelines.
24+
11. On GitHub, add a new release using the recent `NEWS.md` as the content. Sample
25+
URL: `https://github.com/thoughtbot/factory_bot/releases/new?tag=vVERSION`
26+
12. Announce the new release, making sure to say "thank you" to the contributors who helped shape this version!
27+
thoughtbotters can refer to the handbook for announcements guidelines.
2628

2729
[_quick guide on how to sign a release_]: http://gitready.com/advanced/2014/11/02/gpg-sign-releases.html

0 commit comments

Comments
 (0)