1<!--- 2 Licensed to the Apache Software Foundation (ASF) under one or more 3 contributor license agreements. See the NOTICE file distributed with 4 this work for additional information regarding copyright ownership. 5 The ASF licenses this file to You under the Apache License, Version 2.0 6 (the "License"); you may not use this file except in compliance with 7 the License. You may obtain a copy of the License at 8 9 http://www.apache.org/licenses/LICENSE-2.0 10 11 Unless required by applicable law or agreed to in writing, software 12 distributed under the License is distributed on an "AS IS" BASIS, 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 See the License for the specific language governing permissions and 15 limitations under the License. 16--> 17# Building Apache Commons Compress 18 19In order to build Commons Compress a JDK implementation 1.7 or higher 20and Apache Maven 3.x are required. 21 22To install the jars into your local Maven repository simply run 23 24 mvn clean install 25 26which will also run the unit tests. 27 28Some tests are only run when specific profiles are enabled, these 29tests require a lot of disk space as they test behavior for very large 30archives. 31 32 mvn test -Prun-tarit 33 34runs tests for tar archives and requires more than 8GiB of disk space. 35 36 mvn test -Prun-zipit 37 38runs tests for zip archives that require up to 20 GiB of disk 39space. In addition the tests will run for a long time (more then ten 40minutes, maybe even longer depending on your hardware) and heavily 41load the CPU at times. 42 43## Building the Site 44 45The site build produces license release audit (aka RAT) reports as 46well as PMD and findbugs reports. Clirr didn't work for us anymore so 47we switched to japicmp, the same is true for Cobertura which we had to 48replace with jacoco. 49 50japicmp requires the jar to be present when the site is built, 51therefore the package goal must be executed before creating the site. 52 53 mvn package site -Pjacoco 54 55builds the site. 56