This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch release
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/release by this push:
new 0f4752b Update basic build instructions.
0f4752b is described below
commit 0f4752ba7f074ebee6c32b2a0fe3cb95d6776881
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Oct 25 14:32:23 2020 -0400
Update basic build instructions.
---
BUILDING.txt | 54 +++++++++++++++++++++++++++++-------------------------
README.txt | 9 ---------
2 files changed, 29 insertions(+), 34 deletions(-)
diff --git a/BUILDING.txt b/BUILDING.txt
index 91d927b..0772315 100644
--- a/BUILDING.txt
+++ b/BUILDING.txt
@@ -1,35 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
Building Apache Commons VFS
-To build Apache Commons VFS, you need a JDK implementation version 1.7 or
greater, and Apache Maven 3.
+To build Apache Commons VFS, you need a JDK at version 8 or greater, and
Apache Maven 3.2.5 or greater.
-To perform the license release audit, a.k.a. "RAT check", run:
+To perform the Release Audit which validate license headers (the "RAT" check),
run:
mvn apache-rat:check
-To perform a Clirr check, run:
-
-mvn clirr:check -pl commons-vfs2
-
-To build the site with Java 7, make sure you give Maven enough memory using
-MAVEN_OPTS with options appropriate for your JVM. Alternatively, you can
-build with Java 8 and not deal with MAVEN_OPTS.
-
-To build the site, from a command line, run:
-
-mvn clean install
-mvn site
-mvn site:stage
-
-To test, run:
-
-mvn test
+The Maven profile test-deploy is used for testing, a release manager will omit
it when it is time to create a
+release candidate.
-Then, to test OSGi, you must first create the jars:
+Build and install all jar files:
+mvn -V -Ptest-deploy -Prelease clean install -DskipTests
-mvn install -DskipTests
-mvn package -DskipTests
+Validate all installed jar files and build all module sites:
+mvn -V -Ptest-deploy -Prelease -P japicmp -P jacoco site
-Next, you can run the tests as usual, which will pick up the jar files to use
as OSGi bundles from the various target
-directories:
+Deploy the jar files:
+ mvn -V -Ptest-deploy -Prelease deploy
-mvn test
+Assemble all sites into one:
+mvn -V -Ptest-deploy -Prelease site:stage
diff --git a/README.txt b/README.txt
deleted file mode 100644
index e3440cc..0000000
--- a/README.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-To build Commons VFS run
-
-mvn clean install
-
-To build the distribution binaries run
-
-mvn -P apache-release clean install
-
-
