You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CHANGELOG.md
+27-1
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,28 @@
1
+
# Change Log
2
+
3
+
## Apology
4
+
5
+
The tooling to support our old way of doing the change log doesn't work anymore, and we don't have a better solution, so this change log has become unreliable since version 4.5.0. Please refer to the commit history if you need to debug changes.
Copy file name to clipboardexpand all lines: README.md
+3-5
Original file line number
Diff line number
Diff line change
@@ -31,20 +31,18 @@ Some other nice things that `bootstrap_form` does for you are:
31
31
32
32
## Installation
33
33
34
-
Install Bootstrap 5. There are many ways to do this, depending on the asset pipeline you're using in your Rails application. There is a gem that works with Sprockets. So in a brand new Rails 7.0 application created _without_ the `--webpacker` option, add the `bootstrap` gem to your `Gemfile`:
34
+
Install Bootstrap 5. There are many ways to do this, depending on the asset pipeline you're using in your Rails application. One way is to use the gem that works with Sprockets. To do so, in a brand new Rails 7.0 application created _without_ the `--webpacker` option, add the `bootstrap` gem to your `Gemfile`:
35
35
36
36
```ruby
37
37
gem "bootstrap", "~> 5.0"
38
38
```
39
39
40
40
And follow the remaining instructions in the [official bootstrap installation guide](https://github.com/twbs/bootstrap-rubygem#a-ruby-on-rails) for setting up `application.scss` and `application.js`.
41
41
42
-
You also need to use the SASS preprocessor, so uncomment the following line in your `Gemfile`:
Copy file name to clipboardexpand all lines: RELEASING.md
+5-10
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,15 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
6
6
7
7
* You must have commit rights to the bootstrap_form repository.
8
8
* You must have push rights for the bootstrap_form gem on rubygems.org.
9
-
* You must be using Ruby >= 2.5.
10
-
* Your GitHub credentials must be available to Chandler via `~/.netrc` or an environment variable, [as explained here](https://github.com/mattbrictson/chandler#2-configure-credentials).
9
+
* You must be using a Ruby version that is not end-of-life.
11
10
12
11
## How to release
13
12
14
-
1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing.
15
-
2.**Ensure the tests are passing by running `bundle exec rake`.**
13
+
1. Run `BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle update` to make sure that you have all the gems necessary for testing and releasing.
14
+
2.**Ensure the tests are passing by running `BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle update`.** (Currently this step shows a lot of warnings about method redefinitions, but otherwise everything must be green before release.)
16
15
3. Determine which would be the correct next version number according to [semver](http://semver.org/).
17
16
4. Update the version in `./lib/bootstrap_form/version.rb`.
18
-
5. Update the `CHANGELOG.md` (for an illustration of these steps, refer to the [4.0.0.alpha1 commit](https://github.com/bootstrap-ruby/bootstrap_form/commit/8aac3667931a16537ab68038ec4cebce186bd596#diff-4ac32a78649ca5bdd8e0ba38b7006a1e) as an example):
19
-
* Rename the Pending Release section to `[version][] (date)` with appropriate values `version` and `date`
20
-
* Remove the "Your contribution here!" bullets from the release notes
21
-
* Add a new Pending Release section at the top of the file with a template for contributors to fill in, including "Your contribution here!" bullets
22
-
* Add the appropriate GitHub diff links to the footer of the document
17
+
5. Update the GitHub diff links at the beginning of `CHANGELOG.md` (The pattern should be obvious when you look at them).
23
18
6. Update the installation instructions in `README.md` to use the new version.
24
19
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.
25
-
8. Run `bundle exec rake release`; this will tag, push to GitHub, publish to rubygems.org, and upload the latest CHANGELOG entry to the [GitHub releases page](https://github.com/bootstrap-ruby/bootstrap_form/releases).
20
+
8. Run `bundle exec rake release`; this will tag, push to GitHub, and publish to rubygems.org.
0 commit comments