dlr-sc / maven-tycho-demo

A sample project explaining Maven Tycho for Eclipse RCP applications.

Maven Tycho Demo

A Maven Tycho Demo project for Eclipse RCP applications such as Virtual Satellite.

Project Status

Status for Development build.

Status for Integration build.

Status for Master build.

Purpose

1. This project is a test setup to make Virtual Satellite open source. it helps to transform the software engineering processes from the internal towards the GitHub infrastructure.
2. Maven Tycho can be very complicated. This project helps developers that are new to Maven Tycho. This project provides core functionality to automate an Eclipse RCP build process and helps setting up such process.

Requirements

This Maven Tycho Demo is based on Java / Eclipse. The following infrastructure is required:

• Java Development Kit (JDK) 8
• Eclipse Oxygen or newer
  • Including Checkstyle
  • Including Spotbugs
  • Including M2E
• Maven 3
• Windows 7 or Linux Computer

Quickstart

1. Open your Eclipse and switch to the Git Perspective.
2. Clone this repository.
3. Import all projects and working-sets via the ProjectSet file in de.dlr.maven.tycho.demo/projectSet
4. Resolve and set the targe tplatform in _de.dlr.maven.tycho.demo.target/mavenTychoDemo.target
5. Execute the launchers for running the RCP application from within de.dlr.maven.tycho.demo/launchers
6. Execute the Tycho Maven build from de.dlr.maven.tycho.demo/launchers
7. Inspect the build artifacts for the p2 repository in de.dlr.maven.tycho.p2updatesite/target
8. Inspect the build RCP application in de.dlr.maven.tycho.product/target

Travis CI and Releases

Tarvis CI is set-up to start a build job for every branch and every new commit to the repository. It executes all relevant tests such as jUnit, SWTBot, Checkstyle, SpotBugs, etc. Making a successful pull-request into development requires all tests to pass.

Starting a Travis CI job on development or integration deploys all relevant artifacts.

For creating a new release, create a tag starting with Release_ on the master branch. All artifacts are automatically deployed.

Provided Features

This example intends to represent a realistic scenario for building an Eclipse based RCP application such as Virtual Satellite. Accordingly it provides the following features:

• Maven Tycho Build Process for Eclipse RCP Applications
• Examples for Build with maven and eclipse
• Examples for Development, Integration and Release builds
• Examples for Features, Plugins, Products, Update Sites
• Examples for License Feature
• Examples for Branding Feature
• Examples for Documents Feature with Release Notes and API Doc
• Examples for External Library Dependencies
• Examples for Test Fragments
• Integration of JUnit tests
• Integration of Checkstyle tests
• Integration of Spotbug checks
• Standalone Maven Tycho build process
• Eclipse IDE Integrated Maven Tycho build process

Downloads and Deployment

Deployments are done using GitHub Releases as well as sourceforge:

Software Engineering Requirements

This project follows DLR Software Engineering Requirements for application class 1 as documented in the Checklist.

Contribution

To contribute to this project follow the given steps:

1. Create your own fork of the project.
2. Apply your changes.
3. Create a pull-request of your change to our development branch.

To increase chance that we accept your pull-request, make sure all tests are working. The best indicator is the Travis CI job. Next we will review your pull-request, give comments and maybe accept it.

License

Copyright 2019 German Aerospace Center (DLR)

The German Aerospace Center (DLR) makes available all content in this plug-in ("Content"). Unless otherwise indicated below, the Content is provided to you under the terms and conditions of the Eclipse Public License Version 2.0 ("EPL"). A copy of the EPL is available at https://www.eclipse.org/legal/epl-2.0. For purposes of the EPL, "Program" will mean the Content.

If you did not receive this Content directly from German Aerospace Center (DLR), the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content. Check the Redistributor's license that was provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise indicated below, the terms and conditions of the EPL still apply to this content.

Third Party Licenses

Third party licenses are named in the plug-ins where used in the respective aboutfiles folders. At runtime third party licenses can be viewed in the usual Eclipse About dialog.

maven-tycho-demo's Issues

Enable Static Code Analysis with SpotBugs

• Enable Spotbugs in project
• Enable Spotbugs for IDE builds and development
• Enable Spotbugs for maven/tycho CI jobs

Add EPL header also to poms

• Add the EPL header also to the pom files.

Fixing build

Build is broken. Need to update Linux distribution etc.

Setting up Travis CI job

Investigate Deployment to Sourceforge

Looking to other sources some people prefer sourceforge over bintray.

See this blog psot for example: http://www.lorenzobettini.it/2015/01/publish-an-eclipse-p2-repository-on-sourceforge-with-rsync/

Other projects such as checkstyle for eclipse are using source forge as well: https://sourceforge.net/projects/eclipse-cs/

We will give it a try to setup sourceforge for deployment

Release 0.3.0

• perform integration
• perform release

Enable project for external contributions

Got some request to open up for external contribution.

External Contribution should most likely done by PullRequests from forked repositories.

This could be explained in the readme.md.

⚠️ 💥 Nevertheless transition to EPL 2.0 in #4 has to be finished and closed first. 💥 ⚠️

Example Deployment to BinTray

Deploying only via GitHub Release is not sufficient for Eclipse p2 repositories.

An idea is to try out the OSS variant of bintray for p2 artifact deployment.

Internationalization

What about internationalization? I think most of the gui apps will need this.

Release 0.5.0

• prepare release

Create new Release for testing deployment to sourceforge

Update to Version 0.2.0 and release it

Change Deployment account and improve security

• create a user owned sub-directory first before unencrypting the key
• add new key to deploy with the dlrscmns account to sourceforge

Use Eclipse Public License 2.0

EPL 1.0 is considered deprecated.

Recommended practice to move forward to EPL 2.0.

Check that build exists as exepcted on warnings

• Checkstyle warnings
• Spotbugs Warnings
• Compiler Warnings
• Junit failing test case
• SWT Bot failing test cases

Integrate example of asciidoc generation

https://github.com/virtualsatellite/VirtualSatellite4-Core ahs been extended to compile a manual based on asciidoc within the maven/tycho build process. A little example should be added to this demo as well.

Release 0.4.0

• Go to integration
• Apply final changes and fixes
• Update Version Numbers
• Update Release Notes.

Enable Code Coverage Statistics

Enable code coverage by codecov.io.

SWT Bot UI Tests on Travis CI

The overall example should also integrate an exaple of using SWT Bot for UI testing.

This should also well integrate into Travis CI.

Cycle deployment credentials due to CodeCov Security Issue

CodeCov reported a security issue.

https://about.codecov.io/security-update/

Migrate from Travis-CI to GitHub Actions

Migrate to GitHub actions based on Virtual Satellite actions