release-notes 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f57251370fff06c63ccbbb0719638cf769a0f93e689670797ec7a9bbce6cecc
-  data.tar.gz: 59ea08dcca6b490195ba032e4786a4acc4062ab6883e291388975cf9681ef7c6
+  metadata.gz: d55b65f398efbef833f63bbc1fc5bf86bc062e9ce3d07658342f293565d182e5
+  data.tar.gz: e2f6b3abce7ddbd520d54375dac4c09969841e96f70de7b6541fb58d103288b9
 SHA512:
-  metadata.gz: faca9e5eda060af2c513130e711c178ef8a698b7bd91285730c4913eb0467657011ad39419d947de68341f7b7b2bdd3869a6314ffe86844b25dff028177c2e81
-  data.tar.gz: b72a541e60752ec2ece0badabcacc18014feebd9d20bea2dd3db4a31f50f73f5d7453c14e9d3de0a3fae0f2a96bf5a8efd3c6fc3e33d7e13ea37b4bf7cd17287
+  metadata.gz: eb2dee824dbcf7936176f18e6557d462c3a9ba6ac6b8e702586a9801597a98b318b1446310949d4b8c1ee31e84fb63e0587c1708cf760d203efeefe978ab74ed
+  data.tar.gz: 2ccb891af0e2a54def2237ab47f9f145d2967fad58dd888882734850a5dc03b7a43beca78a61df078a6bd8e29c0d5b8fea66518ab6884c2694b6a3c75f8dd566

data/README.md

@@ -50,7 +50,7 @@ After you install Release::Notes, generate the intializer file:
 $ rails generate release:notes:install
 
 # non-rails
-$ bundle exec release:notes:install
+$ bundle exec rake release:notes:install
 ```
 
 ## Configure
@@ -126,35 +126,20 @@ check out the following links
 
 ### Deploying with Capistrano
 
-If using Rails, a rake task is included and would be best utilized within your deploy script.
-
-If not on rails, but using rake, you can easily craft your own rake task. At the very least calling
-
-```ruby
-Release::Notes.generate
-```
-
-is the only instance that needs to be instantiated and invoked.
-
-A sample capistrano production file might look something like this:
+A sample capistrano rake task might look like:
 
 ```ruby
 # config/deploy/production.rb
-server 'the_name_for_my_server', user: 'deploy', roles: %w{app web}
-
-set :application, 'my_app'
-set :deploy_to, '/var/www/my_app'
-
-
 namespace :deploy do
   before :starting, :update_release_notes
 
   task :update_release_notes do
     # use the binstub
     sh 'bin/release-notes"'
-    # run a second task that generates an auto commit
-    # this would be created by you
-    sh 'bin/rake "release_notes:commit"'
+    
+    # Then check in your release notes with a commit
+    sh "git commit -am 'Release to production #{Time.zone.now}'"
+    sh "git push origin master"
   end
 end
 ```
@@ -162,17 +147,7 @@ end
 Useful information can be found here regarding the
 [capistrano flow](http://capistranorb.com/documentation/getting-started/flow/).
 
-As you can see above, it's suggested that after generating your release notes you would
-run an automated commit with a rake task like:
-
-```ruby
-# lib/tasks/commit.rake
-`git commit -am "Release to production #{Time.zone.now}"`
-`git push origin master`
-```
-
-From there, make sure you tag your release after the deploy script runs so that your tag
-includes this last commit.
+**From there, make sure you tag your releases**
 
 ## Note
 

data/exe/release-notes

@@ -4,15 +4,19 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
 require "release/notes"
-config_file = "./config/initializers/release_notes.rb"
+
+rails_config_file = "./config/initializers/release_notes.rb"
+config_file = "./config/release_notes.rb"
+
+file = File.exist?(rails_config_file) ? rails_config_file : config_file
 
 begin
-  require config_file
+  require file
   warn "=> Generating release notes..."
   Release::Notes.generate
   warn "=> Done!"
 rescue LoadError
-  warn "=> Missing config/initializers/release_notes.rb"
+  warn "=> Missing release_notes.rb configuration file"
 rescue SignalException => e
   # We might receive SIGTERM before our signal handler is installed.
   if Signal.signame(e.signo) == "TERM"

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Drew Monroe