chore(commons): migrate hugegraph-commons

hugegraph-commons/.asf.yaml

@@ -0,0 +1,54 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+github:
+  features:
+    # Enable issue management
+    issues: true
+    # Enable wiki for documentation
+    wiki: true
+    # Enable projects for project management boards
+    projects: true
+  description: HugeGraph Commons - include common library & RPC module
+  homepage: https://hugegraph.apache.org/
+  del_branch_on_merge: true
+  #labels:
+
+  enabled_merge_buttons:
+    merge:  false
+    squash: true
+    rebase: true
+  protected_branches:
+    master:
+      required_status_checks:
+        # strict means "Require branches to be up-to-date before merging".
+        strict: true
+        # contexts are the names of checks that must pass
+        contexts:
+          - build (8)
+          - build (11)
+      required_pull_request_reviews:
+        dismiss_stale_reviews: true
+        require_code_owner_reviews: false
+        required_approving_review_count: 2
+
+notifications:
+  pullrequests_status: [email protected]
+  # Note: before use the config, we should ensure the "mail" address has set well (exist)
+  #pullrequests_comment: [email protected]
+  #issues: [email protected]
+  #discussions:  [email protected]

hugegraph-commons/.editorconfig

@@ -0,0 +1,31 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+[*.{java, xml, py}]
+indent_style = space
+indent_size = 4
+
+[*.{java, xml}]
+# Ignore the IDEA unsupported warning & it works well (indeed)
+continuation_indent_size = 8

hugegraph-commons/.gitattributes

@@ -0,0 +1,8 @@
+# ignore when package to source.tgz
+.github/ export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.asf.yaml export-ignore
+apache-release.sh export-ignore
+
+hugegraph-dist/scripts export-ignore

hugegraph-commons/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,96 @@
+name: Bug report (反馈 Bug)
+description: Create a bug report to help HugeGraph improve
+title: '[Bug] describe the main problem'
+labels:
+  - bug
+
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        ### Note (特别注意) : 
+
+        > 1. 请先**搜索**现有的[Server-Issues](https://github.com/apache/hugegraph/issues) 与
+        [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有与您相同
+        / 相关的问题 (请勿重复提交)
+
+        > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
+        会**越快**被响应和处理
+
+        > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
+
+        > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
+        (更新时会再开启)
+
+  - type: dropdown
+    attributes:
+      label: Bug Type (问题类型)
+      options:
+        - exception / error (异常报错)
+        - logic (逻辑设计问题)
+        - performance (性能下降)
+        - others (please edit later)
+
+  - type: checkboxes
+    attributes:
+      label: Before submit
+      options:
+        - label: 我已经确认现有的 [Server-Issues](https://github.com/apache/hugegraph/issues) 与 [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有相同 / 重复问题
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Environment (环境信息)
+      description: |
+        > server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions)
+      value: |
+        - Server Version: v0.11.x
+        - Common Version: v1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected & Actual behavior (期望与实际表现)
+      description: |
+        > we can refer [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) (如何提供最简的可复现用例)
+        > if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
+      placeholder: |        
+        type the main problem here 
+
+        ```java
+        // Exception / Error info (尽可能详细的日志 + 完整异常栈)
+
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Vertex/Edge example (问题点 / 边数据举例)
+      description: |
+        > 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果`
+      placeholder: |
+        // Query URL
+        GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom')
+
+        // JSON of Vertex / Edge
+        {
+          "vertex": { "id": "xxx" }
+        }
+      render: javascript
+
+  - type: textarea
+    attributes:
+      label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
+      description: |
+        > 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
+      placeholder: |
+        // Query URL
+        GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
+
+        // JSON of GraphSchema
+        {
+          "vertex": { "id": "xxx" }
+        }
+      render: javascript

hugegraph-commons/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: false
+
+# 设置提 issue 前的参考文档
+contact_links:
+  - name: HugeGraph API Doc
+    url: https://hugegraph.apache.org/docs/clients/
+    about: Please search usage here before opening a new issue

hugegraph-commons/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,15 @@
+name: Feature request (新需求 / 功能)
+description: Give an idea for HugeGraph
+title: '[Feature] describe the new feature'
+labels:
+  - feature
+
+body:
+  - type: textarea
+    attributes:
+      label: Feature Description (功能描述)
+      description: |
+        > 请简要描述新功能 / 需求的使用场景或上下文, 最好能给个具体的例子说明
+      placeholder: type the feature description here 
+    validations:
+      required: true

hugegraph-commons/.github/ISSUE_TEMPLATE/question_ask.yml

@@ -0,0 +1,94 @@
+name: Ask question (提问)
+description: Question about usage or configs in HugeGraph
+title: '[Question] describe your problem'
+
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        ### Note (特别注意) : 
+
+        > 1. 请先**搜索**现有的[Server-Issues](https://github.com/apache/hugegraph/issues) 与
+        [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有与您相同
+        / 相关的问题 (请勿重复提交)
+
+        > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
+        会**越快**被响应和处理
+
+        > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
+
+        > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
+        (更新时会再开启)
+
+  - type: dropdown
+    attributes:
+      label: Problem Type (问题类型)
+      options:
+        - struct / logic (架构 / 逻辑设计问题)
+        - performance (性能优化)
+        - exception / error (异常报错)
+        - others (please edit later)
+
+  - type: checkboxes
+    attributes:
+      label: Before submit
+      options:
+        - label: 我已经确认现有的 [Server-Issues](https://github.com/apache/hugegraph/issues) 与 [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有相同 / 重复问题
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Environment (环境信息)
+      description: |
+        > server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions)
+      value: |
+        - Server Version: v0.11.x
+        - Common Version: v1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Your Question (问题描述)
+      description: |
+        > 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.apache.org/docs/clients/restful-api/), 以及 [Server 配置文档](https://hugegraph.apache.org/docs/config/config-option/)
+        > if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
+      placeholder: |        
+        type the main problem here 
+
+        ```java
+        // Exception / Error info (尽可能详细的日志 + 完整异常栈)
+
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Vertex/Edge example (问题点 / 边数据举例)
+      description: |
+        > 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果`
+      placeholder: |
+        // Query URL
+        GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom')
+
+        // JSON of Vertex / Edge
+        {
+          "vertex": { "id": "xxx" }
+        }
+      render: javascript
+
+  - type: textarea
+    attributes:
+      label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
+      description: |
+        > 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
+      placeholder: |
+        // Query URL
+        GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
+
+        // JSON of GraphSchema
+        {
+          "vertex": { "id": "xxx" }
+        }
+      render: javascript

hugegraph-commons/.github/outdated/.travis.yml

@@ -0,0 +1,11 @@
+language: java
+
+jdk:
+  - openjdk8
+
+install: mvn compile -Dmaven.javadoc.skip=true
+
+script: mvn test -Dtest=UnitTestSuite
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

hugegraph-commons/.github/outdated/cla.yml

@@ -0,0 +1,35 @@
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+jobs:
+  CLAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: cla-assistant/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secret
+          PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: '.github/cla-signatures/cla.json'
+          path-to-document: 'https://github.com/hugegraph/hugegraph-doc/blob/master/CLA.md' # e.g. a CLA or a DCO document
+          custom-allsigned-prcomment: '**Good**! All Contributors have signed the [CLA](https://github.com/hugegraph/hugegraph-doc/blob/master/CLA.md).'
+          # branch should not be protected
+          branch: 'cla-assist'
+          allowlist: bot*
+          lock-pullrequest-aftermerge: false
+
+         # the following are the optional inputs - If the optional inputs are not given, then default values will be taken
+          #remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
+          #remote-repository-name:  enter the  remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
+          #create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
+          #signed-commit-message: 'For example: $contributorName has signed the CLA in #$pullRequestNo'
+          #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
+          #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
+          #use-dco-flag: true - If you are using DCO instead of CLA

hugegraph-commons/.github/outdated/release.yml

@@ -0,0 +1,39 @@
+name: release maven package
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Install JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'zulu'
+
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Release Maven package
+        uses: samuelmeuli/action-maven-publish@v1
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          nexus_username: ${{ secrets.NEXUS_USERNAME }}
+          nexus_password: ${{ secrets.NEXUS_PASSWORD }}
+          server_id: sonatype-nexus-staging
+          maven_profiles: "release"
+          maven_args: >
+            -Dmaven.test.skip=true