Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 4.01 KB

File metadata and controls

107 lines (70 loc) · 4.01 KB

Pipeline Graph View Plugin

Build Status Gitter Jenkins Plugin Jenkins Plugin Installs

preview.png

Introduction

This plugin adds a visual representation of Jenkins pipelines, showing each stage of a run in a clear and easy-to-follow graph format. It’s designed to make pipeline progress and structure easier to understand at a glance.

Features

  • Visualize pipelines as an interactive, nested graph
  • Navigate pipeline stages in a clear, collapsible list view
  • View logs in real time without leaving the interface
  • Toggle between graph and stage views; move and resize panes to suit your workflow
  • Collapse and expand individual stages with parallel branches or nested children
  • Quickly access details of each step and its results
  • Hide specific steps from view using the hideFromView Pipeline DSL step
  • Designed for better readability and faster troubleshooting

Getting started

  1. Install the Pipeline Graph View plugin
  2. Go to some pipeline build page (not the job page)
  3. Click Pipeline Overview

Hidden steps are not displayed by default in the Pipeline Overview, but can be toggled visible using the filter controls.

Screenshots

Basic pipeline:

Different statuses

Semi-complex pipeline:

Semi complex pipeline

Video

See a live demonstration from a Jenkins Contributor Summit:

Demo of Pipeline Graph View plugin

Pipeline DSL Extensions

Collapsible Console Sections

Console output can be split into collapsible sections using ##[group] / ##[endgroup] markers (Azure DevOps style) or ::group:: / ::endgroup:: (GitHub Actions style):

sh '''
    echo "##[group]Unit Tests"
    ./run-tests.sh
    echo "##[endgroup]"
'''

Sections with more than 25 lines start collapsed. Nested sections are supported. See collapsible-console-sections.md for full details including colored titles with the AnsiColor plugin.

Hiding Steps from View

You can mark specific pipeline steps as hidden from the view by wrapping them with the hideFromView step:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo "This step is visible"

                hideFromView {
                    echo "This step is hidden by default"
                }

                echo "This step is also visible"
            }
        }
    }
}

REST API

The REST API documentation can be found here.

Extending the Plugin

Plugin authors can contribute custom collapsible section rules via two extension points:

  • ConsoleSectionRule - regex-based, runs client-side. Good for simple delimited output (npm install, pip, Docker builds, etc.).
  • ConsoleSectionAnnotator - stateful, runs server-side line by line. Good for context-dependent grouping like stack traces or test suite blocks.

See extending-console-sections.md for examples of both.

Contributing

Refer to our contribution guidelines.

LICENSE

Licensed under MIT, see LICENSE.