SWTBot/Contributing

Download and start Oomph.
On the initial page, click on the Switch to advanced mode button in the top right.
On the Product page, select Eclipse IDE for Eclipse Committers.
On the Projects page, double-click SWTBot
Choose your preferred installation settings on the Variables page:
1. If you plan to contribute patches using Gerrit (section about Gerrit), check "Show all variables" and make sure you select ("SSH (read-write Gerrit)") in the Git or Gerrit repository; the git URI will then look like
```
ssh://${git.user.id|username}@git.eclipse.org:29418/swtbot/org.eclipse.swtbot
```
2. Then specify your Bugzilla/Jenkins password and Git/Gerrit user ID (you can also specify the password and check that your credential are correct using the "Authenticate..." button). An example is shown in the following screenshot.
Press next and finish.

This will first create an Eclipse installation with all the needed plug-ins for developing SWTBot (including the Recommended Eclipse plugins), and then will start the new installed Eclipse (press Finish to close the first installation dialog). The new installed Eclipse will automatically setup the workspace and you will have to wait for this procedure to end (you can click on the animated arrow icon on the status bar to show the progress). This workspace setup procedure includes:

cloning the SWTBot git repository (you'll be asked for a password if you selected the read-write git URI)
setup the target platform
setup the API baseline
setup Mylyn queries for SWTBot Bugzilla bugs and SWTBot Gerrit reviews
setup the Mylyn Jenkins build view
setup the working sets

Once this procedure ends, your workspace will be built and you are ready to develop.

The installed Eclipse can be found in the "Installation folder name" selected in the "Variables" dialog, under the subdirectory "eclipse".

Getting the source (old manual way)

You can use a git mirror of that repository:

git clone git://git.eclipse.org/gitroot/swtbot/org.eclipse.swtbot.git

You can also browse the repository using a web interface or even by monitoring the mirror of the repository on GitHub.

To contribute changes to the website, use this git repo: https://git.eclipse.org/c/www.eclipse.org/swtbot.git

IDE tips

Recommended Eclipse plugins

It's advised that you use the following plugins in Eclipse:

EGit
FindBugs (with a high "Minimum rank to report" set in Window > Preferences > Java > Findbugs)
Configure JDT in "pedantic" mode: from Window > Preferences > Java > Compiler > Errors/Warning make all violations send a warning, ignore nothing.
EclEmma is useful to analyze Coverage Reports
... Any other tool that makes you write better code faster ...

Target Platforms

You can find some ready-to-use target platforms for development in the devtools/target-platforms folder. Each target-platform basically target a version of the Eclipse release train. It's recommended to use one of these target-platform since it contains all SWTBot dependencie. These target-platforms are also used at build time, so your dependencies in IDE will be consistent with dependencies during build. Enable the selected target-platform by opening it in IDE with the target definition editor, and click Set As Target Platform.

In case something is not working well, please report them as a bug.

API Baseline

To track API changes, it is advised to use the API tool. To set up the API baseline, follow these steps:

Select "Window -> Preferences". In the window that opens, select "Plug-in Development -> API Baselines" on the left pane.
Click on "Add Baseline..."
Choose "A target platform" and click Next.
In the next page check the box next to the target which contains "baseline" in its name, like "swtbot-baseline".
Click "Reset" to download the contents of the target.
Specify a name for this baseline in the top area, like "SWTBot API" for example.
Click "Finish", then "OK" in the previous dialog.

It should offer you do to a full rebuild. You can click "Yes" at this point.

Building SWTBot

First get the sources, as explained a few lines above.
then mvn clean verify
That's all!

NOTE: default build performs against the latest available target. You can test and build against another target instead by activating its profile, e.g.: mvn clean verify -P photon.

Continuous integration

Continuous integrations jobs for SWTBot are available here https://ci.eclipse.org/swtbot . Here is a quick description of available jobs:

swtbot-tycho is the main CI job. It builds and run tests against an Eclipse Indigo platform and publishes output p2 repository to http://download.eclipse.org/technology/swtbot/snapshots
swtbot-on-* compiles and runs tests against a specific Eclipse branch. It guarantees compatibility with a wide range of Eclipse versions
swtbot-gerrit compiles and runs tests against any Gerrit contribution, and then add a vote to the contribution: +1 if everything is fine, -1 in case of a compile error, build error, or failed test
swtbot-sonar runs (weekly) build and tests against last commit of master branch and generates Sonar reports. See #Sonar

Sonar

Sonar is used in order to track Code Quality:

https://dev.eclipse.org/sonar/dashboard/index/1
contains results of dedicated build https://ci.eclipse.org/swtbot/job/swtbot-sonar/

Submit a contribution

Generalities

Patches and contributions are always welcome! There are many general articles about contributing to Eclipse projects:

Report a bug or suggest an enhancement

Just create a ticket here: https://bugs.eclipse.org/bugs/enter_bug.cgi?product=SWTBot

Contributions list

Unresolved Bugzilla tickets: https://bugs.eclipse.org/bugs/buglist.cgi?list_id=2369532;classification=Technology;query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;product=SWTBot
Open Gerrit reviews: https://git.eclipse.org/r/#/q/status:open+project:swtbot/org.eclipse.swtbot,n,z

Be notified

To receive notifications from Gerrit, go to https://git.eclipse.org/r/#/settings/projects , add project swtbot/org.eclipse.swtbot.git and tick all checkboxes for this project to receive notifications.
To receive notifications from Bugzilla, go to https://bugs.eclipse.org/bugs/userprefs.cgi?tab=email , and add in User watching the following mail: swtbot-inbox@eclipse.org.

Provide a contribution using Gerrit

First, make sure you have agreed and signed the Eclipse Contribution CLA.
Then find out the repository URL. It should be something like 'ssh://username@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git'. In case you're unsure of the Gerrt repo URL, you can find it at https://git.eclipse.org/r/#/admin/projects/swtbot/org.eclipse.swtbot , once you're logged in.
Then, read carefully this documents: Gerrit to set up commit hooks, learn about Change-Ids and other things.

We recommand using the EGit-Gerrit connector. Make sure that the options Add Signed-off by and Compute Change-Id for Gerrit Code-Review are selected in the commit dialog. After the push, the next dialog should show you the log message, which includes the Gerrit review URL.

In case you work without EGit Gerrit connector:

Make your change locally, and git commit them in your local repo. Commit message must contain Bug Number.
When you're ready, git push your change to Gerrit using the following command: git push ssh://username@git.eclipse.org:29418/swtbot/org.eclipse.swtbot.git HEAD:refs/for/master or

$ git remote add gerrit 
$ git push gerrit HEAD:refs/for/master

After the push, log tells you about a URL which tracks the

In any case

Share the URL of the review on the bug you're working on.

If you want to push an improved version of the patch, just amend your commit, make sure it has the same Change-Id as the original one, and push it again to refs/for/master. This will create another version of your patch, on the same Gerrit review.

Committers

Committer must subscribe to notifications to not miss a contribution. See how to set up nofications
Committer have to use Gerrit too and follow same process as contributors. They can approve their own contributions, but asking review from another contributor is a cool thing.
A Gerrit contribution is automatically merged when all "acceptance flags" (Verification, review, IP) are OK.

Contribute changes to website

Website can also be edited using Git and Gerrit process mentioned about for sources:

Gerrit repo is https://git.eclipse.org/r/p/www.eclipse.org/swtbot.git

Release process

Make sure upcoming release is listed in http://projects.eclipse.org/projects/technology.swtbot/releases. Click the 'Create a new release...' link and fill the requested information. To edit the release details, select it in the table and click the 'Edit' tab on the following page.
Announce wish to release on swtbot-dev mailing-list, and wait for approval of committers.
When participating in a new simultaneous release, state your intent by sending a message to the cross-project-issues-dev mailing list by M1, or by touching the swtbot.aggrcon file by M2.
To create a Milestone or Release Candidate build for a simultaneous release, on Jenkins run the swtbot-tycho job to create a snapshot then run the swtbot-milestone job to copy the snapshot to the milestones download area. Then update the simultaneous release aggregator file (swtbot.aggrcon) to point to the milestone folder via a Gerrit change on the correct target branch (example).
Generate an IPLog from the project page in the Committer Tools side menu
A bug may be created by the EMO to track the release. When PMC approval is required, send a message to the technology-pmc mailing list (example).
Schedule a release review. From the release record page, click the 'Schedule a review for this release' link that appears at the top.
Send an email to emo@eclipse.org stating your intent to release.
Wait for the release review to be approved.
Run all builds on Jenkins (swtbot-tycho, swtbot-sonar).
Keep the build and tag it with the version of the release using Jenkins UI. In the Job Dashboard for swtbot-tycho, select the build and click 'Keep this build forever', then in the 'Edit Build Information' page change 'DisplayName' to e.g. '2.1.1 release'.
Tag source in git repository. From the History view, select the commit and click 'Create Tag...'. Set the tag name to the release version, e.g. '2.1.1', and the message to 'SWTBot 2.1.1 release'. Then from Git Repositories view, select the org.eclipse.swtbot repository and click 'Remote > Push Tags...', select the new tag and finish the wizard.
Run the swtbot-release job to copy the build to the releases download area.
From http://portal.eclipse.org, update Bugzilla in the Committer Tools to add the released version as a "version" and the next version as a "milestone".
Update wiki pages SWTBot#Update Sites and SWTBot/Releases.
If necessary, update SWTBot marketplace entry. Since it's referencing the releases/latest URL, no change should be required.
Announce release on swtbot-dev mailing-list and SWTBot forum (example).
Update the simultaneous release aggregator file (swtbot.aggrcon) to point to the new release folder via a Gerrit change on the correct target branch (example).
Change all pom.xml, MANIFEST.MF and feature.xml to use the version of next release, git commit and push.

Categories:

Retrieved from "https://wiki.eclipse.org/index.php?title=SWTBot/Contributing&oldid=443300"

Breadcrumbs

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Contents

Setting up the workspace with Oomph (NEW)