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 "Henshin/Committer Instructions"
< Henshin
m |
|||
| Line 2: | Line 2: | ||
== Set-up == | == Set-up == | ||
| − | This is what you need to do for | + | This is what you need to do for setting up the development environment: |
# If you don't have one yet, generate a SSH RSA key pair: do ''ssh-keygen -t rsa'' in the git shell. | # If you don't have one yet, generate a SSH RSA key pair: do ''ssh-keygen -t rsa'' in the git shell. | ||
# Register your public key at https://git.eclipse.org/r/#/settings/ssh-keys | # Register your public key at https://git.eclipse.org/r/#/settings/ssh-keys | ||
| − | # Make sure your | + | # 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 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]'' | #* To change the local e-mail address, do ''git config --global user.email [your email address here]'' | ||
| Line 17: | Line 17: | ||
# Check out the plug-ins you want to work on. | # Check out the plug-ins you want to work on. | ||
#* On build errors for ''org.eclipse.emf.henshin.diagram'', use the Eclipse Marketplace (in ''Help'' menu) to install the ''Graphical Modeling Framework Tooling'' feature. | #* On build errors for ''org.eclipse.emf.henshin.diagram'', use the Eclipse Marketplace (in ''Help'' menu) to install the ''Graphical Modeling Framework Tooling'' feature. | ||
| − | #* On build errors for ''org.eclipse.emf.henshin.giraph'', use the Eclipse Marketplace to install the | + | #* On build errors for ''org.eclipse.emf.henshin.giraph'', use the Eclipse Marketplace to install the ''Maven Integration for Eclipse'' feature. |
#* On build errors for ''org.eclipse.emf.henshin.cpa'', follow the [http://git.eclipse.org/c/henshin/org.eclipse.emft.henshin.git/tree/plugins/org.eclipse.emf.henshin.cpa/README-obtain_AGG_plugin.txt instructions] to reconcile the dependency to ''AGG''. | #* On build errors for ''org.eclipse.emf.henshin.cpa'', follow the [http://git.eclipse.org/c/henshin/org.eclipse.emft.henshin.git/tree/plugins/org.eclipse.emf.henshin.cpa/README-obtain_AGG_plugin.txt instructions] to reconcile the dependency to ''AGG''. | ||
Revision as of 08:22, 19 September 2016
Henshin uses Gerrit for handling code reviewing and merging. This implies specific processes when setting up the development environment and pushing changes.
Set-up
This is what you need to do for setting up the development environment:
- If you don't have one yet, generate a SSH RSA key pair: do ssh-keygen -t rsa in the git shell.
- Register your public key at https://git.eclipse.org/r/#/settings/ssh-keys
- 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.
- 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.
- In Eclipse, clone the Henshin repo from ssh://committer_id@git.eclipse.org:29418/henshin/org.eclipse.emft.henshin
- Restarting Eclipse before this step may be required.
- It is also possible to clone via https, but with a separate HTTP password.
- In the Git perspective, open the Repository: Remotes -> origin -> Gerrit Configuration... -> Finish.
- Check out the plug-ins you want to work on.
- On build errors for org.eclipse.emf.henshin.diagram, use the Eclipse Marketplace (in Help menu) to install the Graphical Modeling Framework Tooling feature.
- On build errors for org.eclipse.emf.henshin.giraph, use the Eclipse Marketplace to install the Maven Integration for Eclipse feature.
- On build errors for org.eclipse.emf.henshin.cpa, follow the instructions to reconcile the dependency to AGG.
Pushing changes
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.