doc/html/Continuous-integration-tools/index.html

   1 <!DOCTYPE html>
   2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   4 <head>
   5   <meta charset="utf-8">
   6   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   8
   9
  10   <link rel="shortcut icon" href="../img/favicon.ico">
  11   <title>Continuous integration tools - Shaarli Documentation</title>
  12   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  13
  14   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  16   <link rel="stylesheet" href="../css/highlight.css">
  17   <link href="../github-markdown.css" rel="stylesheet">
  18
  19   <script>
  20     // Current page data
  21     var mkdocs_page_name = "Continuous integration tools";
  22     var mkdocs_page_input_path = "Continuous-integration-tools.md";
  23     var mkdocs_page_url = "/Continuous-integration-tools/";
  24   </script>
  25
  26   <script src="../js/jquery-2.1.1.min.js"></script>
  27   <script src="../js/modernizr-2.8.3.min.js"></script>
  28   <script type="text/javascript" src="../js/highlight.pack.js"></script>
  29
  30 </head>
  31
  32 <body class="wy-body-for-nav" role="document">
  33
  34   <div class="wy-grid-for-nav">
  35
  36
  37     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  38       <div class="wy-side-nav-search">
  39         <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  40         <div role="search">
  41   <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  42     <input type="text" name="q" placeholder="Search docs" />
  43   </form>
  44 </div>
  45       </div>
  46
  47       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  48         <ul class="current">
  49
  50
  51             <li class="toctree-l1">
  52
  53     <a class="" href="..">Home</a>
  54             </li>
  55
  56             <li class="toctree-l1">
  57
  58     <span class="caption-text">Setup</span>
  59     <ul class="subnav">
  60                 <li class="">
  61
  62     <a class="" href="../Download-and-Installation/">Download and Installation</a>
  63                 </li>
  64                 <li class="">
  65
  66     <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  67                 </li>
  68                 <li class="">
  69
  70     <a class="" href="../Server-requirements/">Server requirements</a>
  71                 </li>
  72                 <li class="">
  73
  74     <a class="" href="../Server-configuration/">Server configuration</a>
  75                 </li>
  76                 <li class="">
  77
  78     <a class="" href="../Server-security/">Server security</a>
  79                 </li>
  80                 <li class="">
  81
  82     <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  83                 </li>
  84                 <li class="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../Docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../Shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../Docker-resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class="">
 119
 120     <a class="" href="../Features/">Features</a>
 121                 </li>
 122                 <li class="">
 123
 124     <a class="" href="../Bookmarklet/">Bookmarklet</a>
 125                 </li>
 126                 <li class="">
 127
 128     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 129                 </li>
 130                 <li class="">
 131
 132     <a class="" href="../Firefox-share/">Firefox share</a>
 133                 </li>
 134                 <li class="">
 135
 136     <a class="" href="../RSS-feeds/">RSS feeds</a>
 137                 </li>
 138                 <li class="">
 139
 140     <a class="" href="../REST-API/">REST API</a>
 141                 </li>
 142     </ul>
 143             </li>
 144
 145             <li class="toctree-l1">
 146
 147     <span class="caption-text">How To</span>
 148     <ul class="subnav">
 149                 <li class="">
 150
 151     <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 152                 </li>
 153                 <li class="">
 154
 155     <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
 156                 </li>
 157                 <li class="">
 158
 159     <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
 160                 </li>
 161                 <li class="">
 162
 163     <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
 164                 </li>
 165                 <li class="">
 166
 167     <a class="" href="../Datastore-hacks/">Datastore hacks</a>
 168                 </li>
 169     </ul>
 170             </li>
 171
 172             <li class="toctree-l1">
 173
 174     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 175             </li>
 176
 177             <li class="toctree-l1">
 178
 179     <span class="caption-text">Development</span>
 180     <ul class="subnav">
 181                 <li class="">
 182
 183     <a class="" href="../Development-guidelines/">Development guidelines</a>
 184                 </li>
 185                 <li class=" current">
 186
 187     <a class="current" href="./">Continuous integration tools</a>
 188     <ul class="subnav">
 189
 190     <li class="toctree-l3"><a href="#local-development">Local development</a></li>
 191
 192
 193     <li class="toctree-l3"><a href="#automatic-builds">Automatic builds</a></li>
 194
 195
 196     </ul>
 197                 </li>
 198                 <li class="">
 199
 200     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 201                 </li>
 202                 <li class="">
 203
 204     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 205                 </li>
 206                 <li class="">
 207
 208     <a class="" href="../Directory-structure/">Directory structure</a>
 209                 </li>
 210                 <li class="">
 211
 212     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 213                 </li>
 214                 <li class="">
 215
 216     <a class="" href="../Plugin-System/">Plugin System</a>
 217                 </li>
 218                 <li class="">
 219
 220     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 221                 </li>
 222                 <li class="">
 223
 224     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 225                 </li>
 226                 <li class="">
 227
 228     <a class="" href="../Security/">Security</a>
 229                 </li>
 230                 <li class="">
 231
 232     <a class="" href="../Static-analysis/">Static analysis</a>
 233                 </li>
 234                 <li class="">
 235
 236     <a class="" href="../Theming/">Theming</a>
 237                 </li>
 238                 <li class="">
 239
 240     <a class="" href="../Unit-tests/">Unit tests</a>
 241                 </li>
 242     </ul>
 243             </li>
 244
 245             <li class="toctree-l1">
 246
 247     <span class="caption-text">About</span>
 248     <ul class="subnav">
 249                 <li class="">
 250
 251     <a class="" href="../FAQ/">FAQ</a>
 252                 </li>
 253                 <li class="">
 254
 255     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 256                 </li>
 257     </ul>
 258             </li>
 259
 260         </ul>
 261       </div>
 262       &nbsp;
 263     </nav>
 264
 265     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 266
 267
 268       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 269         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 270         <a href="..">Shaarli Documentation</a>
 271       </nav>
 272
 273
 274       <div class="wy-nav-content">
 275         <div class="rst-content">
 276           <div role="navigation" aria-label="breadcrumbs navigation">
 277   <ul class="wy-breadcrumbs">
 278     <li><a href="..">Docs</a> &raquo;</li>
 279
 280
 281
 282           <li>Development &raquo;</li>
 283
 284
 285
 286     <li>Continuous integration tools</li>
 287     <li class="wy-breadcrumbs-aside">
 288
 289         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Continuous-integration-tools.md"
 290           class="icon icon-github"> Edit on GitHub</a>
 291
 292     </li>
 293   </ul>
 294   <hr/>
 295 </div>
 296           <div role="main">
 297             <div class="section">
 298
 299                 <h2 id="local-development">Local development</h2>
 300 <p>A <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile</code></a> is available to perform project-related operations:
 301 - Documentation - generate a local HTML copy of the GitHub wiki
 302 - <a href="../Static analysis">Static analysis</a> - check that the code is compliant to PHP conventions
 303 - <a href="../Unit tests">Unit tests</a> - ensure there are no regressions introduced by new commits</p>
 304 <h2 id="automatic-builds">Automatic builds</h2>
 305 <p><a href="http://docs.travis-ci.com/">Travis CI</a> is a Continuous Integration build server, that runs a build:
 306 - each time a commit is merged to the mainline (<code>master</code> branch)
 307 - each time a Pull Request is submitted or updated</p>
 308 <p>A build is composed of several jobs: one for each supported PHP version (see <a href="../Server requirements">Server requirements</a>).</p>
 309 <p>Each build job:
 310 - updates Composer
 311 - installs 3rd-party test dependencies with Composer
 312 - runs <a href="../Unit tests">Unit tests</a></p>
 313 <p>After all jobs have finished, Travis returns the results to GitHub:
 314 - a status icon represents the result for the <code>master</code> branch: <a href="https://travis-ci.org/shaarli/Shaarli"><img alt="" src="https://api.travis-ci.org/shaarli/Shaarli.svg" /></a>
 315 - Pull Requests are updated with the Travis result
 316     - Green: all tests have passed
 317     - Red: some tests failed
 318     - Orange: tests are pending</p>
 319
 320             </div>
 321           </div>
 322           <footer>
 323
 324     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 325
 326         <a href="../GnuPG-signature/" class="btn btn-neutral float-right" title="GnuPG signature">Next <span class="icon icon-circle-arrow-right"></span></a>
 327
 328
 329         <a href="../Development-guidelines/" class="btn btn-neutral" title="Development guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 330
 331     </div>
 332
 333
 334   <hr/>
 335
 336   <div role="contentinfo">
 337     <!-- Copyright etc -->
 338
 339   </div>
 340
 341   Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 342 </footer>
 343
 344         </div>
 345       </div>
 346
 347     </section>
 348
 349   </div>
 350
 351   <div class="rst-versions" role="note" style="cursor: pointer">
 352     <span class="rst-current-version" data-toggle="rst-current-version">
 353
 354           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 355
 356
 357         <span><a href="../Development-guidelines/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 358
 359
 360         <span style="margin-left: 15px"><a href="../GnuPG-signature/" style="color: #fcfcfc">Next &raquo;</a></span>
 361
 362     </span>
 363 </div>
 364     <script src="../js/theme.js"></script>
 365
 366 </body>
 367 </html>