auto_gem_updater 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af27b6c7126319da9cf983b79b0b9b559fce9eb993c4a86c6becf6e17681761
-  data.tar.gz: 7f6905aa2a194ab992eff2583863606be74f767c2f4f88a79053739284d84db6
+  metadata.gz: fde178c537b4b8bb60e1ff214f8e2c15fa62d8102efcbb3921fc3c97aef03bd2
+  data.tar.gz: c66d479123015aab395979c6b5da3d1048b5ec9af7c4e034d9a084a98a535102
 SHA512:
-  metadata.gz: 77d4167fcb510af51af34c8160a4922165a5c8293daddef0146c52f8e96b8f92281fa17e5f1ffe662b6390d735f8c439ad822d7eee2c00331b2744b756589424
-  data.tar.gz: 1ad452e41a54e135b14b00badce55ccab5524d784ccd241c7905a03bd36d48da4b281e04689430ca8a2106307eef31ac08d7b2041f87afa00f834611f1b78f45
+  metadata.gz: 48c6b78e0599054e9d16498f0f60fa25a9d9ae5d7d53a0acedb3a2e9729682c53e61655ad14b301597f838ae04e7422ecd55391f3165cf76172a1f24394b77ef
+  data.tar.gz: 0b121d2e6ac3c8f5f5151619df959073df0f6a74974e0ae5a71d5b3b7db9dae5e1d1f50452bbc541dca094aa07d2929e78c794d0c52463cdb44c57de6edf6ba7

data/README.md

@@ -1,8 +1,6 @@
 # AutoGemUpdater
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/auto_gem_updater`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Auto Gem Updater helps you to keep your gems, up to date.
 
 ## Installation
 
@@ -20,15 +18,43 @@ Or install it yourself as:
 
     $ gem install auto_gem_updater
 
-## Usage
+## Configuration
+
+Configuration options are: `pre_checks, outdated_options, ignore_gems`
+
+To config these options add a file to your `config/initializers` and call it `auto_gem_updater.rb`
+This file should look like:
+```ruby
+AutoGemUpdater.configure do |config|
+  config.pre_checks = ['bundle exec rspec']
+end
+```
+each of the options above can be configured inside the above block (e.g `config.pre_checks = ['bundle exec rspec']`)
+
+#### pre_checks
+`pre_checks` is expected to be an array of all the checks you want performed before an update to a gem is commit. The default is an empty array.
 
-TODO: Write usage instructions here
+For example `['bundle exec rspec', 'bundle exec rake routes',...]`
+
+#### outdated_options
+`outdated_options` is expected to be an array of options that you want to be passed to `bundle outdated` any of the options form the [docs](https://bundler.io/man/bundle-outdated.1.html) are supported. The default is `['strict']`.
+
+For example `['strict', 'minor']`
+
+#### ignore_gems
+`ignore_gems` is expected to be an array of gems that you do not want the auto gem updater to attempt to update. The default is an empty array.
+
+For example `['nokogiri', 'rails',...]`
+
+## Usage
 
-## Development
+Once the gem is installed it will add to some rake tasks that will allow you to update your gems.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Update
+`rake auto_gem_updater:update` is the main rake task. It will first create a branch, called `auto_gem_updates_ + todays date`. It will then loop over all the gems that it finds out of date according to the outdated_options each time running all the pre_checks specified in the initializer and only if they succeed add the updated gem version to git (otherwise it resets to before trying to update the gem).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Outdated
+`rake auto_gem_updater:outdated` will list out all the gems that the update command will attempt to update.
 
 ## Contributing
 

data/auto_gem_updater.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Auto Update Gems}
   spec.license       = "MIT"
+  spec.homepage      = "https://github.com/hvenables/auto_gem_updater"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/auto_gem_updater/version.rb

@@ -1,3 +1,3 @@
 module AutoGemUpdater
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_gem_updater
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Harry Venables
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,7 @@ files:
 - lib/auto_gem_updater/tasks/auto_gem_updater.rake
 - lib/auto_gem_updater/updater.rb
 - lib/auto_gem_updater/version.rb
-homepage: 
+homepage: https://github.com/hvenables/auto_gem_updater
 licenses:
 - MIT
 metadata: {}