Skip to main content
Jump to: navigation, search

Difference between revisions of "Jenkins"

(Resource Packs)
Line 39: Line 39:
 
Resource Packs are assigned by Eclipse Members to Eclipse Projects they sponsor (Members have a Project Lead on the Project). Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A <ember can assign several packs to a single project.
 
Resource Packs are assigned by Eclipse Members to Eclipse Projects they sponsor (Members have a Project Lead on the Project). Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A <ember can assign several packs to a single project.
  
To assign a pack to a project, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins file a Bug].
+
To assign a pack to a project, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins&short_desc=Assign%20Resource%20Pack%20to%20Project file a Bug].
  
 
== Asking for Help ==
 
== Asking for Help ==
Line 48: Line 48:
 
== Requesting a JIPP instance ==
 
== Requesting a JIPP instance ==
  
Please file [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins a bug] against Eclipse Foundation > Community > CI-Jenkins to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download or code repositories.
+
Please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins&short_desc=JIPP%20Request file a bug] against Eclipse Foundation > Community > CI-Jenkins to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download or code repositories.
  
 
{{Note|About write access| If your git repo is handled by Gerrit, granting write access to your code repositories is a different procedure, so you must ask specifically for it. If you don't use Gerrit, then granting write access to your download area automatically grants write access to your code repositories and vice-versa.}}
 
{{Note|About write access| If your git repo is handled by Gerrit, granting write access to your code repositories is a different procedure, so you must ask specifically for it. If you don't use Gerrit, then granting write access to your download area automatically grants write access to your code repositories and vice-versa.}}
Line 56: Line 56:
 
= Jenkins configuration and tools  =
 
= Jenkins configuration and tools  =
  
Check [[CI best practices]] for general recommendations how to setup Jenkins.
+
* Check [[CI best practices]] for general recommendations how to setup Jenkins.
 +
* Check the Eclipse [[CBI]] project for tools, configurations and other information.
  
== Tools (and locations) ==
+
[[Category:CBI]] [[Category:Releng]] [[Category:Jenkins]]
Build tools like JDK, Maven, Ant and Gradle are already configured in every Jenkins instance.
+
 
+
* JDK
+
** jdk10-latest (/shared/common/java/oracle/jdk-10_x64-latest)
+
** jdk9-latest (/shared/common/jdk-9_x64-latest)
+
** jdk1.8.0-latest (/shared/common/jdk1.8.0_x64-latest)
+
** jdk1.7.0-latest (/shared/common/jdk1.7.0-latest)
+
** jdk1.6.0-latest (/shared/common/jdk1.6.0-latest)
+
** jdk1.5.0-latest (/shared/common/jdk1.5.0-latest)
+
 
+
* Maven
+
** apache-maven-latest (/shared/common/apache-maven-latest)
+
** apache-maven-3.0.5 (/shared/common/apache-maven-3.0.5)
+
 
+
* Ant
+
** apache-ant-1.9.6 (/shared/common/apache-ant-1.9.6)
+
 
+
* Gradle
+
** gradle-latest (/shared/common/gradle-latest)
+
** gradle-3.1 (/shared/common/gradle-3.1)
+
 
+
More generally, all tools listed on http://build.eclipse.org/common/ are available from '''/shared/common/'''.
+
 
+
If you need tools that are not general purpose installed, project members can install them in your project's home directory, for example ~/buildtools. [https://dev.eclipse.org/mhonarc/lists/cbi-dev/msg01869.html See email on cbi-dev]
+
 
+
== Default plugins ==
+
 
+
The following plugins are installed by default. Additional plugins can be installed on request.
+
 
+
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
+
* ace-editor
+
* analysis-core
+
* ant
+
* antisamy-markup-formatter
+
* authentication-tokens
+
* bouncycastle-api
+
* branch-api
+
* build-timeout
+
* cloudbees-folder
+
* conditional-buildstep
+
* credentials
+
* credentials-binding
+
* dashboard-view
+
* disk-usage
+
* display-url-api
+
* docker-commons
+
* docker-workflow
+
* durable-task
+
* external-monitor-job
+
* extra-columns
+
* find-bugs
+
* gerrit-trigger
+
* git
+
* git-client
+
* git-parameter
+
* git-server
+
* gradle
+
* greenballs
+
* handlebars
+
* icon-shim
+
* javadoc
+
* jobConfigHistory
+
* jquery
+
* jquery-detached
+
* junit
+
* ldap
+
* mailer
+
* matrix-auth
+
* matrix-project
+
* maven-plugin
+
* momentjs
+
* pam-auth
+
* parameterized-trigger
+
* pipeline-build-step
+
* pipeline-graph-analysis
+
* pipeline-input-step
+
* pipeline-milestone-step
+
* pipeline-model-api
+
* pipeline-model-declarative-agent
+
* pipeline-model-definition
+
* pipeline-model-extensions
+
* pipeline-rest-api
+
* pipeline-stage-step
+
* pipeline-stage-tags-metadata
+
* pipeline-stage-view
+
* plain-credentials
+
* promoted-builds
+
* rebuild
+
* resource-disposer
+
* scm-api
+
* script-security
+
* sonar
+
* ssh-credentials
+
* ssh-slaves
+
* structs
+
* timestamper
+
* token-macro
+
* windows-slaves
+
* workflow-aggregator
+
* workflow-api
+
* workflow-basic-steps
+
* workflow-cps
+
* workflow-cps-global-lib
+
* workflow-durable-task-step
+
* workflow-job
+
* workflow-multibranch
+
* workflow-scm-step
+
* workflow-step-api
+
* workflow-support
+
* ws-cleanup
+
* xvnc
+
</div>
+
 
+
== Setup for specific plugins ==
+
 
+
=== GitHub Pull Request Builder Plugin ===
+
 
+
The [https://wiki.jenkins.io/display/JENKINS/GitHub+pull+request+builder+plugin GitHub Pull Request Builder Plugin] (GHPRB) allows to build/test pull requests and provide immediate feedback in the pull request on GitHub.
+
 
+
'''To set this up, please open a Bugzilla issue against the CI-Jenkins component (Product: Community) and request this feature.'''
+
 
+
Here are some details about what happens during the setup process:
+
* The GHPRB plugin is installed in the JIPP.
+
* Webmaster creates a GitHub bot user and adds it to the respective team on GitHub.
+
* The credentials of the GitHub bot user are added to the JIPP (with user name and password, because SSH keys are not recommended/supported by the plugin).
+
* The GHPRB plugin's main config is set up.
+
 
+
Once the ticket is resolved you should be able to configure and use the GHPRB plugin in your jobs.
+
 
+
Instructions how to set up GHPRB plugin in jobs can be found here:
+
https://github.com/jenkinsci/ghprb-plugin/blob/master/README.md
+
 
+
'''Please note: ''' Currently we don't recommend to use the 'Use github hooks for build triggering' option. Instead, with this option turned off, Jenkins is polling GitHub instead. Which should work just fine in most cases.
+
 
+
More info can be found in the GitHub readme:
+
https://github.com/jenkinsci/ghprb-plugin/blob/master/README.md
+
 
+
=== Jenkins Pipeline (aka configuration in code) ===
+
 
+
An example how Eclipse plugins can be build with Tycho using a Jenkins pipeline can be found here (Thanks to Mickael Istria!):<br/>
+
https://github.com/eclipse/aCute/blob/master/Jenkinsfile
+
 
+
More info about Jenkins Pipeline can be found here:<br/>
+
https://jenkins.io/doc/book/pipeline/<br/>
+
https://jenkins.io/doc/book/pipeline/shared-libraries/
+
 
+
=== Gerrit Trigger Plugin ===
+
 
+
You may use the [https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger Jenkins Gerrit Trigger Plugin] in order to run a Jenkins job to verify each new patchset uploaded to Gerrit for code review. Jenkins (named "CI Bot") will then also vote on these changes using the "Verify" voting category.
+
 
+
[[Image:Jgit.gerrit-reviewer.png|450px]]
+
 
+
[[Image:Jgit.gerrit-vote.png|450px]]
+
 
+
Below, the configuration sections for the Git plugin and the Gerrit trigger plugin of the verification job used by the EGit project may serve as an example.
+
 
+
====General configuration settings====
+
 
+
# Check ''This project is parameterized''. Click the ''Add'' button and select ''String Parameter''. Set the parameter ''Name'' to '''GERRIT_REFSPEC''' and ''Default Value'' to '''refs/heads/master'''.
+
 
+
[[Image:Gerrit-refspec-param.png|600px]]
+
 
+
====Configuration of Source Code Management====
+
 
+
# Under ''Source Code Management'' select Git.
+
 
+
# Under ''Repositories'', click on ''Advanced'' and change the '''Refspec''' to '''${GERRIT_REFSPEC}'''.
+
 
+
# Under ''Additional Behaviours'', add '''Strategy for choosing what to build''' and select '''Gerrit Trigger''' as a strategy.
+
 
+
[[Image:Jgit.gerrit-git-config.png|600px]]
+
 
+
Note that the section '''Branches to build''' won't be used and may be deleted.
+
 
+
====Configuration of Build Triggers ====
+
 
+
# Under ''Build Triggers'', select '''Gerrit event'''.
+
 
+
[[Image:Jgit.gerrit-gerrit-config.png|600px]]
+
 
+
# Under ''Trigger on'', click on ''Add'' and select at least '''Patchset Created'''. This will configure the job to run on each new patchset. You can also add additional trigger, like '''Comment Added Contains Regular Expression'''. In the example below, a build will be triggered for the latest patch set if the comment is exactly '''CI Bot, run a build please'''.
+
 
+
[[Image:gerrit-trigger-events.png|600px]]
+
 
+
# Finally, configure at least one ''Gerrit Project''. The pattern is the name of project (i.e. if your repository is <code>git.eclipse.org/<xx>/<yy>.git</code>, then fill the pattern <code>xx/yy</code>). The ''Branches'' section is the list of branch to listen for events as configured above. Generally, you want one, named '''master''' to build patches submitted for the master branche, or <code>**</code> to build patches submitted to each and every branches. Set the type to '''Path'''.
+
 
+
[[Image:gerrit-trigger-project.png|600px]]
+
 
+
====Configuration of the build action====
+
 
+
Under "Build" click the "Add a build step" button, and select the appropriate action. The actual action depends on what you want Hudson to do. A typical example, for projects build with Maven is to select "Invoke Maven 3" and set "Maven 3" to "apache-maven-latest" and "Goals" to "clean verify".
+
 
+
 
+
[[Category:Releng]] [[Category:Jenkins]]
+

Revision as of 13:51, 13 September 2018

Jenkins logo.png

Jenkins is a continuous integration (CI) server used on Eclipse servers for Eclipse projects as part of the Common Build Infrastructure (CBI). Jenkins instances are maintained by the Eclipse Webmasters/Release Engineer.


Jenkins @ Eclipse (JIPP)

What's provided?

Each Eclipse Project has access to one Jenkins instance (JIPP), including the following:

  • (1) Jenkins instance, with (1) resources Base Pack (see below)
    • Membership-sponsored projects may allocate more resources (see below)
  • Digital signing Service: Java JAR, Java Cryptography Extensions, Windows Portable Executable with Microsoft Authenticode, macOS application bundles.
  • Packaging service: Apple Disk Image (.dmg), Linux Flatpak
  • Disk space: Ephemeral for builds, permanent for release builds.
  • Access to worldwide download mirrors

Additional Resource Packs

Each Eclipse Project has access to one Base pack for building. For some projects, that may not be enough. Projects sponsored by Eclipse Membership (via Project Lead) have additional Packs, based on membership level. These packs can be allocated to projects.

  • Some Packs are only available to Enterprise and Strategic members.
  • Enterprise and Strategic members can engage with the Foundation to acquire additional Packs.

CBI Resource Packs.png

Resource Packs Included in Membership

Eclipse Foundation Member Organizations have access to Resource Packs above the Base Pack that is allotted to each Project, based on their membership level.

CBI Resource Pack Assignments.png


Assigning Resource Packs to a Project

Resource Packs are assigned by Eclipse Members to Eclipse Projects they sponsor (Members have a Project Lead on the Project). Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A <ember can assign several packs to a single project.

To assign a pack to a project, please file a Bug.

Asking for Help

Requesting a JIPP instance

Please file a bug against Eclipse Foundation > Community > CI-Jenkins to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download or code repositories.

Note.png
About write access
If your git repo is handled by Gerrit, granting write access to your code repositories is a different procedure, so you must ask specifically for it. If you don't use Gerrit, then granting write access to your download area automatically grants write access to your code repositories and vice-versa.


Important.png
Security issues
There may be security issues related to using the Gerrit plugin and there may be security issues related to allowing the CI system to write directly to your code repos and downloads area. If you request plugins other than those available on the Shared instance, webmaster may not be able to help troubleshoot any issues that you may encounter with your instance.


Jenkins configuration and tools

  • Check CI best practices for general recommendations how to setup Jenkins.
  • Check the Eclipse CBI project for tools, configurations and other information.

Back to the top