Skip to content

Commit

Permalink
Merge branch 'dev-1.3.1' of github.com:WeBankFinTech/Linkis into my-d…
Browse files Browse the repository at this point in the history
…ev-1.3.1
  • Loading branch information
Sun Shun committed Oct 21, 2022
2 parents 0625153 + a4edf1b commit 94851e5
Show file tree
Hide file tree
Showing 583 changed files with 14,936 additions and 3,677 deletions.
8 changes: 7 additions & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,13 @@ github:
required_pull_request_reviews:
dismiss_stale_reviews: true
required_approving_review_count: 2
dev-1.2.0:
dev-1.3.1:
required_status_checks:
strict: true
required_pull_request_reviews:
dismiss_stale_reviews: true
required_approving_review_count: 1
dev-1.3.2:
required_status_checks:
strict: true
required_pull_request_reviews:
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/auto-format-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ jobs:
distribution: 'adopt'

- name: Code Format Apply
run: |
./mvnw -N install
run:
./mvnw spotless:apply

- name: Create Pull Request
Expand Down
6 changes: 2 additions & 4 deletions .github/workflows/build-backend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ jobs:
with:
distribution: 'adopt'
java-version: 8

- name: Build backend by maven
run: |
./mvnw -N install
./mvnw clean package
run:
./mvnw clean package
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3.0.0
# with:
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/check-code-format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,5 @@ jobs:
java-version: '8'
distribution: 'adopt'
- name: Code format check
run: |
./mvnw -N install
run:
./mvnw spotless:check
3 changes: 0 additions & 3 deletions .github/workflows/check-license.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ jobs:
with:
java-version: '8'
distribution: 'adopt'
- name: mvn -N install
run:
mvn -N install
- name: License check with Maven
run: |
rat_file=`mvn apache-rat:check | { grep -oe "\\S\\+/rat.txt" || true; }`
Expand Down
7 changes: 2 additions & 5 deletions .github/workflows/check-third-party-dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,13 @@ jobs:
with:
java-version: '8'
distribution: 'adopt'
- name: mvn -N install
run:
mvn -N install
- name: mvn install
run:
#pom.xml also introduce linkis related jar,so run mvn install in first time
mvn install
./mvnw install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true
- name: mvn dependency:copy-dependencies
run:
mvn dependency:copy-dependencies -DincludeScope=runtime -DoutputDirectory=${{ github.workspace }}/current_dependencies
./mvnw dependency:copy-dependencies -DincludeScope=runtime -DoutputDirectory=${{ github.workspace }}/current_dependencies
- name: generate current_dependencies.txt
run: |
ls ${{ github.workspace }}/current_dependencies |egrep -v "^linkis" |sort > ~/current_dependencies.txt
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,8 @@ jobs:
# - name: Autobuild
# uses: github/codeql-action/autobuild@v2
- name: Build
run: |
./mvnw -N install
./mvnw clean package
run:
./mvnw clean package -Dmaven.test.skip=true

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
19 changes: 15 additions & 4 deletions .github/workflows/publish-docker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,10 @@ jobs:
sed -i "/VUE_APP_MN_CONFIG_PREFIX/d" .env
npm install
npm run build
- name: Build backend by maven
run: |
./mvnw -N install
- name: Build backend by maven
run: |
./mvnw install -Pdocker -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -Dlinkis.build.web=true -Dimage.build.type=release
./mvnw install -Pdocker -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -Dlinkis.build.web=true -Dlinkis.build.ldh=true
- name: Log in to the Container registry
uses: docker/login-action@v1.10.0
with:
Expand All @@ -80,5 +78,18 @@ jobs:
docker images
docker tag linkis:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis:${{ env.DOCKER_VERSION }}
docker push ${{ env.HUB }}/linkis:${{ env.DOCKER_VERSION }}
docker tag linkis:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis:latest
docker push ${{ env.HUB }}/linkis:latest
docker tag linkis-web:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis-web:${{ env.DOCKER_VERSION }}
docker push ${{ env.HUB }}/linkis-web:${{ env.DOCKER_VERSION }}
docker tag linkis-web:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis-web:latest
docker push ${{ env.HUB }}/linkis-web:latest
docker tag linkis-ldh:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis-ldh:${{ env.DOCKER_VERSION }}
docker push ${{ env.HUB }}/linkis-ldh:${{ env.DOCKER_VERSION }}
docker tag linkis-ldh:${{ env.LINKIS_VERSION }} ${{ env.HUB }}/linkis-ldh:latest
docker push ${{ env.HUB }}/linkis-ldh:latest
14 changes: 6 additions & 8 deletions .github/workflows/publish-snapshot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,16 @@ jobs:
distribution: 'adopt'
java-version: 8

- name: Get Version
run: |
BRANCE= ${{ matrix.branch }}
echo "::set-output name=version::${BRANCE#*-}-SNAPSHOT"
id: get_version
- name: Get Version
run: |
BRANCE= ${{ matrix.branch }}
echo "::set-output name=version::${BRANCE#*-}-SNAPSHOT"
id: get_version

- name: Publish snapshot - ${{ matrix.branch }}
env:
ASF_USERNAME: ${{ secrets.NEXUS_USER }}
ASF_PASSWORD: ${{ secrets.NEXUS_PW }}
run: |
./mvnw -N install
./mvnw versions:set -DnewVersion={{steps.get_version.outputs.version}} -DgenerateBackupPoms=false
./mvnw -N install
./mvnw deploy -s ./.github/asf-settings.xml -Drevision={{steps.get_version.outputs.version}} -DskipTests -Dmaven.javadoc.skip=true -DretryFailedDeploymentCount=10
./mvnw deploy -s ./.github/asf-settings.xml -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -DretryFailedDeploymentCount=10
27 changes: 21 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,34 @@ Helping answering the questions in the Linkis community is a very valuable way t
You can find linkis documentations at [linkis-Website](https://linkis.apache.org/docs/latest/introduction), and the supplement of the document is also crucial to the development of Linkis.

### 1.5 Other

Including participating in and helping to organize community exchanges, community operation activities, etc., and other activities that can help the Linkis project and the community.

## 2. How to Contribution

### 2.1 Branch structure

The Linkis source code may have some temporary branches, but only the following three branches are really meaningful:

- master: The source code of the latest stable release, and occasionally several hotfix submissions;
- release-*: stable release version;
- dev-*: main development branch;

#### 2.1.1 Concept

- Upstream repository: https://github.com/apache/incubator-linkis The apache repository of linkis is called Upstream repository in the text
- Fork repository: From https://github.com/apache/incubator-linkis fork to your own personal repository called Fork repository
- Upstream repository: <https://github.com/apache/incubator-linkis> The apache repository of linkis is called Upstream repository in the text
- Fork repository: From <https://github.com/apache/incubator-linkis> fork to your own personal repository called Fork repository

#### 2.1.2 Synchronize Upstream Repository

> Synchronize the latest code of the Upstream repository branch to your own Fork repository
- Step1 Enter the user project page and select the branch to be updated
- Step2 Click Fetch upstream under the code download button, select Fetch and merge (if the branch of your own Fork repository is accidentally polluted, you can delete the branch and synchronize the new branch of the Upstream repository to your own Fork repository, see the guide [Synchronize Upstream] The latest code of the warehouse branch to its own Fork warehouse] (#213-synchronize the new branch of the Upstream warehouse to its own Fork warehouse))
![update-code](https://user-images.githubusercontent.com/7869972/176622158-52da5a80-6d6a-4f06-a099-ff65887d002c.png)

#### 2.1.3 Synchronize New Branch

>Synchronize the new branch of the Upstream repository to your own Fork repository
Scenario: There is a new branch in the Upstream warehouse, but the forked library does not have this branch (you can choose to delete and re-fork, but the changes that have not been merged to the original warehouse will be lost)
Expand All @@ -58,25 +62,33 @@ Operate in your own clone's local project
```shell script
git remote add apache git@github.com:apache/incubator-linkis.git
```

- Step2 Pull the apache image information to the local

```shell script
git fetch apache
```

- Step3 Create a local branch based on the new branch that needs to be synced

```shell script
git checkout -b dev-1.1.4 apache/dev-1.1.4
```

- Step4 Push the local branch to your own warehouse. If your own warehouse does not have the dev-1.1.4 branch, the dev-1.1.4 branch will be created

```shell script
git push origin dev-1.1.4:dev-1.1.4
```

- Step5 Delete the upstream branch

```shell script
git remote remove apache
```

- Step6 Update the branch

```shell script
git pull
```
Expand All @@ -85,23 +97,25 @@ git pull

- Step1 Confirm the base branch of the current development (usually the current version in progress, such as the version 1.1.0 currently under development by the community, then the branch is dev-1.1.0, if you are not sure, you can ask in the community group or at @relevant classmates in the issue)

- Step2 Synchronize the latest code of the Upstream warehouse branch to your own Fork warehouse branch, see the guide [2.1.2 Synchronize Upstream Repository]
- Step2 Synchronize the latest code of the Upstream warehouse branch to your own Fork warehouse branch, see the guide [2.1.2 Synchronize Upstream Repository]

- Step3 Based on the development branch, pull the new fix/feature branch (do not modify it directly on the original branch, if the subsequent PR is merged in the squash method, the submitted commit records will be merged into one)

```shell script
git checkout -b dev-1.1.4-fix dev-1.1.4
git push origin dev-1.1.4-fix:dev-1.1.4-fix
```

- Step4 Develop
- Step5 Submit pr (if it is in progress and the development has not been completely completed, please add the WIP logo to the pr title, such as `[WIP] Dev 1.1.1 Add junit test code for [linkis-common] `; associate the corresponding issue, etc.)
- Step5 Submit pr (if it is in progress and the development has not been completely completed, please add the WIP logo to the pr title, such as `[WIP] Dev 1.1.1 Add junit test code for [linkis-common]`; associate the corresponding issue, etc.)
- Step6 Waiting to be merged
- Step7 Delete the fix/future branch (you can do this on the github page)

```shell script
git branch -d dev-1.1.4-fix
git push
```


Please note: For the dev branch of major features, in addition to the version number, the corresponding naming description will be added, such as: dev-0.10.0-flink, which refers to the flink feature development branch of 0.10.0.

### 2.2 Development Guidelines
Expand All @@ -122,6 +136,7 @@ git push origin dev-fix dev-fix
```

### 2.3 Issue submission guidelines

- If you still don’t know how to initiate a PR to an open source project, please refer to [About issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues)
- Issue name, which should briefly describe your problem or suggestion in one sentence; for the international promotion of the project, please write the issue in English or both Chinese and English
- For each Issue, please bring at least two labels, component and type, such as component=Computation Governance/EngineConn, type=Improvement. Reference: [issue #590](https://github.com/apache/incubator-linkis/issues/590)
Expand Down Expand Up @@ -193,4 +208,4 @@ If you are the Committer of the Linkis project, and all your contributions have

- You can merge PRs submitted by other Committers and contributors to the dev-** branch
- Participate in determining the roadmap and development direction of the Linkis project
- Can participate in the new version release
- Can participate in the new version release
41 changes: 26 additions & 15 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# 如何参与项目贡献

> 更多信息可以见官网[如何参与项目贡献 ](https://linkis.apache.org/community/how-to-contribute)
> 更多信息可以见官网[如何参与项目贡献](https://linkis.apache.org/community/how-to-contribute)
非常感谢贡献 Linkis 项目!在参与贡献之前,请仔细阅读以下指引。


## 一、贡献范畴

### 1.1 Bug 反馈与修复
Expand All @@ -21,27 +20,28 @@

### 1.4 文档改进

Linkis 文档位于[Linkis 官网 ](https://linkis.apache.org/zh-CN/docs/latest/introduction/) ,文档的补充完善对于 Linkis 的发展也至关重要。
Linkis 文档位于[Linkis 官网](https://linkis.apache.org/zh-CN/docs/latest/introduction/) ,文档的补充完善对于 Linkis 的发展也至关重要。

### 1.5 其他
包括参与和帮助组织社区交流、社区运营活动等,其他能够帮助 Linkis 项目和社区的活动。

包括参与和帮助组织社区交流、社区运营活动等,其他能够帮助 Linkis 项目和社区的活动。

## 二、贡献流程

### 2.1 分支结构

Linkis 源码可能会产生一些临时分支,但真正有明确意义的只有以下三个分支:

- master: 最近一次稳定 release 的源码,偶尔会多几次 hotfix 提交;
- release-*: 稳定的 release 版本;
- release-*: 稳定的 release 版本;
- dev-*: 主要开发分支;

#### 2.1.1 概念
#### 2.1.1 概念

- Upstream 仓库:https://github.com/apache/incubator-linkis linkis 的 apache 仓库文中称为 Upstream 仓库
- Fork 仓库: 从 https://github.com/apache/incubator-linkis fork 到自己个人仓库 称为 Fork 仓库
- Upstream 仓库:<https://github.com/apache/incubator-linkis> linkis 的 apache 仓库文中称为 Upstream 仓库
- Fork 仓库: 从 <https://github.com/apache/incubator-linkis> fork 到自己个人仓库 称为 Fork 仓库

#### 2.1.2 同步 Upstream 仓库分支最新代码到自己的 Fork 仓库
#### 2.1.2 同步 Upstream 仓库分支最新代码到自己的 Fork 仓库

- step1 进入用户项目页面,选中要更新的分支
- step2 点击 code 下载按钮下方的 Fetch upstream,选择 Fetch and merge (如自己的 Fork 仓库 该分支不小心污染了,可以删除该分支后,同步 Upstream 仓库新分支到自己的 Fork 仓库 ,参见指引[同步 Upstream 仓库分支最新代码到自己的 Fork 仓库 ](#213-同步 Upstream 仓库新分支到自己的 Fork 仓库 ))
Expand All @@ -58,47 +58,58 @@ Linkis 源码可能会产生一些临时分支,但真正有明确意义的只
```shell script
git remote add apache git@github.com:apache/incubator-linkis.git
```

- step2 拉去 apache 镜像信息到本地

```shell script
git fetch apache
```

- step3 根据需要同步的新分支来创建本地分支

```shell script
git checkout -b dev-1.1.4 apache/dev-1.1.4
```

- step4 把本地分支 push 到自己的仓库,如果自己的仓库没有 dev-1.1.4 分支,则会创建 dev-1.1.4 分支

```shell script
git push origin dev-1.1.4:dev-1.1.4
```

- step5 删除 upstream 的分支

```shell script
git remote remove apache
```

- step6 更新分支

```shell script
git pull
```

#### 2.1.4 一个 pr 的流程
#### 2.1.4 一个 pr 的流程

- step1 确认当前开发的基础分支(一般是当前进行的中版本,如当前社区开发中的版本 1.1.0,那么分支就是 dev-1.1.0,不确定的话可以在社区群里问下或则在 issue 中@相关同学)

- step2 同步 Upstream 仓库分支最新代码到自己的 Fork 仓库 分支,参见指引 [2.1.2 同步 Upstream 仓库分支最新代码到自己的 Fork 仓库 ]

- step3 基于开发分支,拉取新 fix/feature 分支 (不要直接在原分支上修改,如果后续 pr 以 squash 方式 merge 后,提交的 commit 记录会被合并成一个)

```shell script
git checkout -b dev-1.1.4-fix dev-1.1.4
git push origin dev-1.1.4-fix:dev-1.1.4-fix
```

- step4 进行开发
- step5 提交 pr(如果是正在进行中,开发还未完全结束,请在 pr 标题上加上 WIP 标识 如 `[WIP] Dev 1.1.1 Add junit test code for [linkis-common] ` ;关联对应的 issue 等)
- step5 提交 pr(如果是正在进行中,开发还未完全结束,请在 pr 标题上加上 WIP 标识 如 `[WIP] Dev 1.1.1 Add junit test code for [linkis-common]` ;关联对应的 issue 等)
- step6 等待被合并
- step7 删除 fix/future 分支 (可以在 github 页面上进行操作)
- step7 删除 fix/future 分支 (可以在 github 页面上进行操作)

```shell script
git branch -d dev-1.1.4-fix
git push
git branch -d dev-1.1.4-fix
git push
```

请注意:大特性的 dev 分支,在命名时除了版本号,还会加上相应的命名说明,如:dev-0.10.0-flink,指 0.10.0 的 flink 特性开发分支。
Expand Down Expand Up @@ -128,7 +139,7 @@ git push origin dev-fix dev-fix

- 如果您还不知道怎样向开源项目发起 PR,请参考[About pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
- 无论是 Bug 修复,还是新功能开发,请将 PR 提交到 dev-* 分支
- PR 和提交名称遵循 `<type>(<scope>): <subject>` 原则,详情可以参考[Commit message 和 Change log 编写指南 ](https://linkis.apache.org/zh-CN/community/development-specification/commit-message)
- PR 和提交名称遵循 `<type>(<scope>): <subject>` 原则,详情可以参考[Commit message 和 Change log 编写指南](https://linkis.apache.org/zh-CN/community/development-specification/commit-message)
- 如果 PR 中包含新功能,理应将文档更新包含在本次 PR 中
- 如果本次 PR 尚未准备好合并,请在名称头部加上 [WIP] 前缀(WIP = work-in-progress)
- 所有提交到 dev-* 分支的提交至少需要经过一次 Review 才可以被合并
Expand Down
Loading

0 comments on commit 94851e5

Please sign in to comment.