This is an automated email from the ASF dual-hosted git repository. jin pushed a commit to branch fix-mail in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-commons.git
commit d7d0891210821130b1db7a915f7f12587fb8a84b Author: imbajin <[email protected]> AuthorDate: Wed Oct 26 20:29:34 2022 +0800 chore: fix missing mail addr & other configs also enhance README --- .asf.yaml | 11 +++-- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/question_ask.yml | 10 ++-- .github/workflows/ci.yml | 8 ++-- .github/workflows/codeql-analysis.yml | 2 +- .github/workflows/release.yml | 6 +-- .gitignore | 83 ++++++++++++++++++++++++++++----- README.md | 24 ++++++++-- 9 files changed, 116 insertions(+), 38 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index 727bb43..1b320bf 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -20,9 +20,9 @@ github: # Enable issue management issues: true # Enable wiki for documentation - wiki: false + wiki: true # Enable projects for project management boards - projects: false + projects: true description: HugeGraph Commons - include common library & RPC module homepage: https://hugegraph.apache.org/ del_branch_on_merge: true @@ -47,7 +47,8 @@ github: required_approving_review_count: 2 notifications: - issues: [email protected] - discussions: [email protected] pullrequests_status: [email protected] - #pullrequests_comment: [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] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 685c72d..43f2214 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,8 +10,8 @@ body: value: >- ### Note (特别注意) : - > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 - [Commons-Issues](https://github.com/hugegraph/hugegraph-commons/issues) 中没有与您相同 + > 1. 请先**搜索**现有的[Server-Issues](https://github.com/apache/hugegraph/issues) 与 + [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有与您相同 / 相关的问题 (请勿重复提交) > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) @@ -35,14 +35,14 @@ body: attributes: label: Before submit options: - - label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Commons-Issues](https://github.com/hugegraph/hugegraph-commons/issues) 中没有相同 / 重复问题 + - 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.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions) + > 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1078323..df4d745 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,5 +3,5 @@ blank_issues_enabled: false # 设置提 issue 前的参考文档 contact_links: - name: HugeGraph API Doc - url: https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html + url: https://hugegraph.apache.org/docs/clients/ about: Please search usage here before opening a new issue diff --git a/.github/ISSUE_TEMPLATE/question_ask.yml b/.github/ISSUE_TEMPLATE/question_ask.yml index 6fb2d4e..2b2d0bc 100644 --- a/.github/ISSUE_TEMPLATE/question_ask.yml +++ b/.github/ISSUE_TEMPLATE/question_ask.yml @@ -8,8 +8,8 @@ body: value: >- ### Note (特别注意) : - > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 - [Commons-Issues](https://github.com/hugegraph/hugegraph-commons/issues) 中没有与您相同 + > 1. 请先**搜索**现有的[Server-Issues](https://github.com/apache/hugegraph/issues) 与 + [Commons-Issues](https://github.com/apache/hugegraph-commons/issues) 中没有与您相同 / 相关的问题 (请勿重复提交) > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) @@ -33,14 +33,14 @@ body: attributes: label: Before submit options: - - label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Commons-Issues](https://github.com/hugegraph/hugegraph-commons/issues) 中没有相同 / 重复问题 + - 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.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions) + > 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 @@ -51,7 +51,7 @@ body: attributes: label: Your Question (问题描述) description: | - > 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html) + > 图使用 / 配置相关问题，请优先参考 [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 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1301d30..4b7f08d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,20 +18,20 @@ jobs: steps: - name: Install JDK ${{ matrix.JAVA_VERSION }} - uses: actions/setup-java@v2 + uses: actions/setup-java@v3 with: java-version: ${{ matrix.JAVA_VERSION }} distribution: 'zulu' - name: Cache Maven packages - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.m2 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} restore-keys: ${{ runner.os }}-m2 - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: fetch-depth: 2 @@ -49,6 +49,6 @@ jobs: mvn test -Dtest=UnitTestSuite - name: Upload coverage to Codecov - uses: codecov/codecov-action@v1 + uses: codecov/[email protected] with: file: target/jacoco.xml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 11d620f..aa71513 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -27,7 +27,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b0c20d2..7c1e641 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,20 +9,20 @@ jobs: runs-on: ubuntu-20.04 steps: - name: Install JDK 8 - uses: actions/setup-java@v2 + uses: actions/setup-java@v3 with: java-version: '8' distribution: 'zulu' - name: Cache Maven packages - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ~/.m2 key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} restore-keys: ${{ runner.os }}-m2 - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: fetch-depth: 2 diff --git a/.gitignore b/.gitignore index 8053b45..f7bcdbf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,51 @@ -.DS_Store -*.iml +target/ +**.db +logs/ +ui +node_modules +upload-files/ +demo* +gen-java +build +*.class + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +.svn + +### IntelliJ IDEA ### +.idea +.idea/ *.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ + +### VS Code ### +.vscode/ + +# misc +.DS_Store +*/.DS_Store +**/*.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + *.orig *.rej **/.keep @@ -10,13 +55,29 @@ *.swp *.log *.pyc -.idea -.svn -.classpath -.project -.settings -target -gen-java -build -node* + +# maven ignore +output/ +*.war +*.zip +*.tar +*.tar.gz +tree.txt *.versionsBackup + +# eclipse ignore +.settings/ + +# temp ignore +*.cache +*.diff +*.patch +*.tmp + +# system ignore +Thumbs.db +hs_err_pid* +# mobile Tools for Java (J2ME) +.mtj.tmp/ +# blueJ files +*.ctxt diff --git a/README.md b/README.md index 5196b43..abb5478 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,9 @@ [](https://codecov.io/gh/hugegraph/hugegraph-common) [](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common) -hugegraph-commons is a common module for [HugeGraph](https://github.com/hugegraph/hugegraph) and its peripheral components. +hugegraph-commons is a common module for [HugeGraph](https://github.com/apache/hugegraph) and its peripheral components. hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some -numeric or collection util classes to simplify the development of HugeGraph and -its components. +numeric or collection util classes to simplify the development of HugeGraph and its components. ## Components @@ -19,5 +18,22 @@ its components. - Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils etc. - Rpc: rpc component for inner module communication, currently it's based on [Sofa-RPC](https://github.com/sofastack/sofa-rpc) +## Learn More + +The [doc page](https://hugegraph.apache.org/docs/) contains more information about hugegraph modules. + +And here are links of other repositories: +1. [hugegraph-server](https://github.com/apache/incubator-hugegraph) (graph's core component - OLTP server) +2. [hugegraph-toolchain](https://github.com/apache/incubator-hugegraph-toolchain) (include loader/dashboard/tool/client) +3. [hugegraph-computer](https://github.com/apache/incubator-hugegraph-computer) (graph processing system - OLAP) +4. [hugegraph-website/doc](https://github.com/apache/incubator-hugegraph-doc) (include doc & website code) + +## Contributing + +Welcome to contribute, please see [`How to Contribute`](https://github.com/apache/incubator-hugegraph/blob/master/CONTRIBUTING.md) for more information + +Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to **greatly simplify** the PR and commit process. + ## Licence -The same as HugeGraph, hugegraph-commons is also licensed under Apache 2.0 License. + +Same as HugeGraph, hugegraph-commons is also licensed under `Apache 2.0` License.
