Bug 498740 - [Components][doc] improve the documentation for release
Change-Id: I78c8f65ba67bf5a77ae929b7b6d5e4fa0896eb2d
Signed-off-by: Francois Le Fevre - CEA <francois.le-fevre@cea.fr>
diff --git a/components/org.eclipse.papyrus.components.parent/org.eclipse.papyrus.components.archetype/pom.xml b/components/org.eclipse.papyrus.components.parent/org.eclipse.papyrus.components.archetype/pom.xml
index 7e29a05..e386ebe 100644
--- a/components/org.eclipse.papyrus.components.parent/org.eclipse.papyrus.components.archetype/pom.xml
+++ b/components/org.eclipse.papyrus.components.parent/org.eclipse.papyrus.components.archetype/pom.xml
@@ -4,7 +4,7 @@
<parent>
<groupId>org.eclipse.papyrus.components</groupId>
<artifactId>org.eclipse.papyrus.components.parent</artifactId>
- <version>0.0.12</version>
+ <version>0.0.13-SNAPSHOT</version>
</parent>
<artifactId>org.eclipse.papyrus.components.archetype</artifactId>
<packaging>jar</packaging>
diff --git a/components/org.eclipse.papyrus.components.parent/pom.xml b/components/org.eclipse.papyrus.components.parent/pom.xml
index 8b86058..c9445fe 100644
--- a/components/org.eclipse.papyrus.components.parent/pom.xml
+++ b/components/org.eclipse.papyrus.components.parent/pom.xml
@@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.eclipse.papyrus.components</groupId>
<artifactId>org.eclipse.papyrus.components.parent</artifactId>
- <version>0.0.12</version>
+ <version>0.0.13-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Papyrus Shared Components Descriptor</name>
<description>This pom is the main parent pom for all Papyrus Components. It gather all shared configuration and properties, ensuring all components benefit from any evolution.</description>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/index.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/index.xml
index 335a3b8..acb4841 100644
--- a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/index.xml
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/index.xml
@@ -17,7 +17,7 @@
</section>
<section name="Standard Operating Procedure">
<ul>
- <li><a href="sop-upgradePom.html">SOP Upgrade pom version</a></li>
+ <li><a href="sop-release.html">SOP Release</a></li>
</ul>
</section>
</body>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/sop-release.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/sop-release.xml
new file mode 100644
index 0000000..c351b7c
--- /dev/null
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/developer/sop-release.xml
@@ -0,0 +1,42 @@
+<?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>sop-release</title>
+ </properties>
+
+ <body>
+ <section name="Context">
+ <p>How to make the release of the Papyrus Components projects?</p>
+ </section>
+ <section name="How to?">
+ <subsection name="Pre-requisite">
+ <ul>
+ <li>Create a ticket for the release [Components][release] X.Y.Z</li>
+ <li>Ensure the main hudson job are green <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components/">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components/</a></li>
+ </ul>
+ </subsection>
+ <subsection name="Actions">
+ <ul>
+ <li>Upgrade the main pom version and submodule pom version from SNAPSHOT to standard</li>
+ <li>Add some information in the src/changes/changes.xml</li>
+ <li>Push this to a gerrit, review it, merge it</li>
+ <li>Then run the release job <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-nexus/">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-nexus/</a></li>
+ <li>This should deploy the artifacts to Nexus and also tag the scm and execute the web job <a href="https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-website/">https://hudson.eclipse.org/papyrus/view/Components/job/papyrus-components-deploy-website/</a></li>
+ <li>Copy paste the staging web site into the papyrus components web site</li>
+ <li>Update the web site index.html</li>
+ <li>Rechange the pom version to a snapshot version</li>
+ <li>Push the patch and merge it</li>
+ </ul>
+ </subsection>
+ <subsection name="Post-Actions">
+ <ul>
+ <li>Inform papyrus Components that there is a new release of the project</li>
+ <li>They should test it</li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+
+</document>
\ No newline at end of file
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 83ba351..a6e8a42 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/developer/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-addMissingLicense2JavaFile.html">SOP Add Missing License to java files</a></li>
</ul>
</section>
</body>
diff --git a/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addMissingLicense2JavaFile.xml b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addMissingLicense2JavaFile.xml
new file mode 100644
index 0000000..aa9b825
--- /dev/null
+++ b/components/org.eclipse.papyrus.components.parent/src/site/xdoc/user/sop-addMissingLicense2JavaFile.xml
@@ -0,0 +1,18 @@
+<?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>sop-targetPlatformUpdate</title>
+ </properties>
+
+ <body>
+ <section name="Context">
+ <p>Sometimes your gerrit failed due to missing license header files. This has been detected thanks to the com.mycila.license-maven-plugin plugin</p>
+ </section>
+ <section name="How to add license in batch mode?">
+ <source>mvn license:format -Dlicense.header=/home/flefevre/gitNeon/org.eclipse.papyrus.tools/components/org.eclipse.papyrus.components.parent/src/etc/epl.header.cea.txt</source>
+ </section>
+ </body>
+
+</document>
\ No newline at end of file
