Difference between revisions of "Modeling Project Releng/Component Creation"

From Eclipsepedia

Jump to: navigation, search
(Proposal)
m (Proposal)
Line 24: Line 24:
 
:* Wait one week
 
:* Wait one week
 
* [<b style="color:green">COMP</b>] post announcement to PMC mailing list after successful conclusion of committer vote.
 
* [<b style="color:green">COMP</b>] post announcement to PMC mailing list after successful conclusion of committer vote.
* [<b style="color:green">COMP</b>] formalize proposal document in wiki; link from [[EMFT#Proposed_Components |Proposed Components]] page.
+
* [<b style="color:green">COMP</b>] formalize proposal document in wiki; link from [[EMFT#Proposed_Components |Proposed Components]] page. [[EMF4Net_Proposal | Example]]
 
* [<b style="color:green">COMP</b>] send note to EMO for planetwide announcement, including short paragraph describing component and link to proposal doc in wiki.
 
* [<b style="color:green">COMP</b>] send note to EMO for planetwide announcement, including short paragraph describing component and link to proposal doc in wiki.
  

Revision as of 16:58, 3 January 2008

This is a process workflow for creating a new EMFT component.

In this example, the new EMFT component is EMF JCR Management, or org.eclipse.emf.jcrm. See also bugs 182379 and 182380.

Contents

Legend

Names in square brackets are assignees. If more than one assignee is listed, the first listed is the principal w/ other(s) as backup.

  • WM = Webmaster(s)
  • PMC = Project Management Chair
  • REL = Release Engineer
  • COMP = Component Owner

Workflow

Proposal

(The proposal submission process is subject to change. If you see anything glaringly wrong here, please correct it.)
  • [COMP] contact PMC via or mailing list to pitch component idea. Should have a first draft of the proposal doc (.doc, .ppt, .pdf, or ideally, in wiki format) and maybe some sample code at this point
  • [COMP] with PMC approval, post announcement to relevant newsgroup(s) to gather community/peer feedback.
  • Wait two weeks
  • [COMP] post announcement to project's developer mailing list to gather approval votes from existing project committers.
  • Wait one week
  • [COMP] post announcement to PMC mailing list after successful conclusion of committer vote.
  • [COMP] formalize proposal document in wiki; link from Proposed Components page. Example
  • [COMP] send note to EMO for planetwide announcement, including short paragraph describing component and link to proposal doc in wiki.

Committer Legal Setup


Commiter Account Setup

  • [WM] create dev.eclipse.org userid for COMP; user requires a full shell, not a restricted one
  • [WM] add COMP to groups emf-jcrm, emf-jcrm-releng
  • [WM] add COMP to groups emftadmin (download.eclipse) & modeling-home (www.eclipse)
  • [WM] add REL to group emf-jcrm-releng


Component Setup

  • [COMP] provide component description text to PMC & REL for website intro/detail & Bugzilla component description
  • [COMP] provide introductory wiki page, linked from EMFT page

Bugzilla Setup

  • [COMP] register with Bugzilla to create an account
  • [REL] add new component, with COMP as default assignee


CVS Setup

  • [WM] change group id on /cvsroot/modeling/org.eclipse.emf/org.eclipse.emf.jcrm/ to emf-jcrm
  • [WM] change group id on /cvsroot/modeling/org.eclipse.emf/org.eclipse.emf.jcrm.releng/ to emf-jcrm-releng


Code Contribution

  • [COMP] commit code into /cvsroot/modeling/org.eclipse.emf/org.eclipse.emf.jcrm/ (details here). Recommend setting plugins to version 0.7.0 if based on EMF 2.2 or 0.8.0 if based on EMF 2.3; or, if code is really new, could start with 0.5.0.
  • [COMP] Third party code must be submitted to IPzilla for legal clearance before being committed to CVS. Note also that many 3rd party libraries are available via the Orbit project, and so can be added to the project at build time (rather than needing to be duplicated in CVS).

Release Engineering

  • [COMP] contact REL via IM (eg., User:nickb) to begin releng coordination
  • [COMP] provide component compilation requirements to REL: upstream dependencies (eg., EMF, UML2, OCL...), 3rd party libraries (from Orbit or other), JDK version (1.4 or 5.0), plugin version (eg., usually 0.7.0 to start). See also Build UI.
  • [COMP] set up SSH keys for connecting passwordlessly from emft.eclipse.org to download1.eclipse.org and dev.eclipse.org
  • [COMP] publish first JCRM build to download1.eclipse.org
  • [COMP] update website to reflect project has first successful build. See Site Navigation.
  • [REL] update Search CVS (incl. relupdate.php) to ensure component is being logged (release notes, build news)