blob: 482c3de27c7a1e2803625c08f8c5b07cc6d0dcaa [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>SysML - Developer</title>
</properties>
<body>
<section name="Developer">
<p>This section is dedicated for developers. It should be the main entry point.</p>
</section>
<section name="Requirements">
<subsection name="Eclipse">
<p>Use Eclipse, at least Mars version</p>
</subsection>
<subsection name="Maven">
<p>Use Maven 3.3.1 at least</p>
</subsection>
<subsection name="Eclipse plugins">
<p>Install M2e plugin in your Eclipse</p>
<p>Install Tycho Configurator as an additional maven connector</p>
<p>No specific extra from papyrus</p>
</subsection>
<subsection name="SysML">
<p>
Have a look to the normative document of OMG:
<a
href="https://hudson.eclipse.org/papyrus/view/Sysml/job/papyrus-sysml-website/ws/target/site/norm/ptc-13-12-10.pdf#3">Embedded norm</a>
</p>
</subsection>
<subsection
name="Check your installation by a basic checkout, compilation">
<ul>
<li>
Clone the sysml 14 git repository git clone
https://git.eclipse.org/r/papyrus/org.eclipse.papyrus-sysml.
</li>
<li>
Run maven at the root of the repo: mvn clean install; it should
pass
</li>
<li>
Get sysml14 plugins in your eclipse workspace
</li>
<li>Et “Voila” you are good to go.</li>
</ul>
</subsection>
</section>
<section
name="Example of a minimal iteration: from bug, to requirement, to code integration through gerrit review.">
<ul>
<li>
Describe in Bugzilla the bug, feature you are working on.
Please
use the component SysML. And begins with [SysML 1.4] for
Summary.
</li>
<li>
Get the code from the master with git,git clone
https://git.eclipse.org/r/papyrus/org.eclipse.papyrus-sysml, and
work on a local
branch,
</li>
<li>
Add the new requirement in the different sysml 1.1 models located
in the doc folder of the relevant plugin. have a look to
<a href="sop4-requirement.html">SOP4: Requirement</a>
</li>
<li>Modify the code</li>
<li>Push on Gerrit
ssh://{ECLISPEUSERLOGIN}@git.eclipse.org:29418/papyrus/org.eclipse.papyrus-sysml
</li>
<li>Ask for a review https://git.eclipse.org/r/#/dashboard/self</li>
<li>After a few iteration, you code should be merged and accessible
in the master.
</li>
</ul>
</section>
<section name="Product Life Cycle Management with Maven">
<subsection name="Run a default installation">
<source>mvn clean install
</source>
</subsection>
<subsection
name="To build also the modules relatives to RCP and Product, please activate the following profile:">
<source>mvn clean install -Pproduct
</source>
</subsection>
<subsection name="Generate and deploy the web site">
<source>mvn clean site site:stage-deploy scm-publish:publish-scm
-Pdocumentation
</source>
</subsection>
</section>
<section name="Standard Operating Procedures">
<ul>
<li>
<a href="sop1-normRequirementExtraction.html">SOP1: OMG Norm requirements automanual extraction</a>
</li>
<li>
<a href="sop2-toolGeneration.html">SOP2: From a OMG profile to a dedicated Papyrus
application (elementype, palette etc...)
</a>
</li>
<li>
<a href="sop3-upgradingNorm.html">SOP3: Extended the norm by adding a new operation.</a>
</li>
<li>
<a href="sop4-requirement.html">SOP4: Add a new requirement.</a>
</li>
</ul>
</section>
</body>
</document>