Merge pull request codefresh-io#5 from ziv-codefresh/Release-to-NPM

release to npm

Author: alexei-led

stable/relese-to-NPM/NOTES.md

@@ -0,0 +1,61 @@
+# Codefresh release-to-npm Plugin
+
+The release-to-npm can be used to publish images to npm. 
+
+## Usage
+
+Set required and optional environment variable and add the following step to your Codefresh pipeline:
+
+```yaml
+---
+version: '1.0'
+
+steps:
+
+  ...
+
+     deploy_to_npm:  
+      title: Publishing To Npm 
+      image: codefresh/release-to-npm
+      commands:
+      - NPM_TOKEN=${{NPM_TOKEN}} npm run release-to-npm 
+  ...
+
+```
+
+## Environment Variables
+
+- **required** `NPM_TOKEN` - token of npm account
+
+## How to use
+
+- Add as a dependency to your project `npm install --save-dev release-to-npm`
+
+- Login into your project's NPM registry
+
+```
+npm login --registry <registry url>
+npm login --registry http://registry.npmjs.org
+```
+
+- Copy the token
+
+see how to extracting the NPM_TOKEN https://docs.npmjs.com/private-modules/ci-server-config#getting-an-authentication-token
+
+- Set the token as environment variable
+
+- Add script command
+
+Create a script command to run the release-to-npm, in your `package.json`
+
+```json
+{
+    "scripts": {
+        "release-to-npm": "release-to-npm"
+    }
+}
+```
+
+
+
+

stable/relese-to-NPM/README.md

@@ -0,0 +1,14 @@
+version: '1.0'
+steps:
+  BuildingDockerImage:
+    title: Building Docker Image
+    type: build
+    image_name: zivcodefresh/npmtest
+    working_directory: ./
+    dockerfile: Dockerfile
+    tag: '${{CF_BRANCH_TAG_NORMALIZED}}'
+  deploy_to_npm:  
+    title: Publishing To Npm 
+    image: codefresh/release-to-npm
+    commands:
+    - NPM_TOKEN=${{NPM_TOKEN}} npm run release-to-npm