├── .gitignore
├── README.md
└── config.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | nextBuildNumber
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## What is it?
 2 | This is a template to be used in Jenkins CI in order to build a Ruby On Rails project
 3 | 
 4 | ## Required hudson plugins
 5 | * [Ruby metrics plugin](http://wiki.jenkins-ci.org/display/JENKINS/Ruby+Metrics+Plugin)
 6 | * [Rake plugin](Jenkins Rake plugin)
 7 | * [Html Publisher](http://wiki.hudson-ci.org/display/HUDSON/HTML+Publisher+Plugin)
 8 | 
 9 | ## Required Ruby gems
10 | * [ci\_reporter](https://github.com/nicksieger/ci_reporter)
11 | * [metrical](https://github.com/iain/metrical)
12 | 
13 | ## Usage
14 | 
15 | After you've installed require gems in your project test the following commands are working in your environment
16 | 
17 | 		rake db:migrate db:test:prepare
18 | 		rake ci:setup:rspec spec:rcov
19 | 		rake CUCUMBER_OPTS='--format html --out features/reports/features.html' cucumber
20 | 		metrical
21 | 		
22 | You should edit your `Rakefile` to make some of them working by adding the following lines
23 | 
24 | 		# used to generate ci reports, see ci_reporter documentation
25 | 		require 'ci/reporter/rake/rspec'
26 | 
27 | Finally you should add metrical configuration in `.metric` file in your project, this is the mine
28 | 
29 | 		# used to generate metrics, see metric_fu documentation
30 | 		MetricFu::Configuration.run do |config|
31 | 		  config.metrics = [:churn, :flog, :flay, :reek, :roodi, :hotspots, :rails_best_practices]
32 | 		  config.metrics << :saikuro unless RUBY_VERSION == '1.9.2'
33 | 		  config.graphs = [:flog, :flay, :reek, :roodi, :rails_best_practices]
34 | 		end
35 | 
36 | I excluded rcov from `metric_fu` configuration because coverage task is included in Ruby Metrics Plugin.
37 | 
38 | Then in order to configure Jenkins:
39 | 
40 | 1. Install required Jenkins plugins using the plugin manager
41 | 2. Make [rvm](https://rvm.beginrescueend.com/) available to the Jenkins user
42 | 3. Install at least one Ruby for the jenkins user and set it to default with `rvm use <ruby> --default`, where `<ruby>` is the version you've installed.
43 | 3. Install `metrical` gem for the jenkins user (`rvm use default && gem install metrical`)
44 | 2. Install this template in Jenkins by `cd $JENKINS_HOME/jobs && git clone git://github.com/fabn/rails-jenkins-template.git rails-template`
45 | 3. Restart Jenkins to load the new job template
46 | 3. Click on "New Job"
47 | 4. Enter a "Job Name"
48 | 5. Select "Copy existing job" and enter "rails-template" into the "Copy from" field.
49 | 6. Click "OK"
50 | 7. Disable the "Disable Build" option
51 | 8. Fill in your "Source Code Management" information
52 | 9. Edit project options as your needs (i.e. disabling some steps or reports)
53 | 9. Click "Save"
54 | 
55 | ## Thanks to
56 | 
57 | * Sebastian Bergmann for the idea [http://jenkins-php.org/](http://jenkins-php.org)


--------------------------------------------------------------------------------
/config.xml:
--------------------------------------------------------------------------------
  1 | <?xml version='1.0' encoding='UTF-8'?>
  2 | <project>
  3 |   <actions/>
  4 |   <description></description>
  5 |   <keepDependencies>false</keepDependencies>
  6 |   <properties/>
  7 |   <scm class="hudson.scm.NullSCM"/>
  8 |   <canRoam>true</canRoam>
  9 |   <disabled>true</disabled>
 10 |   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
 11 |   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
 12 |   <triggers class="vector"/>
 13 |   <concurrentBuild>false</concurrentBuild>
 14 |   <builders>
 15 |     <hudson.tasks.Shell>
 16 |       <command>if [ -f $WORKSPACE/.rvmrc ]; then source $WORKSPACE/.rvmrc; else rvm use default; fi; bundle install; mkdir -p features/reports</command>
 17 |     </hudson.tasks.Shell>
 18 |     <hudson.plugins.rake.Rake>
 19 |       <rakeInstallation>(Default)</rakeInstallation>
 20 |       <rakeFile></rakeFile>
 21 |       <rakeLibDir></rakeLibDir>
 22 |       <rakeWorkingDir></rakeWorkingDir>
 23 |       <tasks>db:migrate db:test:prepare</tasks>
 24 |       <silent>false</silent>
 25 |     </hudson.plugins.rake.Rake>
 26 |     <hudson.plugins.rake.Rake>
 27 |       <rakeInstallation>(Default)</rakeInstallation>
 28 |       <rakeFile></rakeFile>
 29 |       <rakeLibDir></rakeLibDir>
 30 |       <rakeWorkingDir></rakeWorkingDir>
 31 |       <tasks>ci:setup:rspec spec:rcov</tasks>
 32 |       <silent>false</silent>
 33 |     </hudson.plugins.rake.Rake>
 34 |     <hudson.plugins.rake.Rake>
 35 |       <rakeInstallation>(Default)</rakeInstallation>
 36 |       <rakeFile></rakeFile>
 37 |       <rakeLibDir></rakeLibDir>
 38 |       <rakeWorkingDir></rakeWorkingDir>
 39 |       <tasks>CUCUMBER_OPTS=&quot;--format html --out features/reports/features.html&quot; cucumber</tasks>
 40 |       <silent>false</silent>
 41 |     </hudson.plugins.rake.Rake>
 42 |     <hudson.tasks.Shell>
 43 |       <command>metrical</command>
 44 |     </hudson.tasks.Shell>
 45 |   </builders>
 46 |   <publishers>
 47 |     <hudson.tasks.junit.JUnitResultArchiver>
 48 |       <testResults>spec/reports/*.xml</testResults>
 49 |       <keepLongStdio>false</keepLongStdio>
 50 |       <testDataPublishers/>
 51 |     </hudson.tasks.junit.JUnitResultArchiver>
 52 |     <htmlpublisher.HtmlPublisher>
 53 |       <reportTargets>
 54 |         <htmlpublisher.HtmlPublisherTarget>
 55 |           <reportName>Metrics Fu</reportName>
 56 |           <reportDir>tmp/metric_fu/output</reportDir>
 57 |           <reportFiles>index.html</reportFiles>
 58 |           <keepAll>true</keepAll>
 59 |           <wrapperName>htmlpublisher-wrapper.html</wrapperName>
 60 |         </htmlpublisher.HtmlPublisherTarget>
 61 |         <htmlpublisher.HtmlPublisherTarget>
 62 |           <reportName>Cucumber Features</reportName>
 63 |           <reportDir>features/reports</reportDir>
 64 |           <reportFiles>features.html</reportFiles>
 65 |           <keepAll>true</keepAll>
 66 |           <wrapperName>htmlpublisher-wrapper.html</wrapperName>
 67 |         </htmlpublisher.HtmlPublisherTarget>
 68 |       </reportTargets>
 69 |     </htmlpublisher.HtmlPublisher>
 70 |     <hudson.plugins.rubyMetrics.rcov.RcovPublisher>
 71 |       <reportDir>coverage</reportDir>
 72 |       <targets>
 73 |         <hudson.plugins.rubyMetrics.rcov.model.MetricTarget>
 74 |           <metric>TOTAL_COVERAGE</metric>
 75 |           <healthy>80</healthy>
 76 |           <unhealthy>0</unhealthy>
 77 |           <unstable>0</unstable>
 78 |         </hudson.plugins.rubyMetrics.rcov.model.MetricTarget>
 79 |         <hudson.plugins.rubyMetrics.rcov.model.MetricTarget>
 80 |           <metric>CODE_COVERAGE</metric>
 81 |           <healthy>80</healthy>
 82 |           <unhealthy>0</unhealthy>
 83 |           <unstable>0</unstable>
 84 |         </hudson.plugins.rubyMetrics.rcov.model.MetricTarget>
 85 |       </targets>
 86 |     </hudson.plugins.rubyMetrics.rcov.RcovPublisher>
 87 |     <hudson.plugins.rubyMetrics.railsStats.RailsStatsPublisher>
 88 |       <rake>
 89 |         <rakeInstallation>(Default)</rakeInstallation>
 90 |         <rakeWorkingDir></rakeWorkingDir>
 91 |         <tasks>stats</tasks>
 92 |         <silent>true</silent>
 93 |       </rake>
 94 |       <rakeInstallation>(Default)</rakeInstallation>
 95 |       <rakeWorkingDir></rakeWorkingDir>
 96 |       <task>stats</task>
 97 |     </hudson.plugins.rubyMetrics.railsStats.RailsStatsPublisher>
 98 |     <hudson.plugins.rubyMetrics.railsNotes.RailsNotesPublisher>
 99 |       <rake>
100 |         <rakeInstallation>(Default)</rakeInstallation>
101 |         <rakeWorkingDir></rakeWorkingDir>
102 |         <tasks>notes</tasks>
103 |         <silent>true</silent>
104 |       </rake>
105 |       <rakeInstallation>(Default)</rakeInstallation>
106 |       <rakeWorkingDir></rakeWorkingDir>
107 |       <task>notes</task>
108 |     </hudson.plugins.rubyMetrics.railsNotes.RailsNotesPublisher>
109 |   </publishers>
110 |   <buildWrappers/>
111 | </project>


--------------------------------------------------------------------------------