Skip to content

Commit 9b0a5ab

Browse files
committed
Updated RELEASING.md with section about creating a release in GitHub.
1 parent 2324a11 commit 9b0a5ab

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ https://github.com/bootstrap-ruby/bootstrap_form/releases
88

99
- [Pending Release](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.2.0...HEAD)
1010
- [5.2.1](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.2.0...v5.2.1)
11-
[Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-05-20T23%3A59..2023-05-23T10%3A00)
11+
[Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-05-20T23%3A59..2023-05-23T10%3A00)
1212
- [5.2.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.1.0...v5.2.0)
13-
[Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2022-06-25T17%3A22..2023-05-20T23%3A59)
13+
[Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2022-06-25T17%3A22..2023-05-20T23%3A59)
1414
- [5.1.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.0.0...v5.1.0)
15-
[Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2021-11-12T05%3A58..2022-06-25T17%3A22)
15+
[Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2021-11-12T05%3A58..2022-06-25T17%3A22)
1616
- [5.0.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.5.0...v5.0.0)
1717
- [4.5.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.4.0...v4.5.0)
1818
- [4.4.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.3.0...v4.4.0)

RELEASING.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,23 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
1717

1818
BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle exec rake test
1919

20-
2. **Ensure the demo tests are passing by running**
20+
3. **Ensure the demo tests are passing by running**
2121

2222
cd demo
2323
bundle update
2424
bundle exec rake test:all
2525

26-
3. Determine which would be the correct next version number according to [semver](http://semver.org/).
27-
4. Update the version in `./lib/bootstrap_form/version.rb`.
28-
5. Update the GitHub diff links at the beginning of `CHANGELOG.md` (The pattern should be obvious when you look at them).
29-
6. Update the installation instructions in `README.md` to use the new version.
30-
7. Commit the CHANGELOG and version changes in a single commit; the message should be "Preparing vX.Y.Z" where `X.Y.Z` is the version being released.
31-
8. Run `bundle exec rake release`; this will tag, push to GitHub, and publish to rubygems.org.
26+
4. Determine which would be the correct next version number according to [semver](http://semver.org/).
27+
5. Update the version in `./lib/bootstrap_form/version.rb`.
28+
6. Update the GitHub diff links at the beginning of `CHANGELOG.md` (The pattern should be obvious when you look at them).
29+
7. Update the installation instructions in `README.md` to use the new version.
30+
8. Commit the CHANGELOG and version changes in a single commit; the message should be "Preparing vX.Y.Z" where `X.Y.Z` is the version being released.
31+
9. Run `bundle exec rake release`; this will tag, push to GitHub, and publish to rubygems.org.
32+
10. Go to https://github.com/bootstrap-ruby/bootstrap_form/releases and create the new release and add release notes by clicking the "Generate release notes" button.
33+
Add the link of closed issues from CHANGELOG.
34+
Group the commits in sections:
35+
* ### New features
36+
* ### Bugfixes
37+
* ### Performance
38+
* ### Documentation
39+
* ### Development

0 commit comments

Comments
 (0)