Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattbrictson/bundleup
A friendlier CLI for Bundler’s `update` and `outdated` commands.
https://github.com/mattbrictson/bundleup
bundler ruby
Last synced: 10 days ago
JSON representation
A friendlier CLI for Bundler’s `update` and `outdated` commands.
- Host: GitHub
- URL: https://github.com/mattbrictson/bundleup
- Owner: mattbrictson
- License: mit
- Created: 2015-12-24T17:55:23.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T13:53:05.000Z (6 months ago)
- Last Synced: 2024-05-29T12:31:33.721Z (5 months ago)
- Topics: bundler, ruby
- Language: Ruby
- Homepage:
- Size: 3.84 MB
- Stars: 191
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
📣 **I am no longer actively developing this project.** I am focusing my attention on building [mattbrictson/bundle_update_interactive](https://github.com/mattbrictson/bundle_update_interactive) instead. It has many of the same features as `bundleup`, so please check it out! In the meantime, `bundleup` will continue to receive occasional maintenance, but likely no new capabilities.
---
# bundleup
[](https://rubygems.org/gems/bundleup)
[](https://www.ruby-toolbox.com/projects/bundleup)
[](https://github.com/mattbrictson/bundleup/actions/workflows/ci.yml)
**Run `bundleup` on a Ruby project containing a Gemfile to see what gem dependencies need updating.** It is a friendlier command-line interface to [Bundler’s][bundler] `bundle update` and `bundle outdated`.
You might like bundleup because it:
- shows you exactly what gems will be updated lets you decide whether to proceed
- uses color to call your attention to important gem updates (based on [Semver][])
- lets you know when a version "pin" in your Gemfile is preventing an update
- relies on standard Bundler output and does not patch code or use Bundler internals
Here it is in action:
## Requirements
- Bundler 1.16 or later
- Ruby 3.1 or later
## Usage
Assuming you have a Ruby environment, all you need to do is install the bundleup gem:
```
gem install bundleup
```
Now, within a Ruby project you can run the bundleup command (the project needs to have a Gemfile and Gemfile.lock):
```
bundleup
```
That’s it!
Protip: Any extra command-line arguments will be passed along to `bundle update`. For example:
```
# Only upgrade development gems
bundleup --group=development
```
### Experimental: `--update-gemfile`
> 💡 This is an experimental feature that may be removed or changed in future versions.
Normally bundleup only makes changes to your Gemfile.lock. It honors the version restrictions ("pins") in your Gemfile and will not update your Gemfile.lock to have versions that are not allowed. However with the `--update-gemfile` flag, bundleup can update the version pins in your Gemfile as well. Consider the following Gemfile:
```ruby
gem 'sidekiq', '~> 5.2'
gem 'rubocop', '0.89.0'
```
Normally running `bundleup` will report that these gems are pinned and therefore cannot be updated to the latest versions. However, if you pass the `--update-gemfile` option like this:
```
$ bundleup --update-gemfile
```
Now bundleup will automatically edit your Gemfile pins as needed to bring those gems up to date. For example, bundleup would change the Gemfile to look like this:
```ruby
gem 'sidekiq', '~> 6.1'
gem 'rubocop', '0.90.0'
```
Note that `--update-gemfile` will _not_ modify Gemfile entries that contain a comment, like this:
```ruby
gem 'sidekiq', '~> 5.2' # our monkey patch doesn't work on 6.0+
```
### Integrate bundlup in a script
`Bundleup::CLI` gives you two methods to track updated and pinned gems:
```ruby
cli = Bundleup::CLI.new([])
cli.run
cli.updated_gems
# > ["rubocop"]
cli.pinned_gems
# > ["rake"]
```
You can then easily create scripts to perform any actions such as running tests, running rubocop, or commit changes.
```ruby
cli = Bundleup::CLI.new([])
cli.run
if cli.updated_gems.any?
system "bundle exec rspec"
elsif cli.updated_gems.include?("rubocop")
system "bundle exec rubocop"
end
if cli.updated_gems.any?
system "git commit -m \"Update gems dependencies\" -- Gemfile.lock"
end
```
## How bundleup works
bundleup starts by making a backup copy of your Gemfile.lock. Next it runs `bundle check` (and `bundle install` if any gems are missing in your local environment), `bundle list`, then `bundle update` and `bundle list` again to find what gems versions are being used before and after Bundler does its updating magic. (Since gems are actually being installed into your Ruby environment during these steps, the process may take a few moments to complete, especially if gems with native extensions need to be compiled.)
Finally, bundleup runs `bundle outdated` to see the gems that were _not_ updated due to Gemfile restrictions.
After displaying its findings, bundleup gives you the option of keeping the changes. If you answer "no", bundleup will restore your original Gemfile.lock from its backup, leaving your project untouched.
## Roadmap
bundleup is in maintenance mode; no new features are planned.
## Contributing
Code contributions are welcome! Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
[bundler]: http://bundler.io
[semver]: http://semver.org