The method here is described in terms of using a command line. You can easily do this on linux or in a Terminal window in macOS. You can do it in Windows.
* Java 11 compliant JDK
-* gradle 5.2 or above
+* gradle 5.2 or above *(NB gradle 6.6 and above currently produces NullPointerExceptions during the build. This is non-fatal and does not affect the build. Use gradle 6.5.1 to avoid this)*
* git
> The versions and installation methods here are just suggestions (which we have tested
`utils/install4j/` | files used by the packaging tool, install4j
`build.gradle` | the build file used by gradle
`gradle.properties` | configurable properties for the build process
+ `RELEASE` | propertyfile configuring JALVIEW_VERSION (from jalview.version) and the release branch (from jalview.release). An alternative file can be specified via JALVIEW_RELEASE_FILE property
Note that you need a Java 11 JDK to compile Jalview whether your target build is Java 1.8 or Java 11.
We have made significant customisations to the `getdown` launcher which you can find
in `getdown/src/getdown`.
-> You don't need to build this afresh as the required `gradle-core.jar`
-and `gradle-launcher.jar` files are already distributed in `j11lib` and `getdown/lib` but if you want to, then
+> You don't need to build this afresh as the required `getdown-core.jar`
+and `getdown-launcher.jar` files are already distributed in `j11lib` and `getdown/lib` but if you want to, then
you'll need a working Maven and also a Java 8 JDK. Ensure the Java 8 `javac` is forefront
in your path and do
>
>cd getdown/src/getdown
>mvn clean package -Dgetdown.host.whitelist="jalview.org,*.jalview.org"
>```
-> and you will find the required `.jar` files in `core/target/gradle-core-XXX.jar`
-and `launcher/target/gradle-launcher-XXX.jar`. The `gradle-core.jar` should then be copied
-to all three of the `j8lib`, `j11lib` and `getdown/lib` folders, whilst the `gradle-launcher.jar` only
+> and you will find the required `.jar` files in `core/target/getdown-core-XXX.jar`
+and `launcher/target/getdown-launcher-XXX.jar`. The `getdown-core.jar` should then be copied
+to all three of the `j8lib`, `j11lib` and `getdown/lib` folders, whilst the `getdown-launcher.jar` only
needs to be copied to `getdown/lib`.
>
>The `mvn` command should ideally include the `-Dgetdown.host.whitelist=*.jalview.org` setting.
getdown, and the final argument, "`jalview`", is a getdown application id (only "`jalview`"
is defined here).
+The command line sequence for building and relocating the getdown artifacts can be executed as a script via `getdown/src/getdown/mvn_cmd`. Please make sure this script is kept up to date should the getdown build instructions change.
### Running tests
Note that bamboo_planKey should be set by the build plan with `-Pbamboo_planKey=${bamboo.planKey}`
- application subdir as `alt`
- Getdown launcher cannot use a `file://` scheme appbase.
-* `DEVELOP`: This is for creating a `develop` appbase channel on the main web server. This won't become live until the actual getdown artefact is synced to the web server.
+* `DEVELOP`: This is for creating a `develop` appbase channel on the main web server. This won't become live until the actual getdown artefact is synced to the web server.
It will set
- `appbase` as `http://www.jalview.org/getdown/develop/JAVA_VERSION`
- application subdir as `alt`
gradle getdown -PCHANNEL=SCRATCH-my_test_version
```
+#### JALVIEW_VERSION and the RELEASE file
+Any Jalview build will include the value of JALVIEW_VERSION in various places, including the 'About' and Jalview Desktop window title, and in filenames for the stand-alone executable jar. You can specify a custom version for a build via the JALVIEW_VERSION property, but for most situations, JALVIEW_VERSION will be automatically configured according to the value of the CHANNEL property, using the `jalview.version` property specified in the RELEASE file:
+ - `CHANNEL=RELEASE` will set version to jalview.version
+ - `CHANNEL=TEST or DEVELOP` will append '-test' or '-develop' to jalview.version
+
+It is also possible to specify a custom location for the RELEASE file via an optional JALVIEW_RELEASE_FILE property.
+
#### `install4jMediaTypes`
If you are building *install4j* installers (requires *install4j* to be installed) then this property specifies a comma-separated
list of media types (i.e. platform specific installers) *install4j* should actually build.
in our preferred style. We also support running the Jalview application, debugging
and running tests with TestNG from within Eclipse.
-To get Jalview set up as a project in Eclipse, we recommend using at least the 2019-12
+To get Jalview set up as a project in Eclipse, we recommend using at least the 2020-03
version of Eclipse IDE for Java Developers which you can download from the Eclipse
website: <https://www.eclipse.org/downloads/>. Since Eclipse 2020-03 you are encouraged to use the Eclipse Installer (see the Eclipse Downloads page).
In the installer, when given a choice of packages for Eclipse you should choose the "Eclipse IDE for Enterprise Java Developers" package.
1. TestNG for Eclipse (optional -- only needed if you want to run tests from Eclipse)
> At time of writing, TestNG for Eclipse does not show up in the Eclipse Marketplace
-as the latest released version does not install in Eclipse 2019-03.
+as the latest released version does not install in Eclipse 2020-03.
However, you can install a working release of TestNG for Eclipse by going to
>
Help->Install New Software...
If you have already downloaded Jalview using `git clone` then you can import this folder into Eclipse directly.
+__Before importing the cloned git repo you must create the Eclipse project files.__ You can do this by either running
+
+`gradle eclipse`
+
+or
+
+Unzipping the file `utils/eclipse/eclipse_startup_files.zip` in the base repo directory (`jalview`)
+
It is important to import
Jalview as a Gradle project (not as a Java project), so go to
git://source.jalview.org / jalview.git / blobdiff