0.1.0

- updates doc page
- UI pipelines are now svgs
- allows nested pipelines
- extends pipelines UI to show nested flows

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["react", "es2015"]
+}

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.0 (08/24/2017)
+
+- updates doc page
+- UI pipelines are now svgs
+- allows nested pipelines
+- extends pipelines UI to show nested flows
+
 # 0.0.1 (08/22/2017)
 
 - basic functionality

README.md

@@ -38,10 +38,12 @@ pipeline:
   install:
     - npm --version
     - node --version
-    - npm install
+    - npm:
+      - npm install
+      - ls -lh node_modules
   lint:
     - npm run lint
-  build:
+  coverage:
     - npm run coverage
   test:
     - npm test
@@ -51,7 +53,7 @@ pipeline:
 
 Will yield the following results:
 
-![example.png](./docs/example.png)
+![success.png](./docs/success.png)
 
 Sometimes things go as planned and certain build phases will fail and that will yield:
 

TODO.md

@@ -1,3 +1,4 @@
 - [ ] capture any changes that weren't committed to git
 - [ ] document and test using build.sh as a module
 - [ ] capture the build pipeline config if it exists (display this under a tab named Config)
+- [ ] add react-storybook stories to show use cases

bin/build.js

@@ -9,9 +9,9 @@ const ora = require('ora');
 const open = require('opn');
 const ms = require('ms');
 
-const Git = require('../src/git');
-const Compile = require('../src/compile');
-const Pipeline = require('../src/pipeline');
+const Git = require('../util/git');
+const Compile = require('../util/compile');
+const Pipeline = require('../util/pipeline');
 
 program
   .version(require('../package.json').version)
@@ -45,12 +45,31 @@ try {
   });
 
   events.on('end', (results) => {
+
     spinner.text = 'Capturing git information';
 
     Git()
       .then((info) => {
         spinner.text = 'Compiling report';
 
+        fs.writeFileSync('build.json', JSON.stringify({
+          git: info,
+          name: pkg.name,
+          description: pkg.description,
+          source: pkg.repository.url,
+          process: {
+            versions: process.versions,
+            env: process.env,
+            arch: process.arch,
+            platform: process.platform,
+            release: process.release,
+            version: process.version,
+            features: process.features,
+            config: process.config
+          },
+          pipeline: results
+        }, null, 4));
+
         Compile({
           config: {
             git: info,
@@ -70,7 +89,10 @@ try {
             pipeline: results
           },
           output: path.resolve(output) || process.cwd() + '/build'
-        }, () => {
+        }, (error) => {
+          if(error) {
+            return spinner.fail(`Compile has failed with the following error:\n${error}`);
+          }
           const reportLocation = path.resolve((path.resolve(output) || process.cwd() + '/build'), 'index.html');
           const end = process.hrtime(start);
           spinner.succeed(`Report compiled [${ms(((end[0] * 1e9) + end[1]) / 1e6)}]\nLocated at ${reportLocation}`);

build.yml

@@ -1,12 +1,14 @@
-output: ./docs
+output: ./docs/example
 pipeline:
   install:
     - npm --version
     - node --version
-    - npm install
+    - npm:
+      - npm install
+      - ls -lh node_modules
   lint:
     - npm run lint
-  build:
+  coverage:
     - npm run coverage
   test:
     - npm test

docs/code/git.js.html

@@ -22,7 +22,7 @@
 <label for="nav-trigger" class="overlay"></label>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-src_git.html">src/git</a><ul class='methods'><li data-type='method'><a href="module-src_git.html#~git">git</a></li></ul></li><li><a href="module-src_pipeline.html">src/pipeline</a><ul class='methods'><li data-type='method'><a href="module-src_pipeline.html#~pipeline">pipeline</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-util_git.html">util/git</a><ul class='methods'><li data-type='method'><a href="module-util_git.html#~git">git</a></li></ul></li><li><a href="module-util_pipeline.html">util/pipeline</a><ul class='methods'><li data-type='method'><a href="module-util_pipeline.html#~pipeline">pipeline</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -38,7 +38,7 @@ <h1 class="page-title">git.js</h1>
     <section>
         <article>
             <pre class="prettyprint source linenums"><code>/**
- * @module src/git
+ * @module util/git
  */
 
 const { exec } = require('child_process');
@@ -139,7 +139,7 @@ <h1 class="page-title">git.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Tue Aug 22 2017 00:33:11 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Thu Aug 24 2017 22:06:19 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/code/index.html

@@ -22,7 +22,7 @@
 <label for="nav-trigger" class="overlay"></label>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-src_git.html">src/git</a><ul class='methods'><li data-type='method'><a href="module-src_git.html#~git">git</a></li></ul></li><li><a href="module-src_pipeline.html">src/pipeline</a><ul class='methods'><li data-type='method'><a href="module-src_pipeline.html#~pipeline">pipeline</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-util_git.html">util/git</a><ul class='methods'><li data-type='method'><a href="module-util_git.html#~git">git</a></li></ul></li><li><a href="module-util_pipeline.html">util/pipeline</a><ul class='methods'><li data-type='method'><a href="module-util_pipeline.html#~pipeline">pipeline</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -49,6 +49,12 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sr
         <article><h1>build.sh</h1><blockquote>
 <p>🔨 run and visualize the build process</p>
 </blockquote>
+<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+<ul>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#usage">Usage</a></li>
+</ul>
+<!-- /TOC -->
 <h2>Installation</h2><pre class="prettyprint source"><code>npm install build.sh -g</code></pre><h2>Usage</h2><blockquote>
 <p>commit a <code>build.yml</code> file to your project root</p>
 </blockquote>
@@ -74,7 +80,9 @@ <h2>Installation</h2><pre class="prettyprint source"><code>npm install build.sh
     - npm run generate-docs</code></pre><p>Will yield the following results:</p>
 <p><img src="./docs/example.png" alt="example.png"></p>
 <p>Sometimes things go as planned and certain build phases will fail and that will yield:</p>
-<p><img src="./docs/fail.png" alt="fail.png"></p></article>
+<p><img src="./docs/fail.png" alt="fail.png"></p>
+<p>An important factor when dealing with build pipelines is the persistence of environment variables and git information which is recorded and accessible via the <code>Information</code> tab:</p>
+<p><img src="./docs/information.png" alt="information.png"></p></article>
     </section>
 
 
@@ -87,7 +95,7 @@ <h2>Installation</h2><pre class="prettyprint source"><code>npm install build.sh
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Tue Aug 22 2017 00:33:11 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Thu Aug 24 2017 22:06:19 GMT-0700 (PDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>