Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/Papyrus Developer Guide"
< Papyrus
| (144 intermediate revisions by 18 users not shown) | |||
| Line 1: | Line 1: | ||
== Development Environment == | == Development Environment == | ||
| − | To ease the development on Papyrus, each member of the team works with basically the same configuration. | + | To ease the development on Papyrus, each member of the team works with basically the same configuration. |
| + | There are two ways to get yrou development environement: | ||
| + | * downloading and installing Eclipse | ||
| + | * using the [[Eclipse Installer]] (by Oomph) to manage your Papyrus development workbench. | ||
| − | === | + | === Downloading Eclipse === |
| + | You can download a fresh Eclipse Package release on this [https://www.eclipse.org/downloads/packages/ page]. | ||
| + | We advice you to download the Eclipse Committer version. | ||
| − | + | === Papyrus Oomph Setup Model === | |
| − | + | The [[Eclipse Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way). | |
| − | Papyrus | + | Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push. |
| − | + | Amongst possibly other details, the setup model configures: | |
| − | + | * your IDE with all of the tools needed to edit and build the source projects you choose | |
| + | * your workspace with a Git clone and the source projects imported from it that you choose | ||
| + | * a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench | ||
| + | * Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database | ||
| + | * Mylyn queries for the status of the latest Papyrus automated builds, including tests | ||
| + | * Mylyn queries for open Gerrit reviews | ||
| + | * preferences enforcing the Papyrus standard compiler and code formatter/template settings | ||
| − | + | Please raise bugs if you see any problems in the setup configuration. | |
| − | + | Follow the following link for a step by step installation guide: [[Papyrus_Developer_Guide/Papyrus_With_Oomph | Oomph setup guide]] | |
| − | === | + | === Installation details === |
| − | + | Following is a description of the basic configuration: | |
| − | + | *The latest Eclipse release pertinent to your usecases (Modeling, Committer, java, etc) | |
| + | *the Papyrus release (matching your Eclipse version), installed from the relevant [https://www.eclipse.org/papyrus/download.html#main Papyrus update site] | ||
| + | ** Papyrus SDK | ||
| + | ** Papyrus Toolsmiths | ||
| + | ** Papyrus Releng Tools | ||
| + | ** Papyrus User Examples | ||
| − | [ | + | ===Additional useful tools=== |
| − | + | *[http://jautodoc.sourceforge.net/ JAutoDoc] | |
| − | + | * install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases) | |
| − | + | ||
| − | + | === Java version === | |
| − | + | OpenJDK 1.8 (or higher) is recommanded. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ==Configuration== | |
| − | * | + | *Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc |
| − | * | + | *Configure your Eclipse.ini file adding this line in the ''vmargs'': |
| − | + | <pre>-Duser.name=FirstName LastName (Company) <user@email></pre> | |
| − | + | *Java 1.8: | |
| − | * | + | **Eclipse Preferences -> Java -> Compiler |
| − | + | **Eclipse Preferences -> Java -> Installed JREs | |
| − | ** | + | **VM Arguments for debug mode: |
| − | ** | + | <pre>-Dosgi.requiredJavaVersion=1.8 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled |
| − | ** | + | </pre> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | === | + | === Version Management Tooling === |
| − | + | There are two way to manage your code version: | |
| − | + | *define yourself the API baseline for Papyrus using [https://help.eclipse.org/2020-06/index.jsp?nav=%2F4_2_3 Eclipse Preference API Baseline] | |
| − | * | + | *Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]] |
| − | * | + | |
| − | + | ||
| − | + | ||
| + | *API Rules: | ||
| + | **[[Evolving_Java-based_APIs]] | ||
| + | **[[Evolving_Java-based_APIs_2]] | ||
| + | **[[Evolving_Java-based_APIs_3]] | ||
| − | === | + | === Apply Papyrus configuration files === |
| − | + | Papyrus provides configuration files for Template, CleanUp, and Format for java code. | |
| + | Register these files into your Eclipse Preferences. | ||
| + | The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/Papyrus%20Code%20templates.xml Code Templates], [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_cleanup.xml Java Cleanup] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_formatter.xml Java Formatter] files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus. | ||
| − | + | [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]] | |
| − | + | [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]] | |
| − | [ | + | [https://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment. |
| − | == | + | == How To ... == |
| − | + | Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]]. | |
| − | == | + | === Cloning the Git repository and importing the code === |
| − | + | The Papyrus code and some documents are located in a Git repository. In the website [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git] you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git). | |
| − | + | Follow this [[Papyrus_Developer_Guide/Papyrus_Git_Tutorial | quick tutorial]] if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace. | |
| − | + | === Gerrit Contributions === | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | *[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to contribute via Gerrit]] | |
| − | + | === Code Contributions and Reviews === | |
| − | + | *[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]] | |
| − | + | === Papyrus Diagram Generation === | |
| − | + | *Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]] | |
| − | + | === Papyrus Code Examples === | |
| − | + | *How to - Related to Papyrus code,[[Papyrus Developer Guide/How To Code Examples]]<br> | |
| − | + | === Papyrus Plug-ins and Features === | |
| − | + | See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]] | |
| − | + | ||
| − | + | == Release Engineering == | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | === Release Plans === | |
| − | + | The specifications are available here: | |
| + | * [https://wiki.eclipse.org/Oxygen/Simultaneous_Release_Plan Oxygen release plan] | ||
| + | * [https://wiki.eclipse.org/Photon/Simultaneous_Release_Plan Photon release plan] | ||
| − | + | Future Release plans should become available here: | |
| + | * [https://wiki.eclipse.org/SimRel/Simultaneous_Release_Cycle_FAQ#What_is_the_schedule_of_the_next_releases_.3F Eclipse 20xx.xx release plan] | ||
| − | + | === Contributing to the plan for the release === | |
| − | + | * [[Papyrus Developer Guide/Contributing To Release Plan | Contribute to the Release Plan]] | |
| + | * [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]] | ||
| − | + | === Release Process === | |
| − | + | *[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]]. | |
| + | *[[Papyrus Developer Guide/Release Process: Doc | Releng Documentation]]. | ||
| + | *[[Papyrus Developer Guide/Release Standard Operating Procedure: Doc | Release Standard Operating Procedure]]. | ||
| − | + | === API Evolution === | |
| − | + | *Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]] | |
| − | + | ||
| − | === | + | === Hudson Instance === |
| − | + | ||
| − | + | *Papyrus Hipp standard guide: [[Papyrus Developer Guide/How to use the Hipp and its functionalities]]. | |
| − | |||
| − | + | [[Category:Papyrus]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 10:27, 1 July 2020
Development Environment
To ease the development on Papyrus, each member of the team works with basically the same configuration. There are two ways to get yrou development environement:
- downloading and installing Eclipse
- using the Eclipse Installer (by Oomph) to manage your Papyrus development workbench.
Downloading Eclipse
You can download a fresh Eclipse Package release on this page. We advice you to download the Eclipse Committer version.
Papyrus Oomph Setup Model
The Eclipse Installer provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand Eclipse.org / Papyrus to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.
Amongst possibly other details, the setup model configures:
- your IDE with all of the tools needed to edit and build the source projects you choose
- your workspace with a Git clone and the source projects imported from it that you choose
- a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
- Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
- Mylyn queries for the status of the latest Papyrus automated builds, including tests
- Mylyn queries for open Gerrit reviews
- preferences enforcing the Papyrus standard compiler and code formatter/template settings
Please raise bugs if you see any problems in the setup configuration.
Follow the following link for a step by step installation guide: Oomph setup guide
Installation details
Following is a description of the basic configuration:
- The latest Eclipse release pertinent to your usecases (Modeling, Committer, java, etc)
- the Papyrus release (matching your Eclipse version), installed from the relevant Papyrus update site
- Papyrus SDK
- Papyrus Toolsmiths
- Papyrus Releng Tools
- Papyrus User Examples
Additional useful tools
- JAutoDoc
- install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases)
Java version
OpenJDK 1.8 (or higher) is recommanded.
Configuration
- Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
- Configure your Eclipse.ini file adding this line in the vmargs:
-Duser.name=FirstName LastName (Company) <user@email>
- Java 1.8:
- Eclipse Preferences -> Java -> Compiler
- Eclipse Preferences -> Java -> Installed JREs
- VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=1.8 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
Version Management Tooling
There are two way to manage your code version:
- define yourself the API baseline for Papyrus using Eclipse Preference API Baseline
- Oomph includes a way to manage the version changes between two releases as illustrated here
Apply Papyrus configuration files
Papyrus provides configuration files for Template, CleanUp, and Format for java code. Register these files into your Eclipse Preferences. The Papyrus Code Templates, Java Cleanup and Java Formatter files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.
FAQ How do I control the Java formatter
FAQ How can templates make me the fastest coder ever
The note explains how to install the templates in your environment.
How To ...
Each developer must follow the following rule in addition to the aforementioned Developer Charter.
Cloning the Git repository and importing the code
The Papyrus code and some documents are located in a Git repository. In the website http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).
Follow this quick tutorial if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.
Gerrit Contributions
Code Contributions and Reviews
Papyrus Diagram Generation
- Papyrus generation mechanism is explained here: Papyrus Developer Guide/Papyrus diagram generation
Papyrus Code Examples
- How to - Related to Papyrus code,Papyrus Developer Guide/How To Code Examples
Papyrus Plug-ins and Features
See Papyrus code standards for plug-ins and features
New plugin should follow the submition process describe here: Papyrus New Plugin Submission Process
Release Engineering
Release Plans
The specifications are available here:
Future Release plans should become available here:
Contributing to the plan for the release
Release Process
API Evolution
- Papyrus API Evolution Reports: Papyrus Developer Guide/API Evolution Reports
Hudson Instance
- Papyrus Hipp standard guide: Papyrus Developer Guide/How to use the Hipp and its functionalities.