# pipeline-graph-view-plugin

**Repository Path**: mamh-java/pipeline-graph-view-plugin

## Basic Information

- **Project Name**: pipeline-graph-view-plugin
- **Description**: https://github.com/mamh-java/pipeline-graph-view-plugin
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-14
- **Last Updated**: 2026-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pipeline Graph View Plugin

[![Build Status](https://ci.jenkins.io/buildStatus/icon?job=Plugins%2Fpipeline-graph-view-plugin%2Fmain)](https://ci.jenkins.io/job/Plugins/job/pipeline-graph-view-plugin/job/main/)
[![Gitter](https://badges.gitter.im/jenkinsci/ux-sig.svg)](https://gitter.im/jenkinsci/ux-sig?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/pipeline-graph-view.svg)](https://plugins.jenkins.io/pipeline-graph-view)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/pipeline-graph-view.svg?color=blue)](https://plugins.jenkins.io/pipeline-graph-view)

![preview.png](docs/images/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](./docs/per-stage-collapse.md) 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](https://plugins.jenkins.io/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](./docs/images/different-statuses.png)

Semi-complex pipeline:

![Semi complex pipeline](./docs/images/semi-complex-pipeline.png)

## Video

See a live demonstration from a Jenkins Contributor Summit:

[![Demo of Pipeline Graph View plugin](https://img.youtube.com/vi/MBI3MBY2eJ8/0.jpg)](https://www.youtube.com/watch?v=MBI3MBY2eJ8&t=3295 "Pipeline Graph View plugin")

## Pipeline DSL Extensions

### Hiding Steps from View

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

```groovy
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](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/jenkinsci/pipeline-graph-view-plugin/refs/heads/main/openapi.yaml).

## Contributing

Refer to our [contribution guidelines](./CONTRIBUTING.md).

## LICENSE

Licensed under MIT, see [LICENSE](LICENSE.md).