BE-702 Update documents, azure (#60)

* BE-702 Update documents, azure

* BE-711 add quality metrics
* Updated fabric, and explorer version

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 Update documents, azure

* Excluded .js test files from quality metrics
* BE-711 add quality metrics
* Updated fabric, and explorer version

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 fixed lgth.yml syntax

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 Exclude test files

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 Syntax fix

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 Exclude test files

Signed-off-by: nfrunza <nfrunza@gmail.com>

* BE-702 Exclude test files

Signed-off-by: nfrunza <nfrunza@gmail.com>

CONTRIBUTING.md

@@ -37,26 +37,26 @@ yourself, then you can submit a change request (PR), please follow guidance prov
 1. **Clone your fork** to your computer.
 1. **Create a topic branch** and name it appropriately.
 Starting the branch name with the issue number is a good practice and a reminder to fix only one issue in a
-Pull-Request (PR)._
+Pull-Request (PR).
 1. **Make your changes** adhering to the coding conventions described below.
-_In general a commit serves a single purpose and diffs should be easily comprehensible.
-For this reason do not mix any formatting fixes or code moves with actual code changes._
+In general a commit serves a single purpose and diffs should be easily comprehensible.
+For this reason do not mix any formatting fixes or code moves with actual code changes.
 1. **Commit your changes** see [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) article by Chris Beams.
 1. **Test your changes** locally before pushing to ensure that what you are proposing is not breaking
 another part of the software.
-Running the ```./main.sh clean && ./main.sh install && ./main.sh test``` command locally will help you to be confident that your changes will
+Running the ```  ./main.sh clean && ./main.sh install && ./main.sh test ``` command locally will help you to be confident that your changes will
 pass CI tests once pushed as a Pull Request.
 1. **Push your changes** to your remote fork.
 1. **Create a pull-request** (PR) on the Hyperledger Explorer repository. If the PR addresses an existing Jira issue,
-include the issue number in the PR title in square brackets (for example, `[BE-333]`).
-1. **Add labels** to identify the type of your PR. _For example, if your PR is not ready to validate,
-add the "work-in-progress" label. If it fixes a bug, add the "bug" label._
+include the issue number in the PR title in square brackets (for example, `BE-333`).
+1. **Add labels** to identify the type of your PR. For example, if your PR is not ready to validate,
+add the "work-in-progress" label. If it fixes a bug, add the "bug" label.
 1. If the PR address an existing Jira issue, comment in the Jira issue with the PR number.
 1. **Ensure your changes are reviewed**.
-_Select the reviewers you would like to review your PR.
-If you don't know who to choose, simply select the reviewers proposed by GitHub or leave blank._
+Select the reviewers you would like to review your PR.
+If you don't know who to choose, simply select the reviewers proposed by GitHub or leave blank.
 1. **Make any required changes** on your contribution from the reviewers feedback.
-_Make the changes, commit to your branch, and push to your remote fork._
+Make the changes, commit to your branch, and push to your remote fork.
 1. **When your PR is validated**, all tests passed and your branch has no conflicts with the target branch,
 you can **"squash and merge"** your PR and you're done.
 

client/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hyperledger-explorer-client",
-	"version": "0.3.9",
+	"version": "1.0.0-rc1",
 	"private": true,
 	"license": "Apache-2.0",
 	"dependencies": {

client/src/FabricVersion.js

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
 // add new version of fabric here
-const Version = ['v1.4'];
+const Version = ['v1.4.x'];
 
 export default Version;

docs/source/CONTRIBUTING.rst

@@ -106,6 +106,7 @@ Related Topics
    MAINTAINERS
    dev-setup/devenv
    dev-setup/build
+   dev-setup/azure
    Style-guides/js-style
 
 

docs/source/dev-setup/azure.html

@@ -0,0 +1,69 @@
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<!DOCTYPE html>
+<html>
+
+<head>
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../_static/css/styles.css">
+</head>
+
+<body>
+
+	<p>
+		Below screen displays the <a
+			href="https://dev.azure.com/Hyperledger/blockchain-explorer/_build">Hyperledger(Blockchain)
+			Explorer pipeline.<a>
+	</p>
+	<div class="container">
+		<input type="checkbox" id="azure_hlexplorer">
+		<label for="azure_hlexplorer">
+			<img src="../_static/images/azure_hlexplorer.png">
+		</label>
+	</div>
+	</p>
+
+	<p>A sample list of the run shown below can be accesses by navigating to this <a
+			href="https://dev.azure.com/Hyperledger/blockchain-explorer/_build?definitionId=41&_a=summary">link</a>.
+	</p>
+	<div class="container">
+		<input type="checkbox" id="azure_runs">
+		<label for="azure_runs">
+			<img src="../_static/images/azure_runs.png">
+		</label>
+	</div>
+	</p>
+
+	<p>Each run has a set of jobs, and can be viewed by clicking on job name. The duration, and the status are displayed
+		next to each job.</p>
+	<div class="container">
+		<input type="checkbox" id="azure_jobs">
+		<label for="azure_jobs">
+			<img src="../_static/images/azure_jobs.png">
+		</label>
+	</div>
+	</p>
+
+	<p>Code coverage is available for each run, and can be accessed by clicking on the tab next to Summary.</p>
+	<div class="container">
+		<input type="checkbox" id="azure_code_coverage">
+		<label for="azure_code_coverage">
+			<img src="../_static/images/azure_code_coverage.png">
+		</label>
+	</div>
+	</p>
+
+	<p>Preview code coverage for a selected file can be accessed by clicking on file name.</p>
+	<div class="container">
+		<input type="checkbox" id="azure_code_coverage_single_file">
+		<label for="azure_code_coverage_single_file">
+			<img src="../_static/images/azure_code_coverage_single_file.png">
+		</label>
+	</div>
+	</p>
+
+
+
+</body>
+
+</html>

docs/source/dev-setup/azure.rst

@@ -0,0 +1,13 @@
+
+.. SPDX-License-Identifier: Apache-2.0
+
+
+Azure DevOps
+-------------
+
+Hyperledger Explorer uses `Azure DevOps <https://azure.microsoft.com/en-us/services/devops/>`__ to automate the builds, run tests, and code coverage.
+After the pull request is created an automated job will be triggered defined by the `Azure pipeline script <https://github.com/hyperledger/blockchain-explorer/blob/master/ci/azure-pipelines.yml>`__.
+
+
+.. raw:: html
+     :file: ./azure.html

docs/source/dev-setup/build.rst

@@ -14,6 +14,7 @@ To build Hyperledger Explorer:
 
     cd blockchain-explorer
     git checkout <branch-name>
+    ./main.sh clean
     ./main.sh install
 
 .. note::
@@ -30,6 +31,7 @@ Use the following sequence to run all unit tests
 ::
 
     cd blockchain-explorer
+    ./main.sh clean
     ./main.sh install
     ./main.sh test
 

docs/source/dev-setup/github_setup.html

@@ -4,15 +4,15 @@
 
 <head>
 	<meta name="viewport" content="width=device-width, initial-scale=1">
-	<link rel="stylesheet" href="./_static/css/styles.css">
+	<link rel="stylesheet" href="../_static/css/styles.css">
 </head>
 
 <body>
 	<p>Clone the project</p>
 	<div class="container">
 		<input type="checkbox" id="GitCloneCmd">
 		<label for="GitCloneCmd">
-			<img src="./_static/images/GitCloneCmd.png">
+			<img src="../_static/images/GitCloneCmd.png">
 		</label>
 	</div>
 	<br>

lgtm.yml

@@ -0,0 +1,18 @@
+
+# SPDX-License-Identifier: Apache-2.0
+
+path_classifiers:
+  docs:
+    - '**/*.md'
+  test:
+    - '**/test/**/*.js'
+  third_party:
+    - 'third_party/**/*.*'
+  externs:
+    - '**/*.extern.js'
+extraction:
+  javascript:
+    index:
+      exclude: e2e-test
+queries:
+  exclude: js/unused-local-variable