Skip to content
[Jenkins]Jenkins
log in

Configure

General

Description
Repackages the EMF artifacts of an existing release as Maven artifacts and optionally publishes them to Maven Central.

<p>
This job uses the CBI aggregator to materialize the p2 artifacts to deploy into a Maven-style repository.
For publishing to OSSRH, some information is missing:
</p>
<ol>
  <li>The POM files are missing some required information.</li>
  <li>The required Javadoc jars need to be generated.</li>
</ol>

<p>
  To complete the POM files, a small utility, <em>pommod</em>, is contained in the releng project in form of a Maven Java project. 
This tool is first built via Maven and is later used to modify the POM files.
</p>

<p>
The missing Javadocs are also automatically produced from the p2 source bundles by this job. 
</p>

<p>
After these preparations for publishing are done:
</p>
<ol>
  <li>The POM files will have been enriched with the required information by the <em>pommod</em> utility.</li>
  <li>The jars including, sources and javadocs, will have been added to the local Maven repository</li>
</ol>

<p>
  Finally, the shell script optionally deploys the jars, their sources, and their javadocs 
  to OSSRH into a <a href="https://oss.sonatype.org/#stagingRepositories">staging repository</a>.
  After uploading, the new staging repository must be closed and then released.
</p>
Inheritance Strategy
This item will inherit its parent item's permissions (in addition to any permissions granted here). If this item is at the top level in Jenkins, it will inherit the global security security settings.
User/groupCredentialsJobRunJob Config HistoryPromotionSCM
CreateDeleteManageDomainsUpdateViewBuildCancelConfigureDeleteDiscoverExtendedReadMoveReadWorkspaceDeleteReplayUpdateDeleteEntryPromoteTag
Anonymous
Authenticated Users
?
Date and Time Pattern?
N/A
?
Strategy
Days to keep builds
if not empty, build records are only kept up to this number of days
N/A
Max # of builds to keep
if not empty, only up to this number of build records are kept
3
Edited
Days to keep artifacts
if not empty, artifacts from builds older than this number of days will be deleted, but the logs, history, reports, etc for the build will be kept
N/A
Max # of builds to keep with artifacts
if not empty, only up to this number of builds have their artifacts retained
N/A
Project url?
N/A
Edited
Display name?
N/A
GitLab Connection
Credential :
Notification addresses
N/A
?
Promotion process
Name
N/A
Visible?
N/A
Icon
Label Expression?
If not set, the label of the promoted build will be used.
N/A
Criteria
?
Groovy Script
N/A
?
Additional classpath?
Classpath entry
JAR file path or URL?
N/A
Edited
Display label when condition not met
N/A
Display label when condition met
N/A
?
Approvers
N/A
Boolean Parameter ?
Choice Parameter ?
Credentials Parameter ?
File Parameter ?
Git Parameter ?
Multi-line String Parameter
Password Parameter ?
Promoted Build Parameter ?
Run Parameter ?
String Parameter ?
?
?
Parameter Name
N/A
Parameter Value
N/A
?
Job names
N/A
?
Promotion names
N/A
Promotion environment
Edited
Patterns for files to be deleted?
N/A
Apply pattern also on directories?
Check parameter?
N/A
External Deletion Command?
N/A
Disable deferred wipeout?
?
Bindings
Certificate ?
Docker client certificate
Git Username and Password
SSH User Private Key ?
Secret ZIP file ?
Secret file ?
Secret text ?
Username and password (conjoined) ?
Username and password (separated) ?
?
Managed Files
File?
Target?
N/A
Variable?
N/A
File?
Target?
N/A
Variable?
N/A
?
Server authentication token
SonarQube authentication token. Mandatory when anonymous access is disabled. Will default to the one defined in the SonarQube installation.
?
?
Credentials
N/A
N/A
?
Only post commit status of parent matrix job?
Commit Status Context?
N/A
Commit Status URL?
N/A
Commit Status Build Triggered?
N/A
Commit Status Build Started?
N/A
Add test result one liner
Commit Status Build Result?
Build Result?
Message?
N/A
?
Kubernetes server endpoint?
N/A
Certificate of certificate authority ?
N/A
Credentials
Time-out strategy ?
Time-out variable
Set a build timeout environment variable
N/A
Time-out actions?
Abort the build ?
Fail the build ?
Writing the build description ?
?
Ant Version
JDK
Actions
Execute SonarQube Scanner
Execute Windows batch command ?
Execute shell ?
Invoke Ant ?
Invoke top-level Maven targets ?
Provide Configuration files ?
Run with timeout
Set build status to "pending" on GitHub commit
SonarScanner for MSBuild - Begin Analysis ?
SonarScanner for MSBuild - End Analysis ?
Trigger/call builds on other projects
Aggregate downstream test results ?
Archive the artifacts ?
Build other projects ?
Deploy artifacts to Maven repository ?
Discover reference build
Mine SCM repository
Publish JUnit test result report ?
Publish Javadoc
Record compiler warnings and static analysis results
Record fingerprints of files to track usage ?
Git Publisher ?
Github Pull Request Merger
SonarQube analysis with Maven ?
Accept GitLab merge request on success
Add note with build status on GitLab merge requests ?
Add vote for build status on GitLab merge requests
E-mail Notification ?
Editable Email Notification ?
Keep Build Forever ?
Publish build status to GitLab ?
Set GitHub commit status (universal) ?
Set build status on GitHub commit [deprecated] ?
Trigger parameterized build on other projects ?
Delete workspace when build is done
Promotion process
Name
N/A
Visible?
N/A
Icon
Label Expression?
If not set, the label of the promoted build will be used.
N/A
Criteria
?
Groovy Script
N/A
?
Additional classpath?
Classpath entry
JAR file path or URL?
N/A
Edited
Display label when condition not met
N/A
Display label when condition met
N/A
?
Approvers
N/A
Boolean Parameter ?
Choice Parameter ?
Credentials Parameter ?
File Parameter ?
Git Parameter ?
Multi-line String Parameter
Password Parameter ?
Promoted Build Parameter ?
Run Parameter ?
String Parameter ?
?
?
Parameter Name
N/A
Parameter Value
N/A
?
Job names
N/A
?
Promotion names
N/A
Promotion environment
Edited
Patterns for files to be deleted?
N/A
Apply pattern also on directories?
Check parameter?
N/A
External Deletion Command?
N/A
Disable deferred wipeout?
?
Bindings
Certificate ?
Docker client certificate
Git Username and Password
SSH User Private Key ?
Secret ZIP file ?
Secret file ?
Secret text ?
Username and password (conjoined) ?
Username and password (separated) ?
?
Managed Files
File?
Target?
N/A
Variable?
N/A
File?
Target?
N/A
Variable?
N/A
?
Server authentication token
SonarQube authentication token. Mandatory when anonymous access is disabled. Will default to the one defined in the SonarQube installation.
?
?
Credentials
N/A
N/A
?
Only post commit status of parent matrix job?
Commit Status Context?
N/A
Commit Status URL?
N/A
Commit Status Build Triggered?
N/A
Commit Status Build Started?
N/A
Add test result one liner
Commit Status Build Result?
Build Result?
Message?
N/A
?
Kubernetes server endpoint?
N/A
Certificate of certificate authority ?
N/A
Credentials
Time-out strategy ?
Time-out variable
Set a build timeout environment variable
N/A
Time-out actions?
Abort the build ?
Fail the build ?
Writing the build description ?
?
Ant Version
JDK
Actions
Execute SonarQube Scanner
Execute Windows batch command ?
Execute shell ?
Invoke Ant ?
Invoke top-level Maven targets ?
Provide Configuration files ?
Run with timeout
Set build status to "pending" on GitHub commit
SonarScanner for MSBuild - Begin Analysis ?
SonarScanner for MSBuild - End Analysis ?
Trigger/call builds on other projects
Aggregate downstream test results ?
Archive the artifacts ?
Build other projects ?
Deploy artifacts to Maven repository ?
Discover reference build
Mine SCM repository
Publish JUnit test result report ?
Publish Javadoc
Record compiler warnings and static analysis results
Record fingerprints of files to track usage ?
Git Publisher ?
Github Pull Request Merger
SonarQube analysis with Maven ?
Accept GitLab merge request on success
Add note with build status on GitLab merge requests ?
Add vote for build status on GitLab merge requests
E-mail Notification ?
Editable Email Notification ?
Keep Build Forever ?
Publish build status to GitLab ?
Set GitHub commit status (universal) ?
Set build status on GitHub commit [deprecated] ?
Trigger parameterized build on other projects ?
Delete workspace when build is done
Rebuild options:?
Resources?
N/A
Label?
N/A
?
Groovy Script
N/A
?
Additional classpath?
Classpath entry
JAR file path or URL?
N/A
Reserved resources variable name?
N/A
Number of resources to request?
N/A
?
Choice Parameter ?
Name?
EMF_VERSION
Choices?
I_BUILD
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32
2.31
2.30
2.29
2.28
2.27
2.26
2.25
2.24
2.23
2.22
2.21
2.20
2.19
2.18
2.17
2.16
2.15
2.14
2.13
2.12
2.11
2.10
2.9
2.8
Description?
EMF release version in format <code>&lt;major&gt;.&lt;minor&gt;</code>
Boolean Parameter ?
Name?
PUBLISH_REPOSITORY
?
Description?
Choose whether the build will actually publish the job's resulting Maven artifacts to Maven.
Boolean Parameter ?
Choice Parameter ?
Credentials Parameter ?
File Parameter ?
Git Parameter ?
Multi-line String Parameter
Password Parameter ?
Promoted Build Parameter ?
Run Parameter ?
String Parameter ?
?
Number of builds?
1
Time period?
?
?
JDK
JDK to be used for this project
?
Label Expression?
N/A
Edited
?
Quiet period
Number of seconds
5
?
SCM checkout retry count
2
?
?
?
Directory
N/A
Display Name?
N/A
?
Source Code Management
?
Repositories?
Repository URL?
N/A
Credentials?
Edited
Name?
N/A
Refspec?
N/A
Repository URL?
N/A
Credentials?
Edited
Name?
N/A
Refspec?
N/A
Branches to build?
Branch Specifier (blank for 'any')?
*/master
Branch Specifier (blank for 'any')?
*/master
Repository browser ?
Additional Behaviours
Advanced checkout behaviours
Advanced clone behaviours
Advanced sub-modules behaviours
Build single revision only ?
Calculate changelog against a specific branch ?
Check out to a sub-directory
Check out to specific local branch ?
Clean after checkout ?
Clean before checkout ?
Create a tag for every build ?
Custom SCM name ?
Custom user name/e-mail address
Don't trigger a build on commit notifications ?
Force polling using workspace ?
Git LFS pull after checkout ?
Merge before build ?
Polling ignores commits from certain users
Polling ignores commits in certain paths ?
Polling ignores commits with certain messages
Prune stale remote-tracking branches ?
Prune stale tags
Sparse Checkout paths ?
Strategy for choosing what to build ?
Use commit author in changelog ?
Wipe out repository & force clone ?
Git
?
Repositories?
Repository URL?
N/A
Credentials?
Edited
Name?
N/A
Refspec?
N/A
Repository URL?
https://github.com/eclipse-emf/org.eclipse.emf.git
Credentials?
Edited
Name?
N/A
Refspec?
N/A
Branches to build?
Branch Specifier (blank for 'any')?
*/master
Branch Specifier (blank for 'any')?
*/master
Repository browser ?
Additional Behaviours
Sparse Checkout paths ?
Path
N/A
Path
releng/org.eclipse.emf.releng/publish
Advanced checkout behaviours
Advanced clone behaviours
Advanced sub-modules behaviours
Build single revision only ?
Calculate changelog against a specific branch ?
Check out to a sub-directory
Check out to specific local branch ?
Clean after checkout ?
Clean before checkout ?
Create a tag for every build ?
Custom SCM name ?
Custom user name/e-mail address
Don't trigger a build on commit notifications ?
Force polling using workspace ?
Git LFS pull after checkout ?
Merge before build ?
Polling ignores commits from certain users
Polling ignores commits in certain paths ?
Polling ignores commits with certain messages
Prune stale remote-tracking branches ?
Prune stale tags
Sparse Checkout paths ?
Strategy for choosing what to build ?
Use commit author in changelog ?
Wipe out repository & force clone ?
Git
?
Build Triggers
?
Authentication Token
N/A Use the following URL to trigger build remotely: JENKINS_URL/job/maven-publish/build?token=TOKEN_NAME or /buildWithParameters?token=TOKEN_NAME
Optionally append &cause=Cause+Text to provide text that will be included in the recorded build cause.
?
Projects to watch
N/A
?
Schedule?
N/A
?
Enabled GitLab triggers
Push Events?
Push Events in case of branch delete?
Opened Merge Request Events?
Build only if new commits were pushed to Merge Request?
Accepted Merge Request Events?
Closed Merge Request Events?
Rebuild open Merge Requests?
Approved Merge Requests (EE-only)?
Comments?
Comment (regex) for triggering a build?
Jenkins please retry a build
Edited
Enable [ci-skip]?
Ignore WIP Merge Requests?
Labels that launch a build if they are added (comma-separated)?
N/A
Set build description to build cause (eg. Merge request or Git Push)?
Build on successful pipeline events
Pending build name for pipeline?
N/A
Cancel pending merge request builds on update?
Allowed branches
?
?
Include
N/A
Exclude
N/A
?
Source Branch Regex
N/A
Target Branch Regex
N/A
Include
N/A
Exclude
N/A
Secret token?
Job Name
N/A
Promotion
GitHub API credentials
Admin list
N/A
Use github hooks for build triggering?
Edited
Trigger phrase?
N/A
Only use trigger phrase for build triggering?
Close failed pull request automatically?
Skip build phrase?
.*\[skip\W+ci\].*
Display build errors on downstream builds?
Crontab line?
H/5 * * * *
White list
N/A
List of organizations. Their members will be whitelisted.
N/A
List of GitHub labels for which the build should not be triggered.
N/A
List of GitHub labels for which the build should only be triggered. (Leave blank for 'any')
N/A
Allow members of whitelisted organizations as admins?
Build every pull request automatically without asking (Dangerous!).?
Build description template?
N/A
Blacklist commit authors?
N/A
Whitelist Target Branches:?
N/A
N/A
Blacklist Target Branches:?
N/A
N/A
Included regions?
N/A
Excluded regions?
N/A
Edited
Trigger Setup
Build Status Messages
Cancel build on update
Comment File
Do not update commit status
Update commit status during build
?
?
Schedule?
N/A
?
Build Environment
Edited
Patterns for files to be deleted?
N/A
Apply pattern also on directories?
Check parameter?
N/A
External Deletion Command?
N/A
Disable deferred wipeout?
?
Bindings
Secret file ?
Variable?
KEYRING
Credentials?
N/A
Certificate ?
Docker client certificate
Git Username and Password
SSH User Private Key ?
Secret ZIP file ?
Secret file ?
Secret text ?
Username and password (conjoined) ?
Username and password (separated) ?
?
Managed Files
File?
Target?
N/A
Variable?
N/A
File?
Target?
N/A
Variable?
N/A
?
Server authentication token
SonarQube authentication token. Mandatory when anonymous access is disabled. Will default to the one defined in the SonarQube installation.
?
?
Credentials
N/A
N/A
?
Only post commit status of parent matrix job?
Commit Status Context?
N/A
Commit Status URL?
N/A
Commit Status Build Triggered?
N/A
Commit Status Build Started?
N/A
Add test result one liner
Commit Status Build Result?
Build Result?
Message?
N/A
?
Kubernetes server endpoint?
N/A
Certificate of certificate authority ?
N/A
Credentials
Time-out strategy ?
Time-out variable
Set a build timeout environment variable
N/A
Time-out actions?
Abort the build ?
Fail the build ?
Writing the build description ?
?
Ant Version
JDK
Build Steps
Invoke top-level Maven targets ?
Maven Version
Goals
-B
Edited
POM?
releng/org.eclipse.emf.releng/publish/pommod/pom.xml
Properties?
N/A
JVM Options?
N/A
?
Settings file ?
?
Global Settings file ?
?
Invoke top-level Maven targets ?
Maven Version
Goals
-B
Edited
POM?
releng/org.eclipse.emf.releng/publish/pom.xml
Properties?
version.emf=$EMF_VERSION
JVM Options?
N/A
?
Settings file ?
?
Global Settings file ?
?
Execute shell ?
Command
See the list of available environment variables
gpg --batch --import "${KEYRING}"
for fpr in $(gpg --list-keys --with-colons  | awk -F: '/fpr:/ {print $10}' | sort -u);
do
  echo -e "5\ny\n" |  gpg --batch --command-fd 0 --expert --edit-key $fpr trust;
done

# https://bugs.eclipse.org/bugs/show_bug.cgi?id=573866
mkdir -p ~/.gnupg
cat >> ~/.gnupg/gpg.conf <<EOL
use-agent 
pinentry-mode loopback
EOL
cat >> ~/.gnupg/gpg-agent.conf <<EOL
allow-loopback-pinentry
EOL
echo RELOADAGENT | gpg-connect-agent
Edited
Exit code to set build unstable?
N/A
Environment filters
Only Keep Specified Environment Variables ?
Execute shell ?
Command
See the list of available environment variables
set +e

MVN_CMD=/opt/tools/apache-maven/latest/bin/mvn
MVN_SETTINGS=/home/jenkins/.m2/settings.xml
cat $MVN_SETTINGS
#JAVA_HOME=/opt/tools/java/oracle/jdk-8/latest
echo "$JAVA_HOME"

REPO_PATH=releng/org.eclipse.emf.releng/publish/target/repository/final
REPO_ID=ossrh
if [[ "I_BUILD" == "$EMF_VERSION" ]]
then
  REPO_URL=https://oss.sonatype.org/content/repositories/snapshots/
else
  REPO_URL=https://oss.sonatype.org/service/local/staging/deploy/maven2
fi

$MVN_CMD -version


#####################################
## FUNCTION create_javadoc
#####################################
# $1: source jar path
# $2: javadoc jar path
# $3: javadoc window title
# $4: javadoc doc title
# $5: javadoc header
# $6: javadoc bottom
create_javadoc () {
  pushd $(pwd)
  
  mkdir -p $WORKSPACE/.create_javadoc/src
  cd $WORKSPACE/.create_javadoc/src

  # extract to src dir
  jar -xf $1

  # go one level up to invoke javadoc
  cd ..
  
  echo "Creating Javadoc..."
  echo "  Window Title: $3"
  echo "  Doc Title: $4"
  echo "  Header: $5"
  echo "  Botton: $6"
  
  # produce javadoc from 'src' dir to 'target' dir
  $JAVA_HOME/bin/javadoc -sourcepath src \
    -d target \
    -use \
    -splitIndex \
    -windowtitle "$3" \
    -doctitle "$4" \
    -header "$5" \
    -bottom "$6" \
    -quiet \
    -J-Xmx180m \
    -Xdoclint:none \
    -subpackages org 2>&1 | tail -n 2
  
  # package javadocs
  cd target
  $JAVA_HOME/bin/jar -cf $2 *
  
  popd
  # clean temp dir
  rm -rf $WORKSPACE/.create_javadoc
}

#####################################
## MAIN SCRIPT
#####################################

# Enhance generated POMs by mandatory information (name, SCM, license, developers)
$JAVA_HOME/bin/java \
  -jar releng/org.eclipse.emf.releng/publish/pommod/target/pommod.jar \
  -dir $REPO_PATH/org

find $REPO_PATH/org -name "*.pom" | while read fname; do
	sed "/^<\/project>/d" "$fname" > "$fname".new
    cat >> "$fname".new <<EOL
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-gpg-plugin</artifactId>
        <version>3.1.0</version>
        <executions>
          <execution>
            <id>sign-artifacts</id>
            <phase>verify</phase>
            <goals>
              <goal>sign</goal>
            </goals>
            <configuration>
            <!--
              <keyname>E546E049</keyname>
            -->
              <gpgArguments>
                <arg>--pinentry-mode</arg>
                <arg>loopback</arg>
              </gpgArguments>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>
EOL
    mv "$fname".new "$fname"
done

# loop over the aggregated repository and call the GPG plugin with 'sign-and-deploy-file' goal
#   http://maven.apache.org/plugins/maven-gpg-plugin/sign-and-deploy-file-mojo.html
# append /org to REPO_PATH to avoid match of artifacts.jar/content.jar
# use string replacement to replace the file extension for the .pom file for each jar
find $REPO_PATH/org -name "*.jar" | while read fname; do
  # only take action for the non-source bundles
  if [[ ! "$fname" =~ ".*-sources.jar" ]]; then
    POM_FILE="${fname/%.jar/.pom}"
    SOURCES_JAR="${fname/%.jar/-sources.jar}"
    JAVADOC_JAR="${fname/%.jar/-javadoc.jar}"
    PUBLISH_FILE="${fname/%.jar/.publish}"
    
    if [ -f $SOURCES_JAR -a ! -f $PUBLISH_FILE ]; then
      echo "Artifact already published"
    fi
    
    if [ -f $SOURCES_JAR -a -f $PUBLISH_FILE ]; then
      JAVADOC_TITLE=`sed '1q;d' $PUBLISH_FILE`
      JAVADOC_FOOTER=`sed '2q;d' $PUBLISH_FILE`
      create_javadoc \
        $WORKSPACE/$SOURCES_JAR \
        $WORKSPACE/$JAVADOC_JAR \
        "$JAVADOC_TITLE" \
        "$JAVADOC_TITLE" \
        "$JAVADOC_TITLE" \
        "$JAVADOC_FOOTER"

      if  [[ $PUBLISH_REPOSITORY == "true" ]]
      then
        cat $POM_FILE
        $MVN_CMD -B -DinteractiveMode=false org.apache.maven.plugins:maven-gpg-plugin:3.1.0:sign-and-deploy-file \
          -Dfile=$fname \
          -DpomFile=$POM_FILE \
          -DrepositoryId=$REPO_ID \
          -Durl=$REPO_URL

        $MVN_CMD -B -DinteractiveMode=false org.apache.maven.plugins:maven-gpg-plugin:3.1.0:sign-and-deploy-file \
          -Dfile=$SOURCES_JAR \
          -DpomFile=$POM_FILE \
          -DrepositoryId=$REPO_ID \
          -Durl=$REPO_URL \
          -Dclassifier=sources
      
        $MVN_CMD -B -DinteractiveMode=false org.apache.maven.plugins:maven-gpg-plugin:3.1.0:sign-and-deploy-file \
          -Dfile=$JAVADOC_JAR \
          -DpomFile=$POM_FILE \
          -DrepositoryId=$REPO_ID \
          -Durl=$REPO_URL \
          -Dclassifier=javadoc
      fi
    fi
  fi
done
Edited
Exit code to set build unstable?
N/A
Environment filters
Only Keep Specified Environment Variables ?
Conditional step (single) ?
Conditional steps (multiple)
Execute SonarQube Scanner
Execute Windows batch command ?
Execute shell ?
Invoke Ant ?
Invoke top-level Maven targets ?
Provide Configuration files ?
Run with timeout
Set build status to "pending" on GitHub commit
SonarScanner for MSBuild - Begin Analysis ?
SonarScanner for MSBuild - End Analysis ?
Trigger/call builds on other projects
Post-build Actions
Archive the artifacts ?
Files to archive?
releng/org.eclipse.emf.releng/publish/target/repository/final/**
Edited
Excludes?
N/A
?
?
?
?
Aggregate downstream test results ?
Archive the artifacts ?
Build other projects ?
Discover reference build
Mine SCM repository
Publish JUnit test result report ?
Publish Javadoc
Record compiler warnings and static analysis results
Record fingerprints of files to track usage ?
Git Publisher ?
Github Pull Request Merger
SonarQube analysis with Maven ?
Accept GitLab merge request on success
Add note with build status on GitLab merge requests ?
Add vote for build status on GitLab merge requests
E-mail Notification ?
Editable Email Notification ?
Publish build status to GitLab ?
Set GitHub commit status (universal) ?
Set build status on GitHub commit [deprecated] ?
Trigger parameterized build on other projects ?
Delete workspace when build is done