GitXplorerGitXplorer
o

run-forrest-run

public
1 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
82b7f6c115ba4acdf9a2ec490c5a87df96fa2e2d

test node 9

oorangewise committed 7 years ago
Unverified
3b2cb501d2ad8a2d9be00f7e499983e91cf45a8c

0.0.17

oorangewise committed 7 years ago
Unverified
5c9e160cf5f526b027655c74d29f562c7271e046

update youtube time

oorangewise committed 7 years ago
Unverified
8e1e19fbeb475a2d41eebb05d916c420a575fbd2

add gif

oorangewise committed 7 years ago
Unverified
717ffbada91268ebfba48cdac73810dca6bd5dcb

0.0.16

oorangewise committed 7 years ago
Unverified
8ed7ac7ce7cdb4abc9c313d3078c7e82f10df9cd

support output_folder

oorangewise committed 7 years ago

README

The README file for this repository.

run-forrest-run

npm version Build Status Coverage Status JavaScript Style Guide

YAML config based script runner.

run-forrest-run

run-forrest-run should be 100% compatible with scriptz.

Installation

npm i -g run-forrest-run

Configuration

The configuration exists of flows and steps. We start of by defining a couple of options and the start flow.

options:
  retry_count: number     # (default: 0) Retry count if exit code > 0
  env: Object             # (default: {}) Additional environment variables
  output_folder: string   # (default: '') A folder for your logs
start:
  ...

The base options that are defined will be used for each step. All the environment variables from the base options will be used, if it is set. If it is also defined on the step level, then the object will be merged.

Flow configuration

# Required values
name: string                # Label
flow: string                # Type of flow 'sequential' or 'parallel'
steps: Array<Step>          # Step definitions

Step configuration

# Required values
name: string                # Label used to keep track of script
script: string              # Script location relative to where scriptz is being run
output_file: string         # Where to write logs, can be prefixed with an output_folder
arguments: Array<String>    # (default: []) Additional arguments
cwd: string                 # (default: process.cwd()) CWD of the script
env: Object                 # (default: {}) Additional environment variables
retry_count: number         # (default: 0) Retry count if exit code > 0

Examples

Example 1

Run 2 commands in parralel.

# example1.yaml
start:
  name: Main
  flow: parallel
  steps:
    - name: File listing
      script: ls
      arguments:
        - -lrt
    - name: Working directory
      script: pwd

Run this config:

$ run-forrest-run -c example1.yaml -v

Example 2

Run 3 steps in sequence, the steps itself run some commands in parralel.

# example2.yaml
start:
  name: Main
  flow: sequential
  steps:
    # the steps details are defined
    # at the bottom of this file
    - $ref: "#/cleanup"
    - $ref: "#/npm-install"
    - $ref: "#/clone"

cleanup:
  name: cleanup log directory
  script: ./cleanup.sh

npm-install:
  name: npm install
  flow: parallel
  steps:
    - name: install s3-zip
      script: npm
      arguments:
        - install
        - s3-zip
    - name: install s3-files
      script: npm
      arguments:
        - install
        - s3-files
    - name: install rotan
      script: npm
      arguments:
        - install
        - rotan

clone:
  name: clone
  flow: parallel
  steps:
    - name: git clone run-forrest-run
      script: git
      arguments:
        - clone
        - git@github.com:orangewise/run-forrest-run.git
      output_file: log/git-clone.log
    - name: git clone s3-zip
      script: git
      arguments:
        - clone
        - git@github.com:orangewise/s3-zip.git
      output_file: log/s3-zip.log

Run this config:

$ run-forrest-run -c example2.yaml -v