Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 3.88 KB

README.md

File metadata and controls

74 lines (60 loc) · 3.88 KB
Raw

Google Cloud Build Pipeline Visualizer

build codecov

For the current version of Google cloud build, it supports the async process with the variable waitFor. With the growth of complexity of your pipeline, it will be hard to maintain the async flow. Unlike Jenkins and CircleCI, there is no visualizer for your pipeline. This application aims at visualize the pipeline and help the developers to debug their cloud build.

Current features

  • YAML format cloud build definition digestion
  • Temporary graph rendering
  • Save graph as dot, png, jpg or jpeg
  • JSON format support

Rule of cloud build async process

From the Google docs, there are a few rules for the async process.

  1. If no values are provided for waitFor, the build step waits for all prior build steps in the build request to complete successfully before running.
  2. A step is dependent on every id in its waitFor and will not launch until each dependency has completed successfully.
  3. By declaring that a step depends only on -, the step runs immediately when the build starts.

How to install

  1. Through go get (Recommended)

    You can install the binary through the following command.

    go get -u github.com/RyanSiu1995/gcb-visualizer

  2. Install the pre-built binary

    You can download the pre-built binary in release page of this repo. Because of the C binding in the Graphviz library, there is a difficulty in building binary based on different common OS and Arch. The current pre-built binaries are built under 64 bit. If you are an user with 32 bits system, please use other approach. If the pre-built binary does not work. Please report on the issue.

  3. Use pre-built docker image

    You can use docker image released to execute the gcb-visualizer without considering the OS and Arch. Please follow this instruction to setup the command alias.

    docker pull ryansiu1995/gcb-visualizer:latest
alias gcb-visualizer="docker run -v $(pwd):/app ryansiu1995/gcb-visualizer:latest"

    or this command in powershell

    docker pull ryansiu1995/gcb-visualizer:latest
Set-Alias gcb-visualizer "docker run -v $(pwd):/app ryansiu1995/gcb-visualizer:latest"

    You can put the alias to your profile in order to create a permanent alias.

How to use

You can visualize your pipeline with the following command.

gcb-visualizer visualize <your-cloudbuild-yaml-or-json-file>

If you want to output the graph into other formats, you can use the output flag as the following.

gcb-visualizer visualize --output my-pipeline.jpg <your-cloudbuild-yaml>

The current supported output formats are jpg, jpeg, dot and png.

Example Output

Given an example input of something like the Google Cloud integration test example you should get an output that looks something like this

Go Builder output

Future features

  • Cloudbuild definition linting and checking
  • Multiple OS and Arch binary building
  • Brew, Apt and Chocolatey support
  • Quick installation script
  • More beautiful generated graph

Contributing

Please feel free to submit a pull request or open an issue for the application improvement. Before creating the pull request, please kindly run the follow command to test the program

make tests

License

This project is licensed under the MIT License - see the LICENSE.md file for details