docs/release-process/milestone-readouts/m1_template.rst

   1 ============
   2 Project Name
   3 ============
   4
   5 1. Project PTL:
   6
   7    - name
   8    - email
   9    - IRC handle
  10    - I have reviewed the PTL Requirements [1]_
  11
  12 2. Project Contact:
  13
  14    - name
  15    - email
  16    - IRC handle
  17
  18 3. Test Contact:
  19
  20    - name
  21    - email
  22    - IRC handle
  23
  24 4. Documentation Contact
  25
  26    - name
  27    - email
  28    - IRC handle
  29
  30 5. Does your project have any updates on any previously-incomplete items from
  31    prior milestone readouts? (Yes/No)
  32
  33    - (If yes, list updates)
  34
  35 6. Were project-specific deliverables planned for this milestone delivered
  36    successfully? (No Deliverables/Yes/No)
  37
  38    - (If no, list incomplete deliverables)
  39
  40 7. Does your project have any special needs in CI Infrastructure [2]_? (Yes/No)
  41
  42    - (If yes, link to helpdesk ticket number)
  43
  44 8. Is your project release plan finalized?  (Yes/No)
  45
  46    - (If yes, link to final release plan wiki page)
  47    - (If no, ETA to finalize release plan)
  48
  49 9. Do you have all APIs intended to be externally consumable listed? (Yes/No)
  50
  51    - Does each API have a useful short name? (Yes/No)
  52    - Are the Java interface and/or YANG files listed for each API? (Yes/No)
  53    - Are they labeled as tentative, provisional, or stable as appropriate for
  54      each API? (Yes/No)
  55    - Do you call out the OSGi bundles and/or Karaf features providing the API
  56      for each API? (Yes/No)
  57
  58 10. Have all project dependencies requests on other projects' release plans
  59     been acknowledged and documented by upstream projects?  (Yes/No)
  60
  61     - (List of all project dependencies and if they have been acknowledged, unacknowledged)
  62
  63 11. Will your project have top-level features not requiring system test?
  64     (Yes/No)
  65
  66     - (If yes, link to system test waiver request email)
  67
  68 12. Will your project use the OpenDaylight CI infrastructure for testing
  69     top-level features requiring system test? (Yes/No)
  70
  71     - (If no, link to system test plan explaining why [3]_)
  72     - (If no, link to system test plan identifying external lab testing [4]_)
  73
  74 **FOR NEW PROJECTS ONLY**
  75
  76 A. Project Main Page: (wiki link)
  77
  78    - Use Project Facts Template [5]_
  79
  80 B. Have you completed the project checklist [6]_? (Yes/No)
  81
  82    - (link to a merged patch in gerrit)
  83    - (link to a mail from your mailing list)
  84    - (link to a bug for your project; you can create a dummy one and close it if need be)
  85    - (link to an artifact published from your project in nexus)
  86    - (link to a sonar report)
  87    - (link to your root pom file)
  88
  89 .. [1] Be sure to read the responsibilities of being a project lead under
  90        Leadership & Communication in the Requirements for Participation section
  91        of the release plan:
  92        https://wiki.opendaylight.org/view/Simultaneous_Release:Oxygen_Release_Plan#Requirements_for_Participation
  93 .. [2] Special needs include tools or configuration.  Note that generally, the
  94        only available tools in CI are basic RHEL/CentOS linux images with Java.
  95        You should note and ask for anything beyond that here.  Email
  96        helpdesk@opendaylight.org
  97 .. [3] It is recommended to use the OpenDaylight CI infrastructure unless there
  98        is some HW or SW resource that cannot be installed there.  Update the
  99        test plan with explanation on why your top-level features will not be
 100        using the OpenDaylight CI Infrastructure:
 101        https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Feature_Integration_System_Test_Template#Test_Infrastructure
 102 .. [4] Projects running system test in external Labs are required to report
 103        system test results in a timely fashion after release creations, e.g.,
 104        weekly, RC, and formal releases.  Update the test plan with plans on
 105        testing in external lab:
 106        https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Feature_Integration_System_Test_Template#Test_Infrastructure
 107 .. [5] https://wiki.opendaylight.org/view/Template:Project_Facts
 108 .. [6] https://wiki.opendaylight.org/view/GettingStarted:Project_Main#New_Project_Checklist