@@ -48,19 +48,16 @@ of the current HEAD's hash. The plugin creates a constant APP_VERSION that contains the version number of the application. Calling the +to_s+ method on APP_VERSION will result in a properly formatted version number. APP_VERSION also has +major+, +minor+, -+patch+, +milestone+ and +build+ methods to retrieve the individual components -of the version number. - -Finally, there is a rake task for displaying the version number from the command -line. 'rake app:version' will output the version number of the current rails -application. ++patch+, +milestone+, +build+, +branch+, +committer+, and +build_date+ +methods to retrieve the individual components of the version number. == Capistrano Usage When the app_version plugin is installed, it copies a templated edition of the -version.yml file into /lib/templates/version.yml.erb the initial file shows a +version.yml file into /lib/templates/version.yml.erb, the initial file shows a tag for retrieving the revision count with git. It also shows displaying the -branch as specified with "set :branch" in your capistrano deploy.rb +branch as specified with "set :branch" in your capistrano deploy.rb, see the +comments in the erb file for more nifty tricks. When you do a cap deploy, there is a capistrano recipe built-in to the app_version plugin, which will render the templated version.yml into the standard location as @@ -70,6 +67,22 @@ Both the standard and extended capistrano usage can co-exist in the same project the dynamic rendering of the version.yml only happens when using capistrano to deploy your app. +== Rake tasks + +This plugin includes 4 new rake tasks: + +rake app:install - will copy the version.yml and version.yml.erb into more user + accessible locations (/config, and /lib/templates) + +rake app:uninstall - will remove the files copied in the install task + +rake app:render - will render the erb template into /config/version.yml + in case you want to have dynamic values updated via a rake task. + Note: certain examples expect the app to be in a git working directory. + +rake app:version - will output the version number of the current rails + application. + = License This plugin is released under the terms of the Ruby license. See README @@ -6,7 +6,8 @@ namespace :app_version do desc "Generate version.yml from variables" task :generate_version_info, :roles => :app do - result = render_erb_template(RAILS_ROOT + "/lib/templates/version.yml.erb") + template = File.read(RAILS_ROOT + "/lib/templates/version.yml.erb") + result = ERB.new(template).result(binding) put result, "#{release_path}/config/version.yml" end after "deploy:update_code", "app_version:generate_version_info" lib/recipes/app_version.rb @@ -9,5 +9,12 @@ minor: 0 # milestone: 4 build: <%= `git rev-list HEAD|wc -l`.strip %> branch: <%= branch %> -committer: coder -build_date: <%= Date.today.to_s %> \ No newline at end of file +committer: <%= `git show -s --pretty=format:"%an"` %> +build_date: <%= Date.today.to_s %> + +# nifty tricks (note these examples are commented out in erb syntax, to use them replace the # with =) +# <%# `git rev-list HEAD|wc -l`.strip %> will insert the count of commits to the repository (git) +# <%# `git show -s --pretty=format:"%an"` %> will insert the name of the author of the last commit (git) +# many more options are available - see git show. +# <%# Date.today.to_s %> will insert today's date - formatted yyyy-mm-dd +# <%# branch %> will insert the branch variable used in capistrano \ No newline at end of file lib/templates/version.yml.erb @@ -1,4 +1,6 @@ namespace :app do + require 'erb' + desc 'Report the application version.' task :version do require File.join(File.dirname(__FILE__), "../lib/app_version.rb") @@ -14,4 +16,11 @@ namespace :app do task :uninstall do require File.join(File.dirname(__FILE__), "../uninstall.rb") end + + desc 'Render the version.yml from its template.' + task :render do + template = File.read(RAILS_ROOT + "/lib/templates/version.yml.erb") + result = ERB.new(template).result(binding) + File.open(RAILS_ROOT + "/config/version.yml", 'w') { |f| f.write(result)} + end end tasks/app_version_tasks.rake 757f813b9779aafb6ce1aea81eb08db32b5654a5 John F. Schank III jschank@mac.com http://github.com/toland/app_version/commit/e436bea2ab785d7eeea578e43a9ba001d39401e5 e436bea2ab785d7eeea578e43a9ba001d39401e5 2008-10-28T23:45:18-07:00 2008-10-28T23:45:18-07:00 added comments to erb, and enhanced the readme 9226bac6fbc5b560c99255db397dfe441df30456 John F. Schank III jschank@mac.com