Skip to content

Commit db55e92

Browse files
nfrunzanekia
nfrunza
authored and
nekia
committed
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 <[email protected]> * 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 <[email protected]> * BE-702 fixed lgth.yml syntax Signed-off-by: nfrunza <[email protected]> * BE-702 Exclude test files Signed-off-by: nfrunza <[email protected]> * BE-702 Syntax fix Signed-off-by: nfrunza <[email protected]> * BE-702 Exclude test files Signed-off-by: nfrunza <[email protected]> * BE-702 Exclude test files Signed-off-by: nfrunza <[email protected]>
1 parent 621a12a commit db55e92

15 files changed

+118
-15
lines changed

‎CONTRIBUTING.md

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

‎client/package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎client/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "hyperledger-explorer-client",
3-
"version": "0.3.9",
3+
"version": "1.0.0-rc1",
44
"private": true,
55
"license": "Apache-2.0",
66
"dependencies": {

‎client/src/FabricVersion.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// SPDX-License-Identifier: Apache-2.0
22
// add new version of fabric here
3-
const Version = ['v1.4'];
3+
const Version = ['v1.4.x'];
44

55
export default Version;

‎docs/source/CONTRIBUTING.rst

+1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Related Topics
106106
MAINTAINERS
107107
dev-setup/devenv
108108
dev-setup/build
109+
dev-setup/azure
109110
Style-guides/js-style
110111

111112

‎docs/source/_static/images/azure_code_coverage.png

398 KB
Loading

‎docs/source/_static/images/azure_code_coverage_single_file.png

462 KB
Loading

‎docs/source/_static/images/azure_hlexplorer.png

247 KB
Loading

‎docs/source/_static/images/azure_jobs.png

313 KB
Loading

‎docs/source/_static/images/azure_runs.png

274 KB
Loading

‎docs/source/dev-setup/azure.html

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!-- SPDX-License-Identifier: Apache-2.0 -->
2+
3+
<!DOCTYPE html>
4+
<html>
5+
6+
<head>
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<link rel="stylesheet" href="../_static/css/styles.css">
9+
</head>
10+
11+
<body>
12+
13+
<p>
14+
Below screen displays the <a
15+
href="https://dev.azure.com/Hyperledger/blockchain-explorer/_build">Hyperledger(Blockchain)
16+
Explorer pipeline.<a>
17+
</p>
18+
<div class="container">
19+
<input type="checkbox" id="azure_hlexplorer">
20+
<label for="azure_hlexplorer">
21+
<img src="../_static/images/azure_hlexplorer.png">
22+
</label>
23+
</div>
24+
</p>
25+
26+
<p>A sample list of the run shown below can be accesses by navigating to this <a
27+
href="https://dev.azure.com/Hyperledger/blockchain-explorer/_build?definitionId=41&_a=summary">link</a>.
28+
</p>
29+
<div class="container">
30+
<input type="checkbox" id="azure_runs">
31+
<label for="azure_runs">
32+
<img src="../_static/images/azure_runs.png">
33+
</label>
34+
</div>
35+
</p>
36+
37+
<p>Each run has a set of jobs, and can be viewed by clicking on job name. The duration, and the status are displayed
38+
next to each job.</p>
39+
<div class="container">
40+
<input type="checkbox" id="azure_jobs">
41+
<label for="azure_jobs">
42+
<img src="../_static/images/azure_jobs.png">
43+
</label>
44+
</div>
45+
</p>
46+
47+
<p>Code coverage is available for each run, and can be accessed by clicking on the tab next to Summary.</p>
48+
<div class="container">
49+
<input type="checkbox" id="azure_code_coverage">
50+
<label for="azure_code_coverage">
51+
<img src="../_static/images/azure_code_coverage.png">
52+
</label>
53+
</div>
54+
</p>
55+
56+
<p>Preview code coverage for a selected file can be accessed by clicking on file name.</p>
57+
<div class="container">
58+
<input type="checkbox" id="azure_code_coverage_single_file">
59+
<label for="azure_code_coverage_single_file">
60+
<img src="../_static/images/azure_code_coverage_single_file.png">
61+
</label>
62+
</div>
63+
</p>
64+
65+
66+
67+
</body>
68+
69+
</html>

‎docs/source/dev-setup/azure.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
5+
Azure DevOps
6+
-------------
7+
8+
Hyperledger Explorer uses `Azure DevOps <https://azure.microsoft.com/en-us/services/devops/>`__ to automate the builds, run tests, and code coverage.
9+
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>`__.
10+
11+
12+
.. raw:: html
13+
:file: ./azure.html

‎docs/source/dev-setup/build.rst

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ To build Hyperledger Explorer:
1414

1515
cd blockchain-explorer
1616
git checkout <branch-name>
17+
./main.sh clean
1718
./main.sh install
1819

1920
.. note::
@@ -30,6 +31,7 @@ Use the following sequence to run all unit tests
3031
::
3132

3233
cd blockchain-explorer
34+
./main.sh clean
3335
./main.sh install
3436
./main.sh test
3537

‎docs/source/dev-setup/github_setup.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
<head>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<link rel="stylesheet" href="./_static/css/styles.css">
7+
<link rel="stylesheet" href="../_static/css/styles.css">
88
</head>
99

1010
<body>
1111
<p>Clone the project</p>
1212
<div class="container">
1313
<input type="checkbox" id="GitCloneCmd">
1414
<label for="GitCloneCmd">
15-
<img src="./_static/images/GitCloneCmd.png">
15+
<img src="../_static/images/GitCloneCmd.png">
1616
</label>
1717
</div>
1818
<br>

‎lgtm.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
path_classifiers:
5+
docs:
6+
- '**/*.md'
7+
test:
8+
- '**/test/**/*.js'
9+
third_party:
10+
- 'third_party/**/*.*'
11+
externs:
12+
- '**/*.extern.js'
13+
extraction:
14+
javascript:
15+
index:
16+
exclude: e2e-test
17+
queries:
18+
exclude: js/unused-local-variable

0 commit comments

Comments
 (0)