Update README. Fix copyright.sh script to be runnable from anywhere (#19)

This commit is contained in:
Joe DiPol
2018-09-06 16:33:57 -07:00
committed by GitHub
parent d08df8dbcc
commit 2c7689019f
2 changed files with 24 additions and 1 deletions

View File

@@ -50,7 +50,10 @@ See Getting Started at <http://helidon.io>.
## Build
You will need Java 9 and Maven 3.5 or newer.
You can build Helidon using JDK 8 or 9. Building with 9 results in jar
files that are valid Java 9 modules containing Java 8 bytecodes.
You also need Maven. We recommend 3.5 or newer.
**Full build**
```bash
@@ -76,3 +79,22 @@ $ mvn validate -Pcopyright
# Cd to the component you want to check
$ mvn verify -Pspotbugs
```
**Build Scripts**
Build scripts are located in `etc/scripts`. These are primarily used by our pipeline,
but a couple are handy to use on your desktop to verify your changes.
* `copyright.sh`: Run a full copyright check
* `checkstyle.sh`: Run a full style check
## Contributing
We are just getting started, so bear with us while we get the project up and running.
We'll have more details about contributing shortly.
We do know that for a pull request to be merged we need the contributor to sign the
Oracle Contributor Agreement first. See
http://www.oracle.com/technetwork/community/oca-486395.html
for details.

View File

@@ -44,6 +44,7 @@ source ${WS_DIR}/etc/scripts/wercker-env.sh
die(){ echo "${1}" ; exit 1 ;}
mvn -q org.glassfish.copyright:glassfish-copyright-maven-plugin:copyright \
-f ${WS_DIR}/pom.xml \
-Dcopyright.exclude=${WS_DIR}/etc/copyright-exclude.txt \
-Dcopyright.template=${WS_DIR}/etc/copyright.txt \
-Dcopyright.scm=git \