Skip to content

Contribute

Roberto Lo Giacco edited this page Jun 4, 2020 · 8 revisions

Contribute

Setup

First of all you need to get Xtext, either as a product bundle or by installing the features from the updates site. Than you obviously need the Natural source repository contents which are separated into two branches: the master contains the source code, needed for development, while the gh-pages one contains the update site and is needed only to create a new release.

Building the plugins

Once you have cloned the repository and imported the projects in Xtext you will get some errors and warnings: that's because you still need to generate some code through Xtext. Inside the projects org.agileware.natural.cucumber and org.agileware.natural.jbehave, inside the src folder and under the main package you can find a .mwe2 file: right click on each of them and Run As > MWE2 Workflow.

The very first time you do this step it will ask for confirmation to download the ANTLR3 parser generator, so confirm and watch the build process complete. If you still have errors just refresh the projects.

Testing the plugins

You need to create an Eclipse Application Run Configuration from Run > Run Configurations... > Eclipse Application, select the plugins and the adding the required dependencies by clicking on the Add Required Plug-ins button

Publishing new version

Private distribution

Just right click on the feature project and select Export... > Plug-in Development > Deployable features, then follow the wizard.

Official release

You need to clone the gh-pages branch and use it as an Eclipse Update Site project. Once you have rebuilt the plugin and when you want to publish a new version you need to:

  1. open the site.xml file and add the features to the Natural category: they will appear with a qualifier postfix
  2. have the IDE resolve the qualifier with the current build by selecting the added features and the the Synchronize... button
  3. save the site.xml file
  4. right-click on the site.xml file and select Plugin Tools... > Rebuild Site
  5. commit and push the changes to the gh-pages branch
Clone this wiki locally