jenkinsci / updatebot-plugin Goto Github PK

Updatebot Plugin

| | Wiki

UpdateBot is a bot which updates dependencies in source code via Pull Requests.

The Updatebot Jenkins Plugin provides an easy way to use UpdateBot inside yourJenkins Pipeline

Example

Here's an example of using the updateBotPush() step inside your pipeline:

node {

    stage('Release') { 
        git 'https://github.com/jstrachan-testing/updatebot-npm-sample.git'

        // TODO do the actual release first...
        
        // TODO wait for the release to be in maven central...
    }

    stage('UpdateBot') {
        // now lets update any dependent projects with this new release
        // using the local file system as the tagged source code with versions
        updateBotPush()
    }
}

The updateBotPush command then uses the UpdateBot Configuration mechanism to find which git repositories to perform pull requests on.

Typically this configured via a local .updatebot.yml file or if there is no .updatebot.yml file then UpdateBot will look for a github repository at https://github.com/organisation/organisation-updatebot/ where organisation is your actual github organisation name.

Requirements

To run UpdateBot on your projects your Jenkins master will need the following:

• a Maven tool installation for working with Java/Maven based projects
• a NodeJS tool installation for working with node based projects

The Maven or Node installations can be made inside the docker image for your Jenkins master if you prefer; then you don't have to use the tool installation mechanism in your Jenkins master.