Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/MaximeD/gem_updater

Update gems in your Gemfile and fetch their changelogs
https://github.com/MaximeD/gem_updater

bundler changelog gemfile ruby update

Last synced: 3 days ago
JSON representation

Update gems in your Gemfile and fetch their changelogs

Lists

README 

        
[![Version](https://img.shields.io/gem/v/gem_updater.svg?style=flat)](https://rubygems.org/gems/gem_updater)

[![Build Status](https://github.com/MaximeD/gem_updater/actions/workflows/ruby.yml/badge.svg)](https://github.com/MaximeD/gem_updater/actions/workflows/ruby.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/74dc27b2f9635ecb851a/maintainability)](https://codeclimate.com/github/MaximeD/gem_updater/maintainability)

[![Codacy Quality Badge](https://app.codacy.com/project/badge/Grade/6c95225b2b7249b7a723e847094a2c21)](https://www.codacy.com/gh/MaximeD/gem_updater/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MaximeD/gem_updater&utm_campaign=Badge_Grade)

[![Codacy Coverage Badge](https://app.codacy.com/project/badge/Coverage/6c95225b2b7249b7a723e847094a2c21)](https://www.codacy.com/gh/MaximeD/gem_updater/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MaximeD/gem_updater&utm_campaign=Badge_Coverage)

[![Inline docs ](http://inch-ci.org/github/MaximeD/gem_updater.svg?style=flat)](http://inch-ci.org/github/MaximeD/gem_updater)



#  GemUpdater: update your gemfile and retrieve changelogs



Every week or so, you wish to update your `Gemfile`,

to do so, you just have to launch `bundle update`.



Problem is updates *may* break things.

And obviously you need to know what may have broke before pushing your code to production.

Before running your test suite and checking everything is fine,

the first thing you do is probably to look for the changelogs of updated gems.



This process can be quite time consumming:

you need to check on the internet for every updated gems, find where their changelog is hosted,

and probably link to it in your commit message so that other developers will have a chance

to review it too.



`gem_update` will do exactly that for you.

It updates your `Gemfile` (via `bundle update`) and finds links for changelogs of updated gems.

All you have to do is to copy paste the output to the commit message, and you're done!

Obviously, you still have to read changelogs and adapt your code though ;)



## Installation and usage



```

gem install gem_updater

gem_update



```



If you prefer to, you can ask gem_update to commit straight away:



```

gem_update --commit

```



This will use the generated message as a commit message template, allowing you

to edit before commit.



### Diff format



By default, diff for your gems will look like the following:



```

* gem_1 0.1 → 0.2

[changelog](https://github.com/maintainer/gem_1/CHANGELOG.md#02)



* gem_2 3.4.2 → 3.4.3

[changelog](https://github.com/maintainer/gem_2/CHANGELOG.md#343)

```



You can change it if you like by writing you own template `.gem_updater_template.erb` in your home directory.

[Look at default template](lib/gem_updater_template.erb) for an example on how to do it.



## Troubleshooting



### Changelog not found?



This project relies on the gem’s metadata to find the changelog url.

If a changelog was not found, check if the gem’s authors declared its uri in its gemspec,

like [here](https://github.com/thoughtbot/factory_bot/blob/8f4f899305be5a09cee206876eb8d346cf6a0dcb/factory_bot.gemspec#L26).



## Contributing



PRs are always welcome!

If you wish to contribute, do not hesitate to submit an issue or to open a pull request.