]>
Commit | Line | Data |
---|---|---|
53ed6d7d | 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 | ||
0433c688 | 155 | <a class="" href="../Various-hacks/">Various hacks</a> |
53ed6d7d | 156 | </li> |
157 | </ul> | |
158 | </li> | |
159 | ||
160 | <li class="toctree-l1"> | |
161 | ||
162 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | |
163 | </li> | |
164 | ||
165 | <li class="toctree-l1"> | |
166 | ||
167 | <span class="caption-text">Development</span> | |
168 | <ul class="subnav"> | |
169 | <li class=""> | |
170 | ||
171 | <a class="" href="../Development-guidelines/">Development guidelines</a> | |
172 | </li> | |
173 | <li class=" current"> | |
174 | ||
175 | <a class="current" href="./">Continuous integration tools</a> | |
176 | <ul class="subnav"> | |
177 | ||
178 | <li class="toctree-l3"><a href="#local-development">Local development</a></li> | |
179 | ||
180 | ||
181 | <li class="toctree-l3"><a href="#automatic-builds">Automatic builds</a></li> | |
182 | ||
183 | ||
184 | </ul> | |
185 | </li> | |
186 | <li class=""> | |
187 | ||
188 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | |
189 | </li> | |
190 | <li class=""> | |
191 | ||
192 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | |
193 | </li> | |
194 | <li class=""> | |
195 | ||
196 | <a class="" href="../Directory-structure/">Directory structure</a> | |
197 | </li> | |
198 | <li class=""> | |
199 | ||
200 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | |
201 | </li> | |
202 | <li class=""> | |
203 | ||
204 | <a class="" href="../Plugin-System/">Plugin System</a> | |
205 | </li> | |
206 | <li class=""> | |
207 | ||
208 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | |
209 | </li> | |
210 | <li class=""> | |
211 | ||
212 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | |
213 | </li> | |
214 | <li class=""> | |
215 | ||
216 | <a class="" href="../Security/">Security</a> | |
217 | </li> | |
218 | <li class=""> | |
219 | ||
220 | <a class="" href="../Static-analysis/">Static analysis</a> | |
221 | </li> | |
222 | <li class=""> | |
223 | ||
224 | <a class="" href="../Theming/">Theming</a> | |
225 | </li> | |
226 | <li class=""> | |
227 | ||
228 | <a class="" href="../Unit-tests/">Unit tests</a> | |
229 | </li> | |
230 | </ul> | |
231 | </li> | |
232 | ||
233 | <li class="toctree-l1"> | |
234 | ||
235 | <span class="caption-text">About</span> | |
236 | <ul class="subnav"> | |
237 | <li class=""> | |
238 | ||
239 | <a class="" href="../FAQ/">FAQ</a> | |
240 | </li> | |
241 | <li class=""> | |
242 | ||
243 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | |
244 | </li> | |
245 | </ul> | |
246 | </li> | |
247 | ||
248 | </ul> | |
249 | </div> | |
250 | | |
251 | </nav> | |
252 | ||
253 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | |
254 | ||
255 | ||
256 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | |
257 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | |
258 | <a href="..">Shaarli Documentation</a> | |
259 | </nav> | |
260 | ||
261 | ||
262 | <div class="wy-nav-content"> | |
263 | <div class="rst-content"> | |
264 | <div role="navigation" aria-label="breadcrumbs navigation"> | |
265 | <ul class="wy-breadcrumbs"> | |
266 | <li><a href="..">Docs</a> »</li> | |
267 | ||
268 | ||
269 | ||
270 | <li>Development »</li> | |
271 | ||
272 | ||
273 | ||
274 | <li>Continuous integration tools</li> | |
275 | <li class="wy-breadcrumbs-aside"> | |
276 | ||
277 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Continuous-integration-tools.md" | |
278 | class="icon icon-github"> Edit on GitHub</a> | |
279 | ||
280 | </li> | |
281 | </ul> | |
282 | <hr/> | |
283 | </div> | |
284 | <div role="main"> | |
285 | <div class="section"> | |
286 | ||
287 | <h2 id="local-development">Local development</h2> | |
288 | <p>A <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile</code></a> is available to perform project-related operations: | |
289 | - Documentation - generate a local HTML copy of the GitHub wiki | |
290 | - <a href="../Static analysis">Static analysis</a> - check that the code is compliant to PHP conventions | |
291 | - <a href="../Unit tests">Unit tests</a> - ensure there are no regressions introduced by new commits</p> | |
292 | <h2 id="automatic-builds">Automatic builds</h2> | |
293 | <p><a href="http://docs.travis-ci.com/">Travis CI</a> is a Continuous Integration build server, that runs a build: | |
294 | - each time a commit is merged to the mainline (<code>master</code> branch) | |
295 | - each time a Pull Request is submitted or updated</p> | |
296 | <p>A build is composed of several jobs: one for each supported PHP version (see <a href="../Server requirements">Server requirements</a>).</p> | |
297 | <p>Each build job: | |
298 | - updates Composer | |
299 | - installs 3rd-party test dependencies with Composer | |
300 | - runs <a href="../Unit tests">Unit tests</a></p> | |
301 | <p>After all jobs have finished, Travis returns the results to GitHub: | |
302 | - 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> | |
303 | - Pull Requests are updated with the Travis result | |
304 | - Green: all tests have passed | |
305 | - Red: some tests failed | |
306 | - Orange: tests are pending</p> | |
307 | ||
308 | </div> | |
309 | </div> | |
310 | <footer> | |
311 | ||
312 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | |
313 | ||
314 | <a href="../GnuPG-signature/" class="btn btn-neutral float-right" title="GnuPG signature">Next <span class="icon icon-circle-arrow-right"></span></a> | |
315 | ||
316 | ||
317 | <a href="../Development-guidelines/" class="btn btn-neutral" title="Development guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a> | |
318 | ||
319 | </div> | |
320 | ||
321 | ||
322 | <hr/> | |
323 | ||
324 | <div role="contentinfo"> | |
325 | <!-- Copyright etc --> | |
326 | ||
327 | </div> | |
328 | ||
329 | 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>. | |
330 | </footer> | |
331 | ||
332 | </div> | |
333 | </div> | |
334 | ||
335 | </section> | |
336 | ||
337 | </div> | |
338 | ||
339 | <div class="rst-versions" role="note" style="cursor: pointer"> | |
340 | <span class="rst-current-version" data-toggle="rst-current-version"> | |
341 | ||
342 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | |
343 | ||
344 | ||
345 | <span><a href="../Development-guidelines/" style="color: #fcfcfc;">« Previous</a></span> | |
346 | ||
347 | ||
348 | <span style="margin-left: 15px"><a href="../GnuPG-signature/" style="color: #fcfcfc">Next »</a></span> | |
349 | ||
350 | </span> | |
351 | </div> | |
352 | <script src="../js/theme.js"></script> | |
353 | ||
354 | </body> | |
355 | </html> |