| == Introduction |
| |
| === General |
| |
| This document serves as a setup and installation guide for the Eclipse mdmbl project. + |
| For **developers** is describes how to setup the environment, where the source code of the project can be found, retrieved,build and deployed. |
| |
| For **users** interested only in deploying / installing the openMDM Application, start here. |
| |
| **Note**: This guide describes the deployment on a local machine only, |
| for installing the application in a company infrastructure, please contact your administrators to support you with firewalls and proxy configurations, grant permissions, etc. |
| |
| **Mailinglists**: |
| |
| * For development communication we use the mdmbl mailing list: + |
| https://dev.eclipse.org/mailman/listinfo/mdmbl-dev |
| * The openMDM Working group mailing list: + |
| https://dev.eclipse.org/mailman/listinfo/open-measured-data-wg |
| |
| **For contributing to the mdmbl project you need to sign the ECA** + |
| (Eclipse Contributor Agreement): https://wiki.eclipse.org/ECA |
| |
| |
| **Helpful Links:** |
| |
| * Eclipse Wiki - openMDM EWG: + |
| https://wiki.eclipse.org/Open-Measured-Data-Management-WG |
| * Eclipse Project openMDM@BL: + |
| https://projects.eclipse.org/projects/technology.mdmbl |
| * Eclipse Bugzilla mdmbl issues: + |
| https://bugs.eclipse.org/bugs/buglist.cgi?quicksearch=openmdm&list_id=16180271 |
| * openMDM git repos: + |
| link:https://git.eclipse.org/c/?q=mdm[https://git.eclipse.org/c/?q=mdm] |
| |
| **Downloads:** |
| Get the artefacts from the Project Download Page: openMDM_application-<version>.zip + |
| https://projects.eclipse.org/projects/technology.mdmbl/downloads |
| |
| === Requirements and Bugs |
| |
| **Requirements:** |
| |
| * Requirements are created in the Eclipse Bugzilla System [1] |
| * Requirements are ordered by priority and maturity by the Steering Committee |
| * for every REQU issue one or more Eclipse Bugzilla Tasks are created |
| * mdmbl dev team works on the Bugzilla issues [1] + |
| https://bugs.eclipse.org/bugs/buglist.cgi?quicksearch=mdmbl |
| |
| **Bugzilla issues:** |
| |
| * Requirements |
| * “real” bugs from internal or external |
| * technical requirements / enhancements from the team |
| |
| === Use of new Frameworks / IP Management |
| |
| To introduce a new framework to the code the QA guidelines of the EWG and the Legal Process of Eclipse ( |
| https://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf[https://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf] |
| ) has to be followed: |
| |
| * Get the approval for use from the the Architecture Committee. The members of the AC are listed here: + |
| https://wiki.eclipse.org/Open-Measured-Data-Management-WG. |
| * Get the IP approval from the Eclipse Foundation, see: + |
| https://wiki.eclipse.org/images/5/50/OpenMDM_IP_management_and_Software_Licensing.pdf[OpenMDM_IP_management_and_Software_Licensing.pdf] |
| |
| Only if you have both approvals, you can use the libraries in the code! |
| |
| === Branching and versioning |
| |
| There are releases and milestones for the code in org.eclipse.mdm, milestones are marked with “M”, e.g. 5.2.0M2 is the 2nd milestone on the way to the 5.2.0 release. |
| |
| Stable versions are on the **master** branch. + |
| The current development happens on the **dev** branch. + |
| There are also several other branches, please contact us via the mailing list if you need more information. |
| |
| The latest stable version is on the current master. Older stable versions are tagged with the version number, e.g. 5.1.0, 5.2.0M1. |
| |
| For all stable versions the build artefacts and documentation are made available on the mdmbl download page: + |
| https://projects.eclipse.org/projects/technology.mdmbl/downloads |
| |
| Documentation and release notes in Git: + |
| https://git.eclipse.org/c/mdmbl/org.eclipse.mdm.git/tree/ |
| |
| === Eclipse Infrastructure |
| |
| ==== Gerrit |
| |
| The mdmbl project is using Gerrit for code reviews. To configure, refer to chapter |
| https://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf[Configure Gerrit]. |
| |
| Gerrit has a two stage reviewing system: |
| |
| 1. when code is checked into Gerrit, a build is automatically started. Ther Gerrit flag “verified” is set to +1, if the build succeeded |
| 2. a committer has to review the code and if ok, the code review flag is set to +2 |
| |
| |
| ==== Jenkins |
| |
| https://ci.eclipse.org/mdmbl/ |
| |
| There a nightly builds for the dev and the master branches of org.eclipse.mdm + |
| There are also builds for Gerrit and Sonar. |
| |
| ==== Sonar |
| |
| Note: 5.2.0M2 - not working, build scripts under construction + |
| The Eclipse SonarQube server is available via |
| https://sonar.eclipse.org[https://sonar.eclipse.org/]. + |
| Rules: Qualitygate - sonar way with findbugs |
| |
| Static code analysis is configured for the dev branch of org.eclipse.mdm + |
| Generated and test sources are excluded. |
| |
| === ODS Server used for Developer Tests |
| |
| All released versions are tested with the following ODS Server: |
| |
| * HiQSoft GmbH + |
| https://www.highqsoft.com/de/avalon-asam-ods-server/ |
| * Peak Solution GmbH + |
| http://www.peak-solution.de/de/produkte-leistungen/versuchs-messdatenmanagement/softwareloesungen/peak-ods-server/ |
