-
Notifications
You must be signed in to change notification settings - Fork 521
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'refs/remotes/base/master' into store/test
# Conflicts: # hugegraph-server/hugegraph-dist/src/assembly/travis/start-store.sh
- Loading branch information
Showing
170 changed files
with
12,685 additions
and
592 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,10 +44,6 @@ jobs: | |
cp $HOME/.m2/settings.xml /tmp/settings.xml | ||
mv -vf .github/configs/settings.xml $HOME/.m2/settings.xml | ||
- name: Package | ||
run: | | ||
mvn clean package -U -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -ntp | ||
- name: Run common test | ||
run: | | ||
mvn test -pl hugegraph-pd/hg-pd-test -am -P pd-common-test | ||
|
@@ -57,6 +53,11 @@ jobs: | |
mvn test -pl hugegraph-pd/hg-pd-test -am -P pd-core-test | ||
# The above tests do not require starting a PD instance. | ||
|
||
- name: Package | ||
run: | | ||
mvn clean package -U -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -ntp | ||
- name: Prepare env and service | ||
run: | | ||
$TRAVIS_DIR/start-pd.sh | ||
|
@@ -146,3 +147,73 @@ jobs: | |
uses: codecov/[email protected] | ||
with: | ||
file: ${{ env.REPORT_DIR }}/*.xml | ||
|
||
hstore: | ||
# TODO: avoid duplicated env setup | ||
runs-on: ubuntu-latest | ||
env: | ||
USE_STAGE: 'true' # Whether to include the stage repository. | ||
TRAVIS_DIR: hugegraph-server/hugegraph-dist/src/assembly/travis | ||
REPORT_DIR: target/site/jacoco | ||
BACKEND: hstore | ||
RELEASE_BRANCH: ${{ startsWith(github.ref_name, 'release-') || startsWith(github.ref_name, 'test-') || startsWith(github.base_ref, 'release-') }} | ||
|
||
steps: | ||
- name: Install JDK 11 | ||
uses: actions/setup-java@v3 | ||
with: | ||
java-version: '11' | ||
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: use staged maven repo settings | ||
if: ${{ env.USE_STAGE == 'true' }} | ||
run: | | ||
cp $HOME/.m2/settings.xml /tmp/settings.xml | ||
mv -vf .github/configs/settings.xml $HOME/.m2/settings.xml | ||
- name: Package | ||
run: | | ||
mvn clean package -U -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -ntp | ||
- name: Prepare env and service | ||
run: | | ||
$TRAVIS_DIR/install-backend.sh $BACKEND | ||
- name: Run unit test | ||
run: | | ||
$TRAVIS_DIR/run-unit-test.sh $BACKEND | ||
- name: Run core test | ||
run: | | ||
$TRAVIS_DIR/run-core-test.sh $BACKEND | ||
- name: Run api test | ||
run: | | ||
$TRAVIS_DIR/run-api-test.sh $BACKEND $REPORT_DIR | ||
- name: Run raft test | ||
if: ${{ env.BACKEND == 'rocksdb' }} | ||
run: | | ||
$TRAVIS_DIR/run-api-test-for-raft.sh $BACKEND $REPORT_DIR | ||
- name: Run TinkerPop test | ||
if: ${{ env.RELEASE_BRANCH == 'true' }} | ||
run: | | ||
$TRAVIS_DIR/run-tinkerpop-test.sh $BACKEND tinkerpop | ||
- name: Upload coverage to Codecov | ||
uses: codecov/[email protected] | ||
with: | ||
file: ${{ env.REPORT_DIR }}/*.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
# How to Contribute to HugeGraph | ||
|
||
Thanks for taking the time to contribute! As an open source project, HugeGraph is looking forward to be contributed from everyone, | ||
and we are also grateful to all the contributors. | ||
> Refer [website-doc](https://hugegraph.apache.org/docs/contribution-guidelines/) for the latest information. | ||
Thanks for taking the time to contribute! | ||
As an open source project, HugeGraph is looking forward to being contributed from everyone, and we are also grateful to all the contributors. | ||
|
||
The following is a contribution guide for HugeGraph: | ||
|
||
|
@@ -15,7 +17,7 @@ We can contribute by reporting issues, submitting code patches or any other feed | |
|
||
Before submitting the code, we need to do some preparation: | ||
|
||
1. Sign up or login to GitHub: [https://github.com](https://github.com) | ||
1. Sign up or login to GitHub: [https://github.com](https://github.com) | ||
|
||
2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/apache/incubator-hugegraph/fork) | ||
|
||
|
@@ -69,21 +71,21 @@ vim hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/HugeFacto | |
# run test locally (optional) | ||
mvn test -Pcore-test,memory | ||
``` | ||
Note: In order to be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml). | ||
Note: To be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml). | ||
|
||
##### 3.2.1 Check licenses | ||
If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things: | ||
1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path. | ||
2. Declare the dependency in [./hugegraph-server/hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/LICENSE) `LICENSE` information. | ||
3. Find the NOTICE file in the repository and append it to [./hugegraph-server/hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file). | ||
4. Execute locally [./hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update) . | ||
4. Execute locally [./hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update). | ||
|
||
**Example**: A new third-party dependency is introduced into the project -> `ant-1.9.1.jar` | ||
- The project source code is located at: https://github.com/apache/ant/tree/rel/1.9.1 | ||
- LICENSE file: https://github.com/apache/ant/blob/rel/1.9.1/LICENSE | ||
- NOTICE file: https://github.com/apache/ant/blob/rel/1.9.1/NOTICE | ||
|
||
The license information of `ant-1.9.1.jar` needs to be specified in the LICENSE file, and the notice information needs to be specified in the NOTICE file. The detailed LICENSE file corresponding to ant-1.9.1.jar needs to be copied to our licenses/ directory. Finally update the known-dependencies.txt file. | ||
The license information of `ant-1.9.1.jar` needs to be specified in the LICENSE file, and the notice information needs to be specified in the NOTICE file. The detailed LICENSE file corresponding to ant-1.9.1.jar needs to be copied to our licenses/ directory. Finally, update the known-dependencies.txt file. | ||
|
||
#### 3.3 Commit changes to git repo | ||
|
||
|
@@ -105,7 +107,7 @@ Fix bug: run deploy multiple times | |
fix #ISSUE_ID | ||
``` | ||
|
||
> Please remember to fill in the issue id, which was generated by GitHub after issue creation. | ||
> Please remember to fill in the issue id, which GitHub generated after issue creation. | ||
#### 3.4 Push commit to GitHub fork repo | ||
|
||
|
@@ -121,7 +123,7 @@ Note that since GitHub requires submitting code through `username + token` (inst | |
|
||
## 4. Create a Pull Request | ||
|
||
Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, just click button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message. | ||
Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, click the button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message. | ||
|
||
Note: please make sure the email address you used to submit the code is bound to the GitHub account. For how to bind the email address, please refer to https://github.com/settings/emails: | ||
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png"> | ||
|
@@ -131,7 +133,7 @@ Note: please make sure the email address you used to submit the code is bound to | |
Maintainers will start the code review after all the **automatic** checks are passed: | ||
|
||
- Check: Contributor License Agreement is signed | ||
- Check: Travis CI builds is passed (automatically Test and Deploy) | ||
- Check: Travis CI builds are passed (automatically Test and Deploy) | ||
|
||
The commit will be accepted and merged if there is no problem after review. | ||
|
||
|
@@ -171,8 +173,8 @@ And push it to GitHub fork repo again: | |
git push -f origin bugfix-branch:bugfix-branch | ||
``` | ||
GitHub will automatically update the Pull Request after we push it, just wait for code review. | ||
GitHub will automatically update the Pull Request after we push it, wait for code review. | ||
|
||
Any question please contact to us through [[email protected]](mailto:[email protected]) or [other contact information](https://hugegraph.github.io/hugegraph-doc/). | ||
For Any question, please contact us through [[email protected]](mailto:[email protected]) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.