update: 2.0.4 ink ui prototype (#85)

* feat: ink ui template with commands (#74) * feat: handle select input and change terminal display (#76) Co-authored-by: yuching.lin <yuching.lin@rootilabs.com> * feat: select and excute command (#77) * feat: genesis.json model (#80) * fix: quorum consensus and explorer (#78) 1. upgrade quorumengineering/quorum to version 23.4.0 2. add quorum explorer support member nodes (only in same machine) * refactor: clean old fabric yaml model * refactor: genesisJson to bdkYaml model * feat: add bdk wallet create function (#81) * fix: explorer indexer error (#82) * fix: upgrade action (#84) * refactor: upgrade action version * feat: codeQL static analytic * feat: delete sonarqube and add new action * doc: 2.0.4 documents (#83) * feat: 2.0.4 document * feat: add notice in README.md * docs: add new issue template * feat: edit new README.md * docs: update pr template --------- Co-authored-by: yuching0u7 <99190569+yuching0u7@users.noreply.github.com> Co-authored-by: yuching.lin <yuching.lin@rootilabs.com> Co-authored-by: PianoChicken <pianochicken1996@gmail.com>
cathayddt · Sep 27, 2023 · 5f5d3ff · 5f5d3ff
1 parent 3f7549e
commit 5f5d3ff
Show file tree

Hide file tree

Showing 51 changed files with 4,699 additions and 3,024 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -1,8 +1,22 @@
 {
   "extends": [
+    "plugin:react/recommended",
     "./node_modules/ericlint"
   ],
+  "rules": {
+    "react/jsx-uses-react": "error",
+    "react/jsx-uses-vars": "error",
+    "react/react-in-jsx-scope": "error"
+  },
   "parserOptions": {
     "project": "tsconfig.eslint.json"
+  },
+  "plugins": [
+    "react"
+  ],
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
   }
 }
diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md
@@ -0,0 +1,57 @@
+### Git Commit Rule
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+Git commits should adhere to the following rule to automatically generate changelogs:
+
+```
+# Follow the Angular commit conventional format
+/^(revert: )?(feat|fix|docs|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
+```
+
+We utilize three tags to simplify the rules:
+
+- `feat:` for new features
+- `fix:` for bug fixes
+- `doc:` for documentation changes.
+
+### Git Flow (Branch Rule)
+
+```mermaid
+%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': "main" }} }%%
+gitGraph
+    commit
+    commit tag: "v1.0.0"
+    branch "develop(gitlab)"
+    checkout "develop(gitlab)"
+    branch version
+    checkout version
+    branch feat/featureExample
+    checkout feat/featureExample
+    commit
+    commit
+    checkout version
+    merge feat/featureExample
+    branch fix/fixExample
+    checkout fix/fixExample
+    commit
+    commit
+    checkout version
+    merge fix/fixExample
+    branch docs/docsExample
+    checkout docs/docsExample
+    commit
+    commit
+    checkout version
+    merge docs/docsExample
+    checkout "main"
+    merge version tag: "v1.0.1"
+		commit
+```
+
+- `feat/<yourBranchName>` ：develop new feature
+- `fix/<yourBranchName>`：edit old feature
+- `docs/<yourBranchName>` ：add docs or example
+- `<version>` : the version before release ex. 2.0.0
+- `develop` ：only for gitlab branch, for rebase github master branch. Not exist in github develop flow
+- `master` ：github main branch, only update by merge request
diff --git a/CONTRIBUTING.md → .github/CONTRIBUTING.md b/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/1.bug-report.yml b/.github/ISSUE_TEMPLATE/1.bug-report.yml
@@ -0,0 +1,81 @@
+name: 🐛 Bug Report
+description: Report a bug in bdk
+labels: ['type:bug', 'priority:high']
+assignees: 'kidneyweakx'
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template is for the unexpected errors or bugs in bdk. If you have a question, please ask in questions section in issues.
+
+  - type: dropdown
+    attributes:
+      label: 影響範圍 Which area(s) are affected? (Select all that apply)
+      multiple: true
+      options:
+        - 'Not sure'
+        - 'Fabric'
+        - 'Fabric-CA'
+        - 'Fabric-Chaincode'
+        - 'Fabric-Explorer'
+        - 'Quorum'
+        - 'Quorum-Remote'
+        - 'Quorum-Explorer'
+        - 'Docker'
+        - 'Dockerode'
+        - 'Node.js'
+        - 'Workflows(CI/CD)'
+
+  - type: textarea
+    attributes:
+      label: 測試環境 Provide environment information
+      description: Please list your operating system, Node.js version, npm version, 
+      render: bash
+      placeholder: |
+        BDK:
+          Version: 2.0.4
+        Operating System:
+          Platform: macOS
+          Arch: arm64
+          Version: Darwin Kernel Version 22.5.0
+        Binaries:
+          Node: 16.13.2
+          npm: 9.5.1
+        Docker:
+          client: 24.0.5
+          compose: 2.20.2-desktop.1
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: 重現步驟 To Reproduce
+      description: A step-by-step description of how to reproduce the issue, based on the linked reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+      placeholder: |
+        1. Start quorum node
+        2. Start quorum explorer
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: 應呈現結果 Expected Behavior
+      description: Please describe the behavior expected.
+      placeholder: |
+        Should open a explorer in browser
+
+  - type: textarea
+    attributes:
+      label: 實際呈現結果 Resulted Behavior
+      description: Please describe the behavior that actually occurred.
+      placeholder: |
+         explorer not open in browser
+
+  - type: checkboxes
+    attributes:
+      label: 驗證版本 Verify bdk release
+      description: 'Please run `bdk --version` besure you are using the latest version.'
+      options:
+        - label: I verified that my version is the stable release or 1.0.4
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/2.docs-error.yml b/.github/ISSUE_TEMPLATE/2.docs-error.yml
@@ -0,0 +1,34 @@
+name: 📃 Docs Improvement
+description: Docs error in bdk
+labels: ['type:docs', 'priority:low']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template is for the docs/example error in bdk. If you have a question, please ask in questions section in issues.
+
+  - type: markdown
+    attributes:
+      value: Thank you for helping us improve the docs!
+
+  - type: textarea
+    attributes:
+      label: What is the improvement or update you wish to see?
+      description: 'Example: I would like to see more examples of how to use quorum node.'
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Is there more context that might help us understand?
+      description: A clear description about the suggestion.
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Does the docs page already exist? Please link to it.
+      description: 'Example: https://github.com/cathayddt/bdk/wiki/link'
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/3.feature-request.yml b/.github/ISSUE_TEMPLATE/3.feature-request.yml
@@ -0,0 +1,29 @@
+name: 🛠️ Feature Request
+description: Request a feature in bdk
+labels: ['type:feature', 'priority:medium']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template is for feature requests in bdk. If you have a question, please ask in questions section in issues.
+
+  - type: textarea
+    attributes:
+      label: What is the problem that you are trying to solve?
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: 新功能 Feature Request
+      description: Reason for this Feature
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: 可能的解法 Proposed Solution
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/4.question.yml b/.github/ISSUE_TEMPLATE/4.question.yml
@@ -0,0 +1,16 @@
+name: ❓ Question
+description: Ask a question in bdk
+labels: ['type:question', 'priority:low']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template is for questions in bdk. Feel free to ask any questions about bdk.
+
+  - type: textarea
+    attributes:
+      label: What is the question?
+      description: A clear and concise description of what the question is.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,15 +1,23 @@
 # PULL REQUEST
 
+## Before 
+<!-- Please check the one that applies to this PR using "x". -->
+- [ ] 遵守 Commit 規範 (follow [commit convention](https://github.com/cathayddt/bdk/blob/master/.github/COMMIT_CONVENTION.md))
+- [ ] 遵守 Contributing 規範 (follow [contributing](https://github.com/cathayddt/bdk/blob/master/.github/CONTRIBUTING.md))
+
 ## 說明 (Description)
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
 
-請簡單說明此PR的更動、被修復的問題以及相關的原因，並請列出這個更動所需要的任何相依模組/套件。
+<!--請簡單說明此PR的更動、被修復的問題以及相關的原因，並請列出這個更動所需要的任何相依模組/套件。
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.-->
 
 ## 相關問題 (Linked Issues)
-- #(issue1)
-- #(issue2)
-- #(issue3)
+<!--
+- Related issues linked `fixes #number`
+- Tests added. Pass Coverage.
+- Errors have a helpful link.
+-->
 
 ## 貢獻種類 (Type of change)
 
@@ -19,7 +27,7 @@ Please include a summary of the change and which issue is fixed. Please also inc
 - [ ] Doc change (需要更新文件 this change requires a documentation update)
 
 **測試環境 (Test Configuration)**:
-* OS:
+* OS: 
 * NodeJS Version:
 * NPM Version:
 * Docker Version:

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,28 @@
+name: "codeql-analysis"
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 0 * * 0' # Run at midnight on Sunday
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [javascript]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -10,20 +10,23 @@ jobs:
   test-cryptogen:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
       with:
         node-version-file: '.nvmrc'
+        cache: 'npm'
     - run: npm ci
     - run: npm run build:console
     - run: ./cicd/test_script/cryptogen.sh
+
   test-ca:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
       with:
         node-version-file: '.nvmrc'
+        cache: 'npm'
     - run: npm ci
     - run: npm run build:console
     - run: ./cicd/test_script/ca.sh