| 1 |
<?xml version="1.0" encoding="UTF-8" ?> |
| 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> |
| 5 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| 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" /> |
| 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> > |
| 14 |
<a href="index.html" class="el_group">Documentation</a> > |
| 15 |
<span class="el_source">Development Environment</span> |
| 16 |
</div> |
| 17 |
<div id="content"> |
| 18 |
|
| 19 |
<h1>Development Environment</h1> |
| 20 |
|
| 21 |
<h2>Project Hosting</h2> |
| 22 |
|
| 23 |
<p> |
| 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: |
| 27 |
</p> |
| 28 |
|
| 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 |
|
| 41 |
<h3>IDE</h3> |
| 42 |
|
| 43 |
<p> |
| 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 |
| 47 |
dependencies resolved properly. The source tree is organized as a list of |
| 48 |
Eclipse projects that can be imported in a Eclipse workspace. |
| 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: |
| 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 |
|
| 61 |
<p> |
| 62 |
These settings specify various compiler warnings and the standard Eclipse |
| 63 |
source formatting rules. |
| 64 |
</p> |
| 65 |
|
| 66 |
<h3>JRE/JDK</h3> |
| 67 |
|
| 68 |
<p> |
| 69 |
The minimum supported JRE version for JaCoCo is Java 5. To guarantee |
| 70 |
compatibility JaCoCo release builds should always be executed using JDK 5. |
| 71 |
In addition we run builds with 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 |
| 72 |
18, 19, 20, 21, 22, 23, 24, 25 and 26 JDKs. |
| 73 |
</p> |
| 74 |
|
| 75 |
<h3>Build</h3> |
| 76 |
|
| 77 |
<p> |
| 78 |
The JaCoCo build is based on <a href="http://maven.apache.org/">Maven</a> |
| 79 |
and requires at least Maven 3.9.11 and JDK 17. |
| 80 |
See the <a href="build.html">build description</a> for details. |
| 81 |
</p> |
| 82 |
|
| 83 |
<h3>Continuous Integration</h3> |
| 84 |
|
| 85 |
<p> |
| 86 |
We have a list of CI tools directly integrated with our source repository: |
| 87 |
</p> |
| 88 |
|
| 89 |
<ul> |
| 90 |
<li><a href="https://github.com/jacoco/jacoco/actions">GitHub Actions</a></li> |
| 91 |
<li><a href="https://dev.azure.com/JaCoCo-org/JaCoCo/_build">Azure Pipelines</a></li> |
| 92 |
</ul> |
| 93 |
|
| 94 |
<p> |
| 95 |
CI builds run for master and every pull request. |
| 96 |
</p> |
| 97 |
|
| 98 |
<h3>Development Build Artifacts</h3> |
| 99 |
|
| 100 |
<p> |
| 101 |
Beside the <a href="http://search.maven.org/#search|ga|1|g%3Aorg.jacoco"> JaCoCo releases</a> |
| 102 |
the following build artifacts are automatically available during the |
| 103 |
development cycle: |
| 104 |
</p> |
| 105 |
|
| 106 |
<ul> |
| 107 |
<li><b>Master:</b> The current master is available through the Maven |
| 108 |
<a href="repo.html">snapshot repository</a>.</li> |
| 109 |
<li><b>Pull Requests:</b> For every pull request the |
| 110 |
<a href="https://github.com/jacoco/jacoco/actions">GitHub Actions builds</a> |
| 111 |
provide the corresponding all-in-one zip for download. To access the |
| 112 |
artifacts go to a summary page of a workflow run corresponding to the pull |
| 113 |
request.</li> |
| 114 |
</ul> |
| 115 |
|
| 116 |
<h3>Continuous Inspection</h3> |
| 117 |
|
| 118 |
<p> |
| 119 |
We track quality issues with our source code with |
| 120 |
<a href="https://sonarcloud.io/dashboard?id=org.jacoco:org.jacoco.build">SonarQube</a>. |
| 121 |
</p> |
| 122 |
|
| 123 |
<h3>Communication</h3> |
| 124 |
|
| 125 |
<p> |
| 126 |
The development team communicates through a mailing list. The list is closed |
| 127 |
for non-developers but the archive is |
| 128 |
<a href="https://groups.google.com/d/forum/jacoco-dev">public</a>. |
| 129 |
Please use the <a href="support.html">support channels</a> to get in touch |
| 130 |
with the development team. |
| 131 |
</p> |
| 132 |
|
| 133 |
</div> |
| 134 |
<div class="footer"> |
| 135 |
<span class="right"><a href="${jacoco.home.url}">JaCoCo</a> ${qualified.bundle.version}</span> |
| 136 |
<a href="license.html">Copyright</a> © ${copyright.years} Mountainminds GmbH & Co. KG and Contributors |
| 137 |
</div> |
| 138 |
|
| 139 |
</body> |
| 140 |
</html> |