Jenkins plugin for pipeline visualisation, perfect for Continuous Delivery
Java JavaScript CSS Other
Switch branches/tags
release-1.0.0 release-0.10.3 release-0.10.2 release-0.10.1 release-0.10.1rc10 release-0.10.1rc8 release-0.10.1rc7 release-0.10.1rc6 release-0.10.1rc5 release-0.10.1rc4 release-0.10.1rc3 release-0.10.1rc2 release-0.10.1rc1 release-0.10.rc9 origin delivery-pipeline-plugin-1.0.0 delivery-pipeline-plugin-0.10.3 delivery-pipeline-plugin-0.10.2 delivery-pipeline-plugin-0.10.1 delivery-pipeline-plugin-0.10.1rc10 delivery-pipeline-plugin-0.10.1rc6 delivery-pipeline-plugin-0.10.0 delivery-pipeline-plugin-0.9.12 delivery-pipeline-plugin-0.9.11 delivery-pipeline-plugin-0.9.10 delivery-pipeline-plugin-0.9.9 delivery-pipeline-plugin-0.9.8 delivery-pipeline-plugin-0.9.7 delivery-pipeline-plugin-0.9.6 delivery-pipeline-plugin-0.9.5 delivery-pipeline-plugin-0.9.4 delivery-pipeline-plugin-0.9.3 delivery-pipeline-plugin-0.9.2 delivery-pipeline-plugin-0.9.1 delivery-pipeline-plugin-0.9.0 delivery-pipeline-plugin-0.8.11 delivery-pipeline-plugin-0.8.10 delivery-pipeline-plugin-0.8.9 delivery-pipeline-plugin-0.8.8 delivery-pipeline-plugin-0.8.7 delivery-pipeline-plugin-0.8.6 delivery-pipeline-plugin-0.8.5 delivery-pipeline-plugin-0.8.4 delivery-pipeline-plugin-0.8.3 delivery-pipeline-plugin-0.8.2 delivery-pipeline-plugin-0.8.1 delivery-pipeline-plugin-0.8.0 delivery-pipeline-plugin-0.7.5 delivery-pipeline-plugin-0.7.4 delivery-pipeline-plugin-0.7.3 delivery-pipeline-plugin-0.7.2 delivery-pipeline-plugin-0.7.1 delivery-pipeline-plugin-0.7.0 delivery-pipeline-plugin-0.6.10 delivery-pipeline-plugin-0.6.9 delivery-pipeline-plugin-0.6.8 delivery-pipeline-plugin-0.6.7 delivery-pipeline-plugin-0.6.6 delivery-pipeline-plugin-0.6.5 delivery-pipeline-plugin-0.6.4 delivery-pipeline-plugin-0.6.3 delivery-pipeline-plugin-0.6.2 delivery-pipeline-plugin-0.6.1 delivery-pipeline-plugin-0.6 delivery-pipeline-plugin-0.5 delivery-pipeline-plugin-0.4 delivery-pipeline-plugin-0.3 delivery-pipeline-plugin-0.2 delivery-pipeline-plugin-0.1.1 delivery-pipeline-plugin-0.1
Nothing to show
Latest commit dbe94a3 Apr 27, 2017 @tommysdk tommysdk committed with tommysdk JENKINS-35346 Support view descriptions for Jenkins pipeline views
* Added configuration option to pipeline view configuration

README.md

Delivery Pipeline Plugin

alt tag

Build Status Coverage Status

For info see the Delivery Pipeline Plugin - Wiki

Issue tracker for bugs, improvements and new features, please report any issues on component delivery-pipeline-plugin

Contributed by Diabol AB

How to contribute

Read GitHub's general contribution guidelines: https://guides.github.com/activities/contributing-to-open-source/#contributing

It basically comes down to the following guidelines:

  1. If applicable, create a Jira issue
    • Make sure a similar issue doesn't already exist
  2. Fork the repo
  3. Contribute and have fun!
  4. Add as much unit testing as possible to any new code changes
    • This will make the code much more easy to maintain and to understand its intent
  5. Make sure your code is well formatted and aligns with the projects code style conventions
  6. Make sure to prefix the commit message with the associated Jira issue number together with a descriptive commit message
  7. If you have multiple commits, please make sure to squash them before creating a pull request
    • It's hard to follow contributions when they are scattered across several commits
  8. Create a pull request to get feedback from the maintainers
    • Add a link to the pull request to the associated Jira issue

Requirements

Delivery Pipeline plugin 1.0.0 and later requires Java 7 and Jenkins core 1.642.3 or later.

Delivery Pipeline plugin 0.10.3 requires Java 6 and Jenkins core 1.565 or later.

Build

mvn clean install

Run locally

mvn hpi:run

Run function tests

mvn integration-test

Build and run the Delivery Pipeline plugin in a Docker container

mvn clean install
docker build -t dpp .
docker run -p 8080:8080 dpp

Configuring manually triggered jobs

Note: This requires the Build Pipeline plugin to be installed.

To be able to configure a certain job in the pipeline as a manual step, you have to configure the upstream job that triggers the job which is to be performed manually to be marked as a manual step.

In the Jenkins UI this shows up as a Post-Build Action: Build other projects (manual step), where you configure the name of the job to be manually triggered in the "Downstream Project Names".

If you're creating your jobs with JobDSL, use the following syntax in the publishers section (parameters is optional):

publishers {
    buildPipelineTrigger('name-of-the-manually-triggered-job') {
        parameters {
            propertiesFile('env.${BUILD_NUMBER}.properties')
        }
    }
}

In your pipeline configuration, make sure to enable manual triggers. The manual triggers (a play button) will not be shown in the UI for aggregate pipelines, only for pipeline instances. If you want to access manual triggers from the UI, make sure to show at least one pipeline instance.

Here is an example of a corresponding JobDSL pipeline view configuration:

deliveryPipelineView("my-pipeline") {
    name("my-pipeline")
    description("Delivery pipeline with a manual trigger")
    pipelineInstances(1)
    showAggregatedPipeline(false)
    columns(1)
    updateInterval(2)
    enableManualTriggers(true)
    showAvatars(false)
    showChangeLog(true)
    pipelines {
        component("My pipeline", "the-name-of-the-first-job-in-the-pipeline")
    }
}

Using a custom CSS

Here is an example of how to specify a custom CSS for the Delivery Pipeline Plugin using a JobDSL pipeline view configuration:

deliveryPipelineView("my-pipeline") {
    name("my-pipeline")
    description("Delivery pipeline with custom full screen CSS")
    pipelineInstances(1)
    showAggregatedPipeline(false)
    columns(1)
    updateInterval(2)
    enableManualTriggers(true)
    showAvatars(false)
    showChangeLog(true)
    configure { node ->
        node << {
            fullScreenCss('https://my-jenkins-instance/userContent/my-pipeline-fullscreen.css')
        }
    }
    pipelines {
        component("My pipeline", "the-name-of-the-first-job-in-the-pipeline")
    }
}

For Jenkins Job Builder job configuration examples, see: demo.yaml

For JobDSL job configuration examples, see: demo.groovy