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