Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Latest commit

 

History

History

demo

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
basic
basic
 
 
complex
complex
 
 
custom-client
custom-client
 
 
multi-sub
multi-sub
 
 
multi
multi
 
 
state
state
 
 
README.md
README.md
 
 
generate.sh
generate.sh
 
 

README.md

Demo pipelines

These demo pipelines are available to demonstrate a valuable structure of a pipeline.

Running a demo pipeline with the Scribe CLI utility (requires mage):

  1. Clone and cd into the Scribe project: git clone git@github.com:grafana/scribe.git && cd scribe
  2. Compile the scribe CLI: mage build
  3. Run the pipeline: ./bin/scribe ./demo/{demo}.

Running a demo pipeline without the Scribe CLI:

  1. Clone and cd into the Scribe project: git clone git@github.com:grafana/scribe.git && cd scribe
  2. Run the pipeline: PIPELINE=./demo/{pipeline} go run -path=$PIPELINE $PIPELINE

./basic

This basic pipeline creates a single pipeline which runs many common steps that most projects might have.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing

./complex

This more complex pipeline creates a single pipeline which runs many steps with logs and timeouts. It has many steps and demonstrates a maintainable approach to writing large pipelines and steps that use structured logging and traces.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing

./multi

This program creates multiple pipelines which run in sequence; one of which will only run if a commit on the main branch was tagged with a string starting with v.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing

./multi-sub

This program creates multiple pipelines which run in sequence, and one pipeline which runs independently of the others.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing

./state

This program creates a very simple pipeline which demonstrates setting and getting all different kinds of arguments from the state, including files, directories, strings, integers, and floating points.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing

./custom-client

This program creates a very simple pipeline but with a new custom client available.

Use the -client=my-custom-client to run the pipeline with the custom client.

Features

  • Background steps
  • Caching
  • Registering a new client
  • Environment Variables
  • Event filters / triggers
  • Event variables
  • Logging
  • Multiple pipelines
  • Running pipelines in sequence
  • Running pipelines in parallel
  • Running steps in sequence
  • Running steps in parallel
  • Running steps with the default ENTRYPOINT / CMD
  • Secrets
  • Sub-pipelines
  • Step Arguments
  • State Management / Sharing data between steps
  • Tracing