PageRenderTime 44ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/files/README_markdown.html

https://github.com/ouranos/cap_gun
HTML | 171 lines | 111 code | 60 blank | 0 comment | 0 complexity | d6cef603cd56beddd5951e45643b289f MD5 | raw file
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.     <title>README.markdown</title>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
    9. 

  9.     <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
    10. 

  10.     <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    11. 

  11.     <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    12. 

  12.     <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
    13. 

  13. </head>
    14. 

  14. 

  15. <body>     
    16. 

  16.     <div class="banner">
    17. 

  17.         <h1>
    18. 

  18.             README.markdown
    19. 

  19.         </h1>
    20. 

  20.         <ul class="files">
    21. 

  21.             <li>README.markdown</li>
    22. 

  22.             <li>Last modified: Wed Oct 14 16:29:21 -0400 2009</li>
    23. 

  23.         </ul>
    24. 

  24.     </div>
    25. 

  25. 

  26.     <div id="bodyContent">
    27. 

  27.         <div id="content">
    28. 

  28.     
    29. 

  29.     <div class="description">
    30. 

  30.         <h1>CapGun</h1>
    31. 

  31. 

  32. <h2>DESCRIPTION</h2>
    33. 

  33. 

  34. <p>Tell everyone about your releases!  Send email notification after Capistrano deployments!  Rule the world!</p>
    35. 

  35. 

  36. <p>Drop your ActionMailer configuration information into your deploy.rb file, configure recipients for the deployment notifications, and setup the callback task.</p>
    37. 

  37. 

  38. <p>Setup and configuration are done entirely inside your deploy.rb file to keep it super simple.  Your emails are sent locally from the box performing the deployment, but CapGun queries the server to grab the necessary release info.</p>
    39. 

  39. 

  40. <p>This even includes the Net::SMTP TLS hack inside as a vendored dependancy to allow super easy email sending without setting up an MTA.</p>
    41. 

  41. 

  42. <h2>CONFIG</h2>
    43. 

  43. 

  44. <p>In your Capistrano config file (usually deploy.rb):</p>
    45. 

  45. 

  46. <pre><code># require cap_gun (the path will depend on where you unpacked or if you are just using it as a gem)
    47. 

  47. require 'vendor/plugins/cap_gun/lib/cap_gun' # typical Rails vendor/plugins location
    48. 

  48. 

  49. # setup action mailer with a hash of options
    50. 

  50. set :cap_gun_action_mailer_config, {
    51. 

  51.   :address =&gt; "smtp.gmail.com",
    52. 

  52.   :port =&gt; 587,
    53. 

  53.   :user_name =&gt; "[YOUR_USERNAME]@gmail.com",
    54. 

  54.   :password =&gt; "[YOUR_PASSWORD]",
    55. 

  55.   :authentication =&gt; :plain 
    56. 

  56. }
    57. 

  57. 

  58. # define the options for the actual emails that go out -- :recipients is the only required option
    59. 

  59. set :cap_gun_email_envelope, { 
    60. 

  60.   :from =&gt; "project.deployer@example.com", # Note, don't use the form "Someone project.deploy@example.com" as it'll blow up with ActionMailer 2.3+
    61. 

  61.   :recipients =&gt; %w[joe@example.com, jane@example.com] 
    62. 

  62. }
    63. 

  63. 

  64. # register email as a callback after restart
    65. 

  65. after "deploy:restart", "cap_gun:email"
    66. 

  66. 

  67. # Test everything out by running "cap cap_gun:email"
    68. 

  68. </code></pre>
    69. 

  69. 

  70. <h2>USAGE</h2>
    71. 

  71. 

  72. <p>Good news: it just works.<br/>
    73. 

  73. </p>
    74. 

  74. 

  75. <p>By default CapGun includes info like the user who is deploying and what server its being deployed to.  CapGun is biased for git (patches accepted for other SCMs), so it will include details like your current branch, the revisions since last deployment, the current commit being deployed.</p>
    76. 

  76. 

  77. <p>Want to make the notifications even better and explain <em>why</em> you're deploying?
    78. 

  78. Just include a comment in the cap command like so, and CapGun will add the comment to the email notification.</p>
    79. 

  79. 

  80. <pre><code>cap -s comment="fix for bug #303" deploy
    81. 

  81. </code></pre>
    82. 

  82. 

  83. <h2>REQUIREMENTS</h2>
    84. 

  84. 

  85. <ul>
    86. 

  86. <li>Capistrano 2+</li>
    87. 

  87. <li>A Gmail account to send from, or an MTA (mail transport agent) installed locally to send from</li>
    88. 

  88. <li>Something to deploy</li>
    89. 

  89. </ul>
    90. 

  90. 

  91. 

  92. <h2>TODO &amp; KNOWN ISSUES</h2>
    93. 

  93. 

  94. <ul>
    95. 

  95. <li>displays the release times in UTC (Capistrano default) - could be flipped to specified time zone</li>
    96. 

  96. <li>some stuff will probably break on windows - patches welcome</li>
    97. 

  97. </ul>
    98. 

  98. 

  99. 

  100. <h2>INSTALL</h2>
    101. 

  101. 

  102. <ul>
    103. 

  103. <li><code>sudo gem install cap_gun</code>  and gem unpack into your vendor/plugins</li>
    104. 

  104. <li>or just grab the tarball from github (see below)</li>
    105. 

  105. </ul>
    106. 

  106. 

  107. 

  108. <h2>URLS</h2>
    109. 

  109. 

  110. <ul>
    111. 

  111. <li>Log bugs, issues, and suggestions at GitHub: http://github.com/relevance/cap_gun/issues</li>
    112. 

  112. <li>View source: http://github.com/relevance/cap_gun</li>
    113. 

  113. <li>Continuos Integration: http://runcoderun.com/relevance/cap_gun</li>
    114. 

  114. <li>SDocs: http://relevance.github.com/cap_gun/</li>
    115. 

  115. </ul>
    116. 

  116. 

  117. 

  118. <p>== LICENSE</p>
    119. 

  119. 

  120. <p>(The MIT License)</p>
    121. 

  121. 

  122. <p>Copyright (c) 2009 Relevance, Inc. - http://thinkrelevance.com</p>
    123. 

  123. 

  124. <p>Permission is hereby granted, free of charge, to any person obtaining
    125. 

  125. a copy of this software and associated documentation files (the
    126. 

  126. 'Software'), to deal in the Software without restriction, including
    127. 

  127. without limitation the rights to use, copy, modify, merge, publish,
    128. 

  128. distribute, sublicense, and/or sell copies of the Software, and to
    129. 

  129. permit persons to whom the Software is furnished to do so, subject to
    130. 

  130. the following conditions:</p>
    131. 

  131. 

  132. <p>The above copyright notice and this permission notice shall be
    133. 

  133. included in all copies or substantial portions of the Software.</p>
    134. 

  134. 

  135. <p>THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
    136. 

  136. EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    137. 

  137. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    138. 

  138. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    139. 

  139. CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    140. 

  140. TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    141. 

  141. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
    142. 

  142. <script type="text/javascript">$(function() {
    143. 

  143.   $('a').each(function() { $(this).attr('target', '_blank') })
    144. 

  144. })</script>
    145. 

  145. 

  146.     </div>
    147. 

  147.     
    148. 

  148. 

  149.     
    150. 

  150. 

  151.     
    152. 

  152.     
    153. 

  153. 

  154.     
    155. 

  155.     
    156. 

  156. 

  157.     
    158. 

  158. 

  159.     
    160. 

  160. 

  161.     
    162. 

  162. 

  163.     
    164. 

  164. 

  165.     
    166. 

  166. 

  167.     
    168. 

  168. </div>
    169. 

  169.     </div>
    170. 

  170.   </body>
    171. 

  171. </html>
    172.