Merge pull request #253 from energywebfoundation/feature/ICL-85_relea…

…se_notes

feature/ICL-85_release_notes

.releaserc.json

@@ -1,32 +1,41 @@
 {
-  "branches": [
-    {
-      "name": "master",
-      "channel": "latest"
-    },
-    {
-      "name": "develop",
-      "prerelease": "alpha",
-      "channel": "canary"
-    }
-  ],
-  "repositoryUrl": "git@github.com:energywebfoundation/iam-client-lib.git",
-  "plugins": [
-    ["@semantic-release/commit-analyzer", {
-      "preset": "angular",
-      "releaseRules": [
-        {"type": "docs", "release": "patch"},
-        {"type": "refactor", "release": "patch"},
-        {"type": "style", "release": "patch"},
-        {"type": "test", "release": "patch"},
-        {"type": "ci", "release": "patch"},
-        {"type": "build", "release": "patch"}
-      ],
-      "parserOpts": {
-        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
-      }
-    }],
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/npm"
-  ]
+    "branches": [
+        {
+            "name": "master",
+            "channel": "latest"
+        },
+        {
+            "name": "develop",
+            "prerelease": "alpha",
+            "channel": "canary"
+        }
+    ],
+    "repositoryUrl": "git@github.com:energywebfoundation/iam-client-lib.git",
+    "plugins": [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "preset": "angular",
+                "releaseRules": [
+                    { "type": "docs", "release": "patch" },
+                    { "type": "refactor", "release": "patch" },
+                    { "type": "style", "release": "patch" },
+                    { "type": "test", "release": "patch" },
+                    { "type": "ci", "release": "patch" },
+                    { "type": "build", "release": "patch" }
+                ],
+                "parserOpts": {
+                    "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+                }
+            }
+        ],
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "docs/CHANGELOG.md"
+            }
+        ],
+        "@semantic-release/npm"
+    ]
 }

mkdocs.yml

@@ -13,6 +13,7 @@ nav:
       - "Organization": guides/organization.md
       - "Role": guides/role.md
   - API: api/modules.md
+  - CHANGELOG: CHANGELOG.md
 theme: readthedocs
 
 docs_dir: docs

package.json

@@ -89,6 +89,7 @@
         "@babel/preset-env": "7.12.11",
         "@energyweb/km-crypto": "file:energyweb-km-crypto-v1.0.0.tgz",
         "@energyweb/km-utils": "file:energyweb-km-utils-v1.0.0.tgz",
+        "@semantic-release/changelog": "^5.0.1",
         "@typechain/ethers-v5": "^7.0.1",
         "@types/jest": "^26.0.13",
         "@types/lodash.difference": "^4.5.6",