Giter VIP home page Giter VIP logo

build.sh's Introduction

build.sh

Build Status Dependency Status devDependency Status Coverage Status npm npm

๐Ÿ”จ run and visualize the build process

Installation

This module can be installed via npm, or for those who do not have node on their machines can use the packed binary found here which can downloaded to your computer and run as a executable.

npm install build.sh -g

Usage

Usage: build [options] <steps>


Options:

  -V, --version          output the version number
  -c, --config [file]    the input file for the build pipeline to run (default: /Users/gabrielcsapo/Documents/build.sh/build.yml)
  -d, --debug            outputs a debug file of the build process and data captured
  -o, --output [output]  set the output path for the build artifact
  -b, --browser          doesn't open browser
  -h, --help             output usage information

How To

commit a build.yml file to your project root

env:
  - {key}={value}
pipeline:
  {key}:
    - {command}
    - {command}

To invoke about the pipeline simply run build at the project root.

The terminal output will show the pipeline being run and eventually will open the browser to the location of the final report.

This build pipeline:

output: ./docs
env:
    - FOO=bar
pipeline:
  install:
    - npm --version
    - node --version
    - npm:
      - npm install
      - ls -lh node_modules
  lint:
    - npm run lint
  coverage:
    - npm run coverage
  test:
    - npm test
  docs:
    - npm run generate-docs

there is also the ability to run parts of pipeline by specifying which ones to run for example build lint,coverage,test will only run the nested npm install, lint, coverage and test scripts

subset.png

When running build with the above pipeline it will yield the following results:

success.png

Sometimes things go as planned and certain build phases will fail and that will yield:

fail.png

An important factor when dealing with build pipelines is the persistence of environment variables and git information which is recorded and accessible via the Environment tab:

environment.png

If the build report was ran and built using build.sh it will also record the yaml file that it ran with under the Config tab:

config.png

To view the raw build data simply navigate to the Report tab and you will get a view similar to this:

report.png

build.sh's People

Contributors

anusaini avatar gabrielcsapo avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.