Jump to: navigation, search

GettingStarted:Project Main


Getting started in OpenDaylight can be a bit intimidating, but most of the infrastructure vanishes into the background pretty quickly as you get things set up and used to the workflow.

New Project Checklist

Here are the tasks you're going to want to do

  1. Make sure you have a git repository (visible in gerrit)
    1. Go to https://git.opendaylight.org/
    2. Click "Projects" on the left under the OpenDaylight logo
    3. Click "List" under projects
    4. Verify your project is listed with the right repo name
  2. Make sure your Jenkins jobs are created
    1. Go to https://jenkins.opendaylight.org/releng/
    2. Look for a tab at the top for your project and click on it
    3. Make sure you have at least <repo-name>-verify-master, <repo-name>-merge-master, and <repo-name>-daily-master jobs
    4. If the jobs do not exist follow the instructions from the releng/builder Jenkins documentation to configure your jobs. RelEng/Builder Jenkins page
  3. Verify that your jenkins jobs work
    • Test verify by pushing a patch and seeing that the verify job runs and successfully posts a "verified +1" to the gerrit.
    • Then merge the patch and make sure that the merge job runs successfully and pushes artifacts in Nexus.
    • Optionally, test your integration jobs by manually triggering them.
  4. Make sure you have a bugzilla entry for your project
    1. Go to https://bugs.opendaylight.org/
    2. Click "File a Bug"
    3. Make sure your project appears in the list
  5. Make sure you have a mailing list, usually just <repo-name>-dev
    1. Go to https://lists.opendaylight.org/
    2. Make sure there is a list named <repo-name>-dev
    3. Subscribe to the list with an e-mail you actually check
  6. Make a main wiki page using the Project Facts template
    1. The normal title for this page is <Project Name>:Main, e.g., BGP LS PCEP:Main
    2. You should use the Project Facts Template. Again a good example is BGP LS PCEP:Main
  7. Make sure you're subscribed to:
    • Your mailing list (described above) so you get mail about your project
    • Your gerrit so you can tell when people push patches to your project (see Communication:Gerrit for how to subscribe to events from your project)
    • At least one representative from your project should either (i) attend the TSC calls, (ii) subscribe to the TSC mailing list, or (iii) read the TSC meeting minutes.
      • Ideally, a project representative should do all three.
    • The Jenkins mailing list, filtered for the topic equal to your project name. Test failures will be reported to this list.
  8. Set up your pom file structure according to project layout best practice
    • A good way to do this to use the Project Startup Archetype, but replace the example module and hello world RPC with the beginnings of your own project
    • Your project should have a parent pom file that should be the root of your 'pom tree'
    • It's parent should be the odlparent pom file
    • All version numbers should be put into one of these two pom files, not hard-coded in other pom files
    • Default Version numbers from the "Startup Project Archetype" are not up to date. So, please update the version numbers in all the files generated.
    • Certain pom files should use special parent poms, e.g., the karaf-parent in controller to build Karaf distributions. Other useful parent pom files to know about are:
  9. Set up your JaCoCo code coverage reporting

Taking Advantage of Project Infrastructure

There is a detailed overview of the Development Infrastructure that will give you a good conceptual framework. Most of what is written here is about concrete getting things done stuff :)

Jacoco plugin Setup

Please follow these simple steps to report unit and integration test code coverage to Sonar