fix(dependencies): upgrade all dependencies

Dimitri Kopriwa · Dimitri Kopriwa · commit 701ffe4015ff · 2019-03-11T07:50:31.000+07:00
diff --git a/docs/branches.md b/docs/branches.md
@@ -0,0 +1,2 @@
+1. `master` is used to release the version. 
+1. `master` only accept merge requests from `dev`
diff --git a/docs/commands.md b/docs/commands.md
@@ -57,9 +57,3 @@ Build documentation in `/public` directory:
 ```bash
 $ npm run styleguide:build
 ```
-
-Build the JSdoc documentation
-
-```bash
-$ npm run jsdoc
-```
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -0,0 +1,11 @@
+You can pass the version you want to deploy to the script:
+
+```bash
+$ npx $PACKAGE_NAME --target-version ${releaseVersion}
+```
+
+You can tell the script to use `yarn` for installation:
+
+```bash
+$ npx $PACKAGE_NAME --yarn
+```
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,31 @@
+@yeutech/rollup-umd-ci-deploy contain the job deploy stage for all rollup-umd project.
+
+You can run the deploy stage by doing:
+
+```bash
+$ npx $PACKAGE_NAME
+```
+
+It should be installed as a `devDependencies` so we can follow the version used by the rollup-umd project.
+
+It is also automatically removed if the package goes public.
+
+To use it, just use the script within your `.gitlab-ci.yml`:
+
+
+```yml
+# Pages
+pages:
+  stage: deploy
+  script:
+    - npx $PACKAGE_NAME
+  artifacts:
+    paths:
+    - public
+  only:
+    - tags
+  tags:
+    - docker
+```
+
+If it exist, it will call `styleguide/prepare.sh` within your project to do build operation of your documentation.
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,3 +1,3 @@
 ```bash
-$ npm install @yeutech/rollup-umd --save
+$ npm install $PACKAGE_NAME --save-dev
 ```
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,8 +1,10 @@
-[![Build Status](https://travis-ci.org/rollup-umd/deploy.svg?branch=master)](https://travis-ci.org/rollup-umd/deploy)
-[![npm Version](https://img.shields.io/npm/v/@rollup-umd/deploy.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/deploy)
-[![License](https://img.shields.io/npm/l/@rollup-umd/deploy.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/deploy)
-[![npm Version](https://img.shields.io/node/v/@rollup-umd/deploy.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/deploy)
-[![Module formats](https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20esm-green.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/deploy)
+[![build status](/badges/$PACKAGE_VERSION/build.svg)](/commits/$PACKAGE_VERSION)
+[![coverage report](/badges/$PACKAGE_VERSION/coverage.svg)](/commits/$PACKAGE_VERSION)
 
+![image](https://img.shields.io/badge/version-$PACKAGE_VERSION-green.svg)
+![image](https://img.shields.io/badge/node-$NODE_VERSION-brightgreen.svg)
+![image](https://img.shields.io/badge/npm-$NPM_VERSION-red.svg)
+![image](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+![image](https://img.shields.io/badge/publishing-private-red.svg)
 
-$PACKAGE_DESCRIPTION
+$PACKAGE_DESCRIPTION.
diff --git a/docs/js/jsdoc.md b/docs/js/jsdoc.md
diff --git a/docs/prerequisite.md b/docs/prerequisite.md
diff --git a/docs/ui.md b/docs/ui.md
diff --git a/src/deploy.sh b/src/deploy.sh
@@ -14,36 +14,36 @@ installer=npm
 targetVersion=
 
 while :; do
-    case $1 in
-        -y|--yarn)
-            installer=yarn
-            ;;
-        -t|--target-version)       # Takes an option argument; ensure it has been specified.
-            if [ "$2" ]; then
-                targetVersion=$2
-                shift
-            else
-                die 'ERROR: "--target-version" requires a non-empty option argument.'
-            fi
-            ;;
-        --target-version=?*)
-            targetVersion=${1#*=} # Delete everything up to "=" and assign the remainder.
-            ;;
-        --target-version=)         # Handle the case of an empty --target-version=
-            die 'ERROR: "--target-version" requires a non-empty option argument.'
-            ;;
-        --)              # End of all options.
-            shift
-            break
-            ;;
-        -?*)
-            printf 'WARN: Unknown option (ignored): %s\n' "$1" >&2
-            ;;
-        *)               # Default case: No more options, so break out of the loop.
-            break
-    esac
+  case $1 in
+    -y|--yarn)
+      installer=yarn
+      ;;
+    -t|--target-version)       # Takes an option argument; ensure it has been specified.
+      if [ "$2" ]; then
+        targetVersion=$2
+        shift
+      else
+        die 'ERROR: "--target-version" requires a non-empty option argument.'
+      fi
+      ;;
+    --target-version=?*)
+      targetVersion=${1#*=} # Delete everything up to "=" and assign the remainder.
+      ;;
+    --target-version=)         # Handle the case of an empty --target-version=
+      die 'ERROR: "--target-version" requires a non-empty option argument.'
+      ;;
+    --)              # End of all options.
+      shift
+      break
+      ;;
+    -?*)
+      printf 'WARN: Unknown option (ignored): %s\n' "$1" >&2
+      ;;
+    *)               # Default case: No more options, so break out of the loop.
+      break
+  esac
 
-    shift
+  shift
 done
 
 
diff --git a/styleguide/jsdoc.sh b/styleguide/jsdoc.sh
@@ -6,6 +6,6 @@ set -e
 ## JSdoc function must be annotated @public for being exported in the markdown
 
 ## 1. Uncomment this line to generate the full docs
-npm run jsdoc-documentation 'src/**/*.js' docs/js/jsdoc.md
+#npm run jsdoc-documentation 'src/**/*.js' docs/js/jsdoc.md
 ## 2. Add in styleguide/styleguide.ext.json the section { "name": "JSdoc", "content": "docs/js/jsdoc.md" }
 
diff --git a/styleguide/styleguide.ext.json b/styleguide/styleguide.ext.json
@@ -11,27 +11,20 @@
       "content": "docs/introduction.md"
     },
     {
-      "name": "Prerequisite",
-      "content": "docs/prerequisite.md"
+      "name": "Installation",
+      "content": "docs/installation.md"
     },
     {
       "name": "Getting started",
-      "content": "docs/getting-started.md",
-      "sections": [
-        {
-          "name": "Installation",
-          "content": "docs/installation.md"
-        },
-        {
-          "name": "Configuration",
-          "content": "docs/configuration.md"
-        }
-      ]
+      "content": "docs/getting-started.md"
+    },
+    {
+      "name": "CLI commands",
+      "sections": []
     },
     {
-      "name": "JSdoc",
-      "description": "This part is generated from the JSdoc annotations in the source code.",
-      "content": "docs/js/jsdoc.md"
+      "name": "Configuration",
+      "content": "docs/configuration.md"
     },
     {
       "name": "FAQ",
@@ -45,23 +38,19 @@
           "name": "Commands",
           "content": "docs/commands.md"
         },
+        {
+          "name": "Branches",
+          "content": "docs/branches.md"
+        },
         {
           "name": "Release",
           "content": "docs/release.md"
         }
       ]
-    },
-    {
-      "name": "Changelog",
-      "content": "CHANGELOG.md"
-    },
-    {
-      "name": "Code of conduct",
-      "content": "CODE_OF_CONDUCT.md"
     }
   ],
   "ribbon": {
     "url": "https://github.com/rollup-umd/deploy",
     "text": "Fork us on GitHub"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+1. `master` is used to release the version.
	`2`	+1. `master` only accept merge requests from `dev`
-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 ```bash
 -$ npm install @yeutech/rollup-umd --save
 +$ npm install $PACKAGE_NAME --save-dev
 ```