| == Prerequisites |
| |
| Already installed on your machine or install it: |
| |
| * Java 8: |
| ** Oracle Java SE 8u201 and higher + |
| http://www.oracle.com/technetwork/java/javase/downloads/ |
| ** AdoptJDK: openJDK 8 with HotSpot |
| https://adoptopenjdk.net/ |
| * Git: https://git-scm.com |
| |
| Test, if programs are available from a console: |
| |
| * `>java -version` |
| * `>git --version` |
| |
| If not, add the programs to your PATH variable or set corresponding ** *_HOME variables**. |
| |
| === Gradle |
| |
| See https://gradle.org/install/ for installation on you system. |
| Version: 4.10.2 (updated 21.2.2020) |
| This is optional, as the projects are using the Gradle Wrapper which is delivered with the source code. |
| |
| === Eclipse IDE |
| Get the current “Eclipse IDE for Enterprise Java Developers” Distribution from https://www.eclipse.org/downloads |
| It is recommended to use the Eclipse Installer. |
| |
| Install Plugins: |
| |
| * SonarLint via Eclipse Marketplace |
| * EclEmma Code Coverage Tool (optional) |
| |
| Create a new workspace for the mdmbl project and configure it: |
| |
| * set encoding to UTF-8 |
| * set Java Code Style formatting rules to the Eclipse default rules [built in] |
| |
| **Formatter:** |
| |
| We highly recommend to use the Eclipse 2019/03 or higher IDE. Set the formatting rules to the Eclipse default rules [built in]. |
| If you use a former version, then import the formatting rules from: |
| org.eclipse.mdm/tools/eclipse_formatter.xml |
| |
| This is **important** as the default rules in Eclipse have changed with the releases. |
| |
| ==== Install Eclipse Copyright Tool |
| |
| For proper maintenance of the copyright header install this tool and run it before pushing to Gerrit. |
| |
| Help > Install New Software… |
| |
| Choose the appropriate Update Site for your Eclipse version -> Choose Releng Tools |
| |
| image::images/CopyrightTool1.png[] |
| |
| **Configuration of Eclipse copyright tool:** |
| |
| The Copyright Tool is configured using the preferences. |
| |
| image::images/CopyrightTool2.png[] |
| |
| **Template text:** |
| |
| **** |
| |
| Copyright (c) ${date} Contributors to the Eclipse Foundation |
| |
| See the NOTICE file(s) distributed with this work for additional |
| information regarding copyright ownership. |
| |
| This program and the accompanying materials are made available under the |
| terms of the Eclipse Public License v. 2.0 which is available at |
| http://www.eclipse.org/legal/epl-2.0. |
| |
| SPDX-License-Identifier: EPL-2.0 |
| |
| **** |
| |
| ==== Use Eclipse copyright tool |
| Once installed and configured, the Copyright tool can accessed via context menu on a project + |
| -> Fix copyright |
| |
