Skip to main content
Jump to: navigation, search

Difference between revisions of "Henshin/Committer Instructions"

m (Importing projects into your workspace and resolving dependencies)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Henshin uses [https://git.eclipse.org/r/#/ Gerrit] for handling code reviewing and merging. This implies specific processes when setting up the development environment and pushing changes. See also the official primer for [https://www.eclipse.org/community/eclipse_newsletter/2014/july/article3.php Contributing to Eclipse Projects via Gerrit].
+
This page provides two important types of '''Instructions to Henshin committers''': The set-up for working on the codebase with Gerrit, and the instructions for importing projects and resolving their dependencies in your local workspace.
  
 
== Set-up ==
 
== Set-up ==
 +
 +
Henshin uses [https://git.eclipse.org/r/#/ Gerrit] for handling code reviewing and merging. This implies specific processes when setting up the development environment and pushing changes. See also the official primer for [https://www.eclipse.org/community/eclipse_newsletter/2014/july/article3.php Contributing to Eclipse Projects via Gerrit].
 +
 
The following steps are for setting up the development environment based on eGit, Eclipse's git integration. Steps may vary if you don't want to use eGit.
 
The following steps are for setting up the development environment based on eGit, Eclipse's git integration. Steps may vary if you don't want to use eGit.
  
Line 17: Line 20:
 
# In the Git perspective, open the Repository: ''Remotes -> '' Right click on ''origin -> Gerrit Configuration... -> Finish''.
 
# In the Git perspective, open the Repository: ''Remotes -> '' Right click on ''origin -> Gerrit Configuration... -> Finish''.
 
# Follow the steps outlined in the next section.
 
# Follow the steps outlined in the next section.
 +
 +
After pushing a change, a corresponding entry on [https://git.eclipse.org/r/#/ Gerrit] has been created. Please invite (a subset of) the other committers as reviewers, doing this for all changes.
 +
 +
[[category:Henshin]][[Category:Modeling]]
  
 
==<span id="imports"></span>Importing projects into your workspace and resolving dependencies ==
 
==<span id="imports"></span>Importing projects into your workspace and resolving dependencies ==
Line 28: Line 35:
 
All plug-in projects are contained in the ''plugins'' folder in the root directory of our Git repo. Import the plug-ins you want to work on '''as Eclipse projects''' into your workspace. Depending on your selection, you may encounter various build errors. To resolve them, install dependencies as necessary. The provided links refer to ''update sites'' and '''cannot''' be opened in the browser. Use them to install the dependencies in Eclipse via ''Help'' -> ''Install New Software''.
 
All plug-in projects are contained in the ''plugins'' folder in the root directory of our Git repo. Import the plug-ins you want to work on '''as Eclipse projects''' into your workspace. Depending on your selection, you may encounter various build errors. To resolve them, install dependencies as necessary. The provided links refer to ''update sites'' and '''cannot''' be opened in the browser. Use them to install the dependencies in Eclipse via ''Help'' -> ''Install New Software''.
  
* [http://download.eclipse.org/modeling/gmp/gmf-tooling/updates/releases-3.2.1/ Graphical Modeling Framework Tooling 3.2.1]: needed for ''org.eclipse.emf.henshin.diagram''.
+
* [http://download.eclipse.org/releases/oxygen/ Papyrus for UML]: needed for ''org.eclipse.emf.henshin.diagram''. In the update site, find Papyrus in the ''Modeling'' category, or by using the filter. Papyrus provides some legacy components of GMF Tooling that are required by Henshin's GMF-based diagram editor.
 
* [http://download.eclipse.org/technology/m2e/releases Maven Integration for Eclipse]: needed for ''org.eclipse.emf.henshin.giraph''.
 
* [http://download.eclipse.org/technology/m2e/releases Maven Integration for Eclipse]: needed for ''org.eclipse.emf.henshin.giraph''.
 
* [http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/ Eclipse Xtext]: needed for ''org.eclipse.emf.henshin.text'' projects. On further build errors, trigger the Xtext generation process: navigate to ''org.eclipse.emf.henshin.text -> GenerateHenshin_text.mwe2'', right click and do ''Run As -> MWE2 Workflow''.
 
* [http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/ Eclipse Xtext]: needed for ''org.eclipse.emf.henshin.text'' projects. On further build errors, trigger the Xtext generation process: navigate to ''org.eclipse.emf.henshin.text -> GenerateHenshin_text.mwe2'', right click and do ''Run As -> MWE2 Workflow''.
Line 37: Line 44:
  
 
To resolve further build errors in ''org.eclipse.emf.henshin.adapters.xtext'' right click the project -> ''Properties'' -> ''Resource'' and set the text file encoding to ''Other: UTF-8''.
 
To resolve further build errors in ''org.eclipse.emf.henshin.adapters.xtext'' right click the project -> ''Properties'' -> ''Resource'' and set the text file encoding to ''Other: UTF-8''.
 
== Pushing changes ==
 
 
After pushing a change, a corresponding entry on [https://git.eclipse.org/r/#/ Gerrit] has been created. Please invite (a subset of) the other committers as reviewers, doing this for all changes.
 
 
[[category:Henshin]][[Category:Modeling]]
 

Latest revision as of 03:24, 9 July 2019

This page provides two important types of Instructions to Henshin committers: The set-up for working on the codebase with Gerrit, and the instructions for importing projects and resolving their dependencies in your local workspace.

Set-up

Henshin uses Gerrit for handling code reviewing and merging. This implies specific processes when setting up the development environment and pushing changes. See also the official primer for Contributing to Eclipse Projects via Gerrit.

The following steps are for setting up the development environment based on eGit, Eclipse's git integration. Steps may vary if you don't want to use eGit.

  1. To be able to push commits to Gerrit, please register an Eclipse account and log into Gerrit.
  2. If you don't have one yet, generate a SSH RSA key pair: do ssh-keygen -t rsa in the git shell.
  3. Register your public key at https://git.eclipse.org/r/#/settings/ssh-keys
  4. Make sure your local git's committer e-mail address matches the one registered at https://git.eclipse.org/r/#/settings/contact
    • To view the local e-mail address, do git config user.email. An empty result means the e-mail address has not been set yet.
    • To change the local e-mail address, do git config --global user.email [your email address here]
    • In the same manner, you can view and change your committer name using the user.name environment variable.
  5. To ensure correct handling of line endings when using Windows, please use the following git configs: core.autocrlf=true and core.filemode=false. If you have dirty projects due to Windows line endings, try a hard reset after setting the config.
  6. In Eclipse, clone the Henshin repository using one of the URLs (git, http, ssh) given at the repository website. We recommend the following workflow:
    • For cloning the initial state of the repo, use the (read-only) GIT repository URL. Cloning the entire Repo via the SSH URL may lead to timeouts.
    • After cloning, change the repository location to the SSH repository URL (do git remote set-url origin <gerrit-url>, or follow the eGit instructions)
  7. In the Git perspective, open the Repository: Remotes -> Right click on origin -> Gerrit Configuration... -> Finish.
  8. Follow the steps outlined in the next section.

After pushing a change, a corresponding entry on Gerrit has been created. Please invite (a subset of) the other committers as reviewers, doing this for all changes.

Importing projects into your workspace and resolving dependencies

Henshin's codebase is divided into several plug-in projects with different responsibilies, for example:

  • Plug-in org.eclipse.emf.henshin.model: The meta-model
  • Plug-in org.eclipse.emf.henshin.diagram: The graphical editor
  • Plug-in org.eclipse.emf.henshin.interpreter: The interpeter
  • Plug-ins org.eclipse.emf.henshin.{edit,editor}: The tree-based editor


All plug-in projects are contained in the plugins folder in the root directory of our Git repo. Import the plug-ins you want to work on as Eclipse projects into your workspace. Depending on your selection, you may encounter various build errors. To resolve them, install dependencies as necessary. The provided links refer to update sites and cannot be opened in the browser. Use them to install the dependencies in Eclipse via Help -> Install New Software.

  • Papyrus for UML: needed for org.eclipse.emf.henshin.diagram. In the update site, find Papyrus in the Modeling category, or by using the filter. Papyrus provides some legacy components of GMF Tooling that are required by Henshin's GMF-based diagram editor.
  • Maven Integration for Eclipse: needed for org.eclipse.emf.henshin.giraph.
  • Eclipse Xtext: needed for org.eclipse.emf.henshin.text projects. On further build errors, trigger the Xtext generation process: navigate to org.eclipse.emf.henshin.text -> GenerateHenshin_text.mwe2, right click and do Run As -> MWE2 Workflow.
  • QVT Operational: needed for org.eclipse.emf.henshin.text.transformation. Navigate to the Metamodel Mappings: right click the project org.eclipse.emf.henshin.text.transformation -> Properties -> Metamodel Mappings. There add mappings for org.eclipse.emf.henshin.model/model/henshin.ecore and org.eclipse.emf.henshin.text/model/generated/Henshin_text.ecore: Add -> Browse -> navigate to .ecore-file.
  • EMF Compare: needed for org.eclipse.emf.henshin.interpreter.ui, org.eclipse.emf.henshin.multicda.cpa and org.eclipse.emf.henshin.text.transformation.tests.
  • AGG Runtime: needed for org.eclipse.emf.henshin.multicda.cpa. During installation filter for AGG Runtime to find the package.


To resolve further build errors in org.eclipse.emf.henshin.adapters.xtext right click the project -> Properties -> Resource and set the text file encoding to Other: UTF-8.

Back to the top