Bug 499345 - [Components][doc] improving doc Change-Id: If10ef2e0e0de4b9e1a017ee843b089518c848bcf Signed-off-by: Francois Le Fevre - CEA <francois.le-fevre@cea.fr>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/pdf/user-guide.pdf.xml b/components/org.eclipse.papyrus.components.parent/src/site/pdf/user-guide.pdf.xml index 35883ed..e133077 100644 --- a/components/org.eclipse.papyrus.components.parent/src/site/pdf/user-guide.pdf.xml +++ b/components/org.eclipse.papyrus.components.parent/src/site/pdf/user-guide.pdf.xml
@@ -12,6 +12,7 @@ <item name="Introduction" ref="index.html"/> <item name="User" ref="user/index.html"/> <item name="SOP Project Component Creation" ref="org.eclipse.papyrus.components.archetype/developer/sop-projectcreation.html"/> + <item name="SOP Component Release" ref="user/sop-release.html"/> <item name="SOP Add Missing License" ref="user/sop-addMissingLicense2JavaFile.html"/> <item name="SOP Target Platform Creation" ref="user/sop-targetPlatformUpdate.html"/> </toc>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/index.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/index.xml index de89ac9..997e1d2 100644 --- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/index.xml +++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/index.xml
@@ -19,6 +19,7 @@ <ul> <li><a href="../org.eclipse.papyrus.components.archetype/user/sop-projectcreation.html">SOP Project Component Creation</a></li> <li><a href="sop-targetPlatformUpdate.html">SOP Target Platform Update</a></li> + <li><a href="sop-release.html">SOP Release of a component</a></li> <li><a href="sop-addMissingLicense2JavaFile.html">SOP Add Missing License to java files</a></li> </ul> </section>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml new file mode 100644 index 0000000..d20f949 --- /dev/null +++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-release.xml
@@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> + + <properties> + <title>Components - Release Standard Operating Procedure</title> + </properties> + + <body> + <section name="sop-release"> + <subsection name="Who is in charge of?"> + <p>Commiter + a basic developer in order to transfer knowledge and improve the process.</p> + </subsection> + <subsection name="When?"> + <p>when you need it, on a regular basis, every two month.</p> + </subsection> + <subsection name="How long?"> + <p>It last at least 120mn</p> + </subsection> + + </section> + <section name="Prerequisite"> + <subsection name="Access"> + <p> + Have the Hudson access to the Component tab and a committer with you to make the review and merge. + </p> + </subsection> + <subsection name="Green"> + <p>No critical bugs open for the release you are targeting.</p> + <p>Jobs (master,website,quality,deploy) are green</p> + </subsection> + <subsection name="Version"> + <p>Initial version of your pom.xml, MANIFEST.MF and category.xml should match qualifier and -SNAPSHOT</p> + </subsection> + <subsection name="Change log"> + <p>You must fill the changelog to describe the new version feature.</p> + <source>/org.eclipse.papyrus-sysml/src/changes/changes.xml</source> + <p>Details <a href="https://maven.apache.org/plugins/maven-changes-plugin/changes.html">https://maven.apache.org/plugins/maven-changes-plugin/changes.html</a></p> + </subsection> + </section> + <section name="Pre-Actions"> + <p>You can send an email to the developers mailing list. + </p> + </section> + <section name="Steps"> + <subsection name="Create a bugzilla ticket."> + <p>Bug XXXXXX - [YourComponent][release][YourTargetVersion] Release</p> + </subsection> + <subsection name="Upgrade the version of application"> + <p>use tycho-versions plugin to switch from qualifier to release, and then back from release to qualifier</p> + <source>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=X.Y.Z-SNAPSHOT</source> + <p>check the different pom.xml and MANIFEST.MF</p> + <p>You have to manually update the category.xml at /org.eclipse.papyrus-sysml/releng/org.eclipse.papyrus.sysml14.p2/category.xml</p> + <p>Push on gerrit the different modifications</p> + <p>Check the status of the gerrit job</p> + <p>Add a reviewer</p> + <p>Review and merge the change</p> + </subsection> + <subsection name="Rexecute the job Master and eventually job Website"> + <p>Who: any</p> + <p>Goal is to use this job version as data for the promotion.</p> + </subsection> + <subsection name="Make the release"> + <p>Who: commiter action</p> + <p>Go the hudson Component tab</p> + <p>Execute the job papyrus-component-deploy-eclipse</p> + <p>Fill the args</p> + <p>It should tag the release automatically, you copuld check it by looking at the git repository</p> + <p>It should also automatically execute the job papyrus-component-deploy-nexus: to deploy the artifact into the Eclipse Papyrus official Nexus</p> + <p>It should also automatically execute the job and papyrus-component-deploy-website</p> + </subsection> + <subsection name="Deploy the web site"> + <p>Who: uncommiter action + commiter review</p> + <p>The new web site is available under the target/site-staging directory</p> + <p>Download it as a zip</p> + <p>Unzip it in the papyrus web git repository, under the papyrus/components/YourComponent directort</p> + <p>Update the root index.html with the new version of your component</p> + <source>https://git.eclipse.org/c/www.eclipse.org/papyrus-sysml.git/</source> + <p>Ask for validation for the review.</p> + <p>Once it is merged, you should see it 3mn here http://www.eclipse.org/papyrus/components/MyComponent/YourTargetVersion/</p> + </subsection> + <subsection name="Upgrade to the next snapshot version of the application"> + <p>use tycho-versions plugin</p> + <source>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=X.Y.Z-SNAPSHOT</source> + <p>You have to manually update the category.xml at /org.eclipse.papyrus-sysml/releng/org.eclipse.papyrus.sysml14.p2/category.xml</p> + <p>check the different pom.xml and MANIFEST.MF</p> + <p>Push it as new patch and make the review.</p> + </subsection> + </section> + <section name="Post-Actions"> + <p>You can send an email to the developers mailing list</p> + </section> + + </body> + +</document> \ No newline at end of file