aws-cfm-utils - npm Package Compare versions

Comparing version 1.4.0 to 1.4.1

package.json

 {
   "name": "aws-cfm-utils",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "AWS utils to deploy cloudformation stack/templates",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -0,1 +1,4 @@
+# AWS CLOUDFORMATION UTILS
+## NPM module to create and/or update cloudformation stacks
+
 [![Coverage Status](https://codecov.io/gh/marcincuber/aws-cfm-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/marcincuber/aws-cfm-utils)
@@ -11,9 +14,28 @@ [![Build Status](https://travis-ci.org/marcincuber/aws-cfm-utils.svg?branch=master)](https://travis-ci.org/marcincuber/aws-cfm-utils)
 
+# Table of Contents
 
-# AWS CLOUDFORMATION UTILS
+* [Installation](#installation)
+* [Usage](#usage)
+* [CLI Options](#cli-options)
+    * [CLI Examples](#cli-examples)
+* [Parameter Options](#parameter-options)
+    * [Global Parameters](#global-parameters)
+    * [Create Stack Parameters](#create-stack-parameters)
+    * [Upadte Stack Parameters](#update-stack-parameters)
+    * [Additional Stack Parameters](#additional-stack-parameters)
+    * [AWS Credential Info](#credentials)
+* [Tests](#tests)
+    * [Unit Tests](#unit-tests)
+    * [Linting](#eslint)
+    * [Node Modules security](#nsp)
+    * [Coverage](#coverage)
+    * [Build Server](#build-server)
+    * [Software License Scanning](#license-scan)
+* [Requirements and Dependencies](#requirements-dependencies)
+    * [Dependencies](#prod-dependencies)
+    * [DevDependencies](#dev-dependencies)
+* [Contact](#contact)
 
-### NPM module to create/update cloudformation stacks
+## Installation <a name="installation"></a>
 
-## Installation
-
 ```
@@ -23,3 +45,3 @@ npm install -g aws-cfm-utils
 
-## Usage
+## Usage <a name="usage"></a>
 
@@ -34,3 +56,6 @@ ```
 
-    Options:
+## CLI Options <a name="cli-options"></a>
+
+```
+  Options:
     --stack-name                                               [string] [required]
@@ -41,3 +66,2 @@ --template-body                    CFM template file name             [string]
     --secretkey                        AWS secret key                     [string]
-    -h, --help                         Show help                         [boolean]
     --parameters                       CFM Parameters                      [array]
@@ -62,4 +86,6 @@ --tags                             CFM Tags                            [array]
     -v, --version                      Show version number               [boolean]
+    -h, --help                         Show help                         [boolean]
+```
 
-### Examples:
+### CLI Examples <a name="cli-examples"></a>
 
@@ -94,4 +120,6 @@ ```
 
-### Global parameters ([AWS CLI Docs](http://docs.aws.amazon.com/cli/latest/topic/config-vars.html#general-options)):
+## Parameter Options <a name="parameter-options"></a>
 
+### Global parameters ([AWS CLI Docs](http://docs.aws.amazon.com/cli/latest/topic/config-vars.html#general-options)): <a name="global-parameters"></a>
+
 ```
@@ -106,3 +134,3 @@ --accesskeyid
 
-### Used during creation of the stack, otherwise ignored ([create-stack](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/create-stack.html)):
+### Used during creation of the stack, otherwise ignored ([create-stack](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/create-stack.html)): <a name="create-stack-parameters"></a>
 
@@ -116,3 +144,3 @@ ```
 
-### Used during update of the stack, otherwise ignored ([update-stack](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/update-stack.html)):
+### Used during update of the stack, otherwise ignored ([update-stack](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/update-stack.html)): <a name="update-stack-parameters"></a>
 
@@ -125,3 +153,3 @@ ```
 
-### Addional Custom options for update-stack and create-stack 
+### Addional Custom options for update-stack, create-stack and delete-stack: <a name="additional-stack-parameters"></a>
 
@@ -153,5 +181,6 @@ In order to see all the `CloudFormation Stack Events` happening during update/create process. Use the following option;
 
-## Credential settings, General order of execution
+### Credential settings, General order of execution <a name="credentials"></a>
 
 The AWS CLI looks for credentials and configuration settings in the following order:
+
 1. Command line options – region, output format and profile can be specified as command options to override default settings.
@@ -164,4 +193,6 @@ 2. Environment variables – AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN.
 
-## Unit Tests
+## Tests etc. <a name="tests"></a>
 
+### Unit Tests <a name="unit-tests"></a>
+
 ```
@@ -172,3 +203,3 @@ npm run test
 
-## Eslint
+### Eslint <a name="eslint"></a>
 
@@ -179,4 +210,10 @@ ```
 
-## Coverage
+### Node Modules security <a name="nsp"></a>
 
+We use tool called `Snyk.io` to scan node moduless. [See Snyk.io](https://snyk.io/test/github/marcincuber/aws-cfm-utils?targetFile=package.json) 
+
+### Code Coverage <a name="coverage"></a>
+
+Locally execute:
+
 ```
@@ -186,7 +223,25 @@ npm run coverage
 
-## Requirements and Dependencies
+Otherwise, `Codecov` is used to publish coverage results. [See Codecov](https://codecov.io/gh/marcincuber/aws-cfm-utils).
 
+Codecov is uploading coverage tests to PRs directly compering it against master branch.
+
+### Build Server <a name="build-server"></a>
+
+Travis is used to build and test the npm module. [See Travis](https://travis-ci.org/marcincuber/aws-cfm-utils).
+
+Travis is currently building, testing and populating results of the tests. In the future it will be publishing NPM module on merge to master.
+
+### Software License Scanning <a name="license-scan"></a>
+
+We use `FOSSA` system which helps us manage components. It is used to perform dynamic & static build analysis on code to help understand the open source components and stay compliant with software licenses. It is providing feedback on every PR so that we can say up-to-date with new issues, if any.
+
+[See FOSSA Portal](https://app.fossa.io/projects/git%2Bgithub.com%2Fmarcincuber%2Faws-cfm-utils/refs/branch/master/bdf7145348b664c761c6a5c810dc984314a473c0)
+
+[License Status](#license-status)
+
+## Requirements and Dependencies <a name="requirements-dependencies"></a>
+
 1. NODE version >= 8.10
 
-## Dependencies
+### Dependencies <a name="prod-dependencies"></a>
 
@@ -200,9 +255,25 @@ 1. aws-sdk
 
-## Contacts
+[See Dependencies Status](https://david-dm.org/marcincuber/aws-cfm-utils)
 
+### DevDependencies <a name="dev-dependencies"></a>
+
+1. coveralls
+2. eslint
+3. eslint-config-standard
+4. eslint-plugin-import
+5. eslint-plugin-node
+6. eslint-plugin-promise
+7. eslint-plugin-standard
+8. istanbul
+9. mocha
+10. sinon
+
+[See DevDependencies Status](https://david-dm.org/marcincuber/aws-cfm-utils?type=dev)
+
+## Contact <a name="contact"></a>
+
 If you have any questions, drop me an email [e-mail] or open an issue and leave stars! :)
 
 
-
-## License
+## License Status <a name="license-status"></a>
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmarcincuber%2Faws-cfm-utils.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmarcincuber%2Faws-cfm-utils?ref=badge_large)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

84878

increased by3.85%

Number of lines in readme file

264

increased by36.79%

No dependency changes