View source for Platform-releng/Publish To Maven Central

{{tip|This page summarizes the result of {{Bug|484004}}}}

=Preparing a Repository=
Unless stated otherwise the following steps are implemented using bash scripts.
;Sources:During development the sources are hosted in http://git.eclipse.org/c/objectteams/org.eclipse.objectteams.git/tree/releng/EnrichPoms/
:* script: [http://git.eclipse.org/c/objectteams/org.eclipse.objectteams.git/tree/releng/EnrichPoms/CBIaggregator.sh CBIaggregator.sh]
:* aggregation model: [http://git.eclipse.org/c/objectteams/org.eclipse.objectteams.git/tree/releng/EnrichPoms/SDK4Mvn.aggr SDK4Mvn.aggr]
;Build Job:This script drives the hudson job https://hudson.eclipse.org/releng/view/Publish%20to%20Maven%20Central/job/CBIaggregator

==Preparing the tools==
* unpack Eclipse SDK for use as director application (''can we use a smaller installation?'')
* install the cbiAggregator

==Run the aggregator==
* the aggregation model basically pulls ''everything'' from a given release repo
* configure for all operating systems
* specifies these properties: packedStrategy="UNPACK_AS_SIBLING" mavenResult="true" versionFormat="MavenRelease"
* define maven mappings to map all 3rd party artifacts to their original GAV, as of SDK Neon.2 these are:
** com/jcraft/jsch/0.1.53
** com/ibm/icu/icu4j/56.1.0
** commons-jxpath/commons-jxpath/1.3.0
** javax/inject/javax.inject/1.0.0
** junit/junit/4.12.0
** org/apache/xmlgraphics/batik-css/1.7.0
** org/apache/lucene/lucene-analyzers/3.5.0
** org/apache/lucene/lucene-core/3.5.0
** org/apache/felix/org.apache.felix.gogo.runtime/0.10.0
** org/apache/felix/org.apache.felix.gogo.shell/0.10.0
** org/apache/ant/ant/1.9.6
** org/tukaani/xz/1.3.0
** org/ow2/sat4j/org.ow2.sat4j.core/2.3.5
** org/ow2/sat4j/org.ow2.sat4j.pb/2.3.5
** org/ow2/asm/asm-tree/5.0.1
** org/ow2/asm/asm/5.0.1
{{important|TODO|check the above list against [http://git.eclipse.org/c/platform/eclipse.platform.releng.aggregator.git/tree/eclipse.platform.releng.prereqs.sdk/eclipse-sdk-prereqs.target eclipse-sdk-prereqs.target]}}

==Remove undesired content ==
* p2-only content: p2.index p2.packed content.jar artifacts.jar
* -sources artifacts, misplaced due to quirk from https://bugs.eclipse.org/508910
* all features (irrelevant in plain maven use): <code>*feature.group</code> and <code>*feature.jar</code>
* test plug-ins: <code>org/eclipse/*/*test*</code>
* <code>tooling*</code> (''what is this?'')
* directories containing a pom but no corresponding jar file
* "garbage", i.e., 3rd party artifacts that after previous clean-up are no longer referenced from any org/eclipse/{platform,jdt,pde} pom files
* directories that are empty after previous clean-up

Technically, some of the clean-up is not necessary, but it helps to give a good picture of what will be published.

=Enrich POMs=
''This step is implemented as a small Java tool''.
;Sources:During development the sources are hosted in http://git.eclipse.org/c/objectteams/org.eclipse.objectteams.git/tree/releng/EnrichPoms/
;Build Job:The tool is built via hudson job https://hudson.eclipse.org/releng/view/Publish%20to%20Maven%20Central/job/pomEnricher


Add some required information to the generated poms:
* dynamic content (retrieved mostly from MANIFEST.MF):
** name (''typically matches what the aggregator filled in as description'')
** url
** scm connection, tag and url
* semi dynamic content
** developers (''start from the git url, and match it against known project names to link to the corresponding "Who's Involved" page of PMI'')
* static content
** copyright
** license
** organization
** issue management
* hard wired corrections
** scm connection for emf & ecf
** fix name of <code>org.eclipse.core.resources.win32.x86*</code> fragments
* fix checksums (md5 & sha1 after pom update -- ''not needed for publishing'')

=Add Javadoc stubs=
Use a heuristic mapping from bundle name to name of the doc bundle holding corresponding javadoc, one of:
* org.eclipse.jdt.doc.isv
* org.eclipse.pde.doc.user
* org.eclipse.platform.doc.isv

Then
* create a README.txt referring to the doc bundle
* jar the README.txt
* copy the jar to the locations so that it will be picked up by maven

=Create missing sources artifacts=
Workaround for sources artifacts missing for 8 artifacts.
* org.eclipse.core.net.win32.x86_64
* org.eclipse.core.net.win32.x86
* org.eclipse.core.net.linux.x86_64
* org.eclipse.core.net.linux.x86
* org.eclipse.swt.tools
* org.eclipse.releng.tools
* org.eclipse.update.core
* org.eclipse.osgi.compatibility.plugins

Create sources jars:
* check out sources from git
* respect content of build.properties
* manually jar it up and put it into the location expected by maven

=Sign and Upload to OSSRH=
;hudson jobs:
:* https://hudson.eclipse.org/releng/view/Publish%20to%20Maven%20Central/job/PublishPlatformToMaven.Neon
:* https://hudson.eclipse.org/releng/view/Publish%20to%20Maven%20Central/job/PublishJDTtoMaven.Neon
:* https://hudson.eclipse.org/releng/view/Publish%20to%20Maven%20Central/job/PublishPDEToMaven.Neon/

Steps:
* copy relevant section of prepared repo into current hudson workspace
* for each <code>*.pom</code>, <code>*.jar</code>, <code>*-sources.jar</code> and <code>*-javadoc.jar</code>
** invoke maven (cli)
*** pass settings configured for GPG signing and OSSRH account (<code>-s</code>).
*** use a generic pom (<code>-f</code>) (configure <code>maven-gpg-plugin</code> and <code>nexus-staging-maven-plugin</code> (''is the latter needed here?''))
**: see https://bugs.eclipse.org/484004#c70
*** call goal <code>gpg:sign-and-deploy-file</code>
*** passing these properties (<code>-D</code>): <code>url, repositoryId, file, pomFile, classifier</code>

<u>Caveat:</u>

If <code>gpg:sign-and-deploy-file</code> doesn't work for some reason, it's tempting to try manual upload of artifacts instead. This, however, doesn't seem to scale, i.e., it's OK for one artifact, but not for a significant number of artifacts. See how I struggled : [https://issues.sonatype.org/browse/OSSRH-27091?focusedCommentId=389077&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-389077 OSSRH-27091 comment 389077] (look for item (2)).

=Validate and Release=
* Login to OSSRH nexus (personal account must have been assigned permissions for the targeted staging area, simply request this in the Jira ticket).
* Identify and select the staging repository created by the previous step (name is ''group-without-dots-dash-number'', where number starts at 1000, e.g., <code>orgeclipseplatform-1005</code>)
* Click '''close''', and wait for validation results to appear under "Activity"
* On success click '''release''', otherwise click '''drop''', fix errors and try again

[[Category:Eclipse_Platform_Releng| ]]