Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / 1a56c9619e03ee3e4e1b539e592e7d8b51f53a7b / . / org.jacoco.doc / docroot / doc / environment.html
blob: 33df73aba4caff1c15a9e286943bb86d2eaa8bb6 [file] [log] [blame]
Marc R. Hoffmanne571f3f2012-05-13 12:18:02 +0000[diff] [blame]1<?xml version="1.0" encoding="UTF-8" ?>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4<head>
Marc R. Hoffmanne571f3f2012-05-13 12:18:02 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Evgeny Mandrikov8b212982016-06-12 17:55:49 +0200[diff] [blame]6 <link rel="stylesheet" href="resources/doc.css" charset="UTF-8" type="text/css" />
7 <link rel="shortcut icon" href="resources/report.gif" type="image/gif" />
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]8 <title>JaCoCo - Development Environment</title>
9</head>
10<body>
11
12<div class="breadcrumb">
13 <a href="../index.html" class="el_report">JaCoCo</a> &gt;
14 <a href="index.html" class="el_group">Documentation</a> &gt;
15 <span class="el_source">Development Environment</span>
16</div>
17<div id="content">
18
19<h1>Development Environment</h1>
20
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]21<h2>Project Hosting</h2>
22
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]23<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]24 The JaCoCo project is hosted on
25 <a href="https://github.com/jacoco/jacoco">GitHub</a> and can be cloned from
26 this URL:
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]27</p>
28
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]29<pre>
30 https://github.com/jacoco/jacoco.git
31</pre>
32
33<p>
34 We also track all
35 <a href="https://github.com/jacoco/jacoco/issues">issues</a> and
36 <a href="https://github.com/jacoco/jacoco/pulls">pull requests</a>
37 on the GitHub project.
38</p>
39
40
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]41<h3>IDE</h3>
42
43<p>
Marc R. Hoffmannae311b92014-05-01 07:07:10 +0200[diff] [blame]44 JaCoCo development is done with the latest version of
45 <a href="http://www.eclipse.org/">Eclipse</a>. Please make sure to install
46 the <a href="http://www.eclipse.org/m2e/">m2e plug-in</a> to get all
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]47 dependencies resolved properly. The source tree is organized as a list of
48 Eclipse projects that can be imported in a Eclipse workspace.
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]49</p>
50
51<p>
52 Project specific Eclipse settings only exist for the following projects. All
53 other projects and test projects link to these settings:
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]54</p>
55
56<ul>
57 <li><code>org.jacoco.core</code></li>
58 <li><code>org.jacoco.core.test</code></li>
59</ul>
60
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]61<p>
62 These settings specify various compiler warnings and the standard Eclipse
63 source formatting rules.
64</p>
65
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]66<h3>JRE/JDK</h3>
67
68<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]69 The minimum supported JRE version for JaCoCo is Java 1.5. To guarantee
Marc R. Hoffmann5c230162014-07-08 20:59:54 +0200[diff] [blame]70 compatibility JaCoCo builds should always be executed against Java 1.5 JDK. In
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]71 addition we run builds with 1.6, 1.7, 1.8 and 1.9 JDKs.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]72</p>
73
Marc R. Hoffmann5c230162014-07-08 20:59:54 +0200[diff] [blame]74<h3>Build</h3>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]75
76<p>
Marc R. Hoffmann5c230162014-07-08 20:59:54 +0200[diff] [blame]77 The JaCoCo build is based on <a href="http://maven.apache.org/">Maven 3</a>.
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]78 See the <a href="build.html">build description</a> for details.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]79</p>
80
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]81<h3>Continuous Integration</h3>
82
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]83<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]84 We have a list of CI tools directly integrated with our source repository:
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]85</p>
86
Marc R. Hoffmann5c230162014-07-08 20:59:54 +0200[diff] [blame]87<ul>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]88 <li><a href="https://travis-ci.org/jacoco/jacoco/">Travis CI</a></li>
89 <li><a href="https://ci.appveyor.com/project/JaCoCo/jacoco">AppVeyor</a></li>
Marc R. Hoffmann5c230162014-07-08 20:59:54 +0200[diff] [blame]90</ul>
91
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]92<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]93 CI builds run for master and every pull request.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]94</p>
95
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]96<h3>Development Build Artifacts</h3>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]97
98<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]99 Beside the <a href="http://search.maven.org/#search|ga|1|g%3Aorg.jacoco"> JaCoCo releases</a>
100 the following build artifacts are automatically available during the
101 development cycle:
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]102</p>
103
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]104<ul>
105 <li><b>Master:</b> The current master is available through the Maven
106 <a href="repo.html">snapshot repository</a>.</li>
107 <li><b>Pull Requests:</b> For every pull request the
108 <a href="https://ci.appveyor.com/project/JaCoCo/jacoco">AppVeyor builds</a>
109 provide the corresponding all-in-one zip for download. To access the
110 artifacts follow the check <code>continuous-integration/appveyor/branch</code>
111 on the corresponding GitHub pull request page.</li>
112</ul>
113
114<h3>Continuous Inspection</h3>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]115
116<p>
Marc R. Hoffmannc72f3502016-05-18 12:41:10 +0200[diff] [blame]117 We track quality issues with our source code with
118 <a href="http://nemo.sonarqube.org/dashboard/index/org.jacoco:org.jacoco.build">SonarQube</a>.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]119</p>
120
121<h3>Communication</h3>
122
123<p>
124 The development team communicates through a mailing list. The list is closed
125 for non-developers but the archive is
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]126 <a href="https://groups.google.com/d/forum/jacoco-dev">public</a>.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]127 Please use the <a href="support.html">support channels</a> to get in touch
128 with the development team.
129</p>
130
131</div>
132<div class="footer">
133 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
134 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
135</div>
136
137</body>
138</html>