Child pages
  • Jenkins Script Console
42 more child pages

Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

Jenkins Script Console

Jenkins features a nice Groovy script console which allows to run arbitrary scripts on the Jenkins server or on slave nodes. This feature can be accessed from the "manage Jenkins" link, typically at your http://server/jenkins/script.

Shortcut key on script console to submit

You can submit a script without mouse. Jenkins has a shortcut key which enables to submit with keyboard.

  • Windows / Linux : Ctrl + Enter
  • Mac : Command + Enter

Remote access

User can execute groovy scripts remotely sending post request to /script/ url or /scriptText/ to have response returned without the html wrapping.

$ curl -d "script=<your_script_here>" http://jenkins/script
$ # or
$ curl -d "script=<your_script_here>" http://jenkins/scriptText

Also, Jenkins CLI offers the possibility to execute groovy scripts remotely using groovy command or execute groovy interactivelly via groovysh.

Sample Groovy scripts

Some scripts at JBoss.org

More Scripts available at Scriptler Web 

Write Groovy scripts for Jenkins with Code completion

Plugins enabling Groovy usage

  • Page:
    Config File Provider Plugin — Adds the ability to provide configuration files (i.e., settings.xml for maven, XML, groovy, custom files, etc.) loaded through the Jenkins UI which will be copied to the job's workspace.
  • Page:
    Global Post Script Plugin — Execute a global configured groovy script after each build of each job managed by the Jenkins.
    This is typical for cases when you need to do something based on a shared set of parameters, such as triggering downstream jobs managed by the same Jenkins or remote ones based on the parameters been passed to the parameterized jobs.

    Notice: jython script support removed since 1.1.0

  • Page:
    Groovy plugin — This plugin adds the ability to directly execute Groovy code.
  • Page:
    Groovy Postbuild Plugin — This plugin executes a groovy script in the Jenkins JVM. Typically, the script checks some conditions and changes accordingly the build result, puts badges next to the build in the build history and/or displays information on the build summary page.
  • Page:
    Groovy Remote Control Plugin — This plugin provides Groovy Remote Control's receiver, and allows to control external application from Jenkins.
  • Page:
    Matrix Groovy Execution Strategy Plugin — A plugin to decide the execution order and valid combinations of matrix projects.
  • Page:
    Pipeline Classpath Step Plugin — Pipeline DSL step to add path to the groovy classpath
  • Page:
    Scriptler Plugin — Scriptler allows you to store/edit groovy scripts and execute it on any of the slaves/nodes... no need to copy/paste groovy code anymore.
  • Page:
    SnowGlobe Plugin — This plugin provides the ability to define Infrastructure as Code. Create, update and tear down clusters of related docker containers for builds, testing or continuous delivery.

     

    Snowglobe plugin for Jenkins

    This allows Jenkins jobs to control a SnowGlobe instance (see https://nirima.github.io/SnowGlobe/).

    Operations

    The operations are relatively simple:

    Clone

    snowglobe_clone createAction: true, sourceId: 'ci-template', targetId: 'new-globe-name'

    Set Variables

    snowglobe_set_variables globeId: 'my-globe', variables: 'key="value"'

    Get Variables

    data = snowglobe_get_variables  globeId: 'my-globe'

    Apply

    snowglobe_apply createAction: true, globeId: 'my-globe'

    State

    data = snowglobe_state createAction: false, globeId: 'my-globe'

    Destroy

    snowglobe_clone remove: true, globeId: 'my-globe'

    Remove: set to true to also remove the SnowGlobe after destruction.

    In all cases - createAction controls whether to add an action to the build, which will also remove the globe when the CI build is complete.

  • No labels