This is an automated email from the ASF dual-hosted git repository.
zhaojinchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new e637b4bedbd Refactor workflow naming (#27348)
e637b4bedbd is described below
commit e637b4bedbd6a5a3af046f1c1b7d5266c1035456
Author: 孙念君 Nianjun Sun <[email protected]>
AuthorDate: Fri Jul 21 11:51:37 2023 +0800
Refactor workflow naming (#27348)
* Refactor : rename the workflow file and change the code of conduct(#27345)
* Refactor : remove the cache from checkstyle check (#27345)
---
.github/workflows/nightly-e2e.yml | 176 ---------------------
.github/workflows/required-check.yml | 6 -
.../{schedule-check.yml => schedule-report.yml} | 0
docs/community/content/involved/conduct/code.cn.md | 2 +-
docs/community/content/involved/conduct/code.en.md | 2 +-
5 files changed, 2 insertions(+), 184 deletions(-)
diff --git a/.github/workflows/nightly-e2e.yml
b/.github/workflows/nightly-e2e.yml
deleted file mode 100644
index 05e8ca59288..00000000000
--- a/.github/workflows/nightly-e2e.yml
+++ /dev/null
@@ -1,176 +0,0 @@
-#
-# 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.
-#
-
-name: Nightly - E2E
-
-on:
- schedule:
- - cron: '0 20 */1 * *' # once a day. UTC time
- workflow_dispatch:
-
-concurrency:
- group: it-${{ github.workflow }}-${{ github.ref }}
- cancel-in-progress: true
-
-env:
- MAVEN_OPTS: -Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false
-Dmaven.wagon.http.retryHandler.class=standard
-Dmaven.wagon.http.retryHandler.count=3 -Dmaven.javadoc.skip=true
-Dcheckstyle.skip=true -Djacoco.skip=true -Dspotless.apply.skip=true
- REPOSITORY_NAME: shardingsphere
- SEGMENT_DOWNLOAD_TIMEOUT_MINS: 1
-
-jobs:
- build-it-image:
- if: github.repository == 'apache/shardingsphere'
- name: Build IT Image
- runs-on: ubuntu-latest
- timeout-minutes: 20
- steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-java@v3
- with:
- distribution: 'temurin'
- java-version: '11'
- - uses: actions/cache@v3
- with:
- path: ~/.m2/repository
- key: ${{ env.REPOSITORY_NAME }}-maven-third-party-it-cache-${{
github.sha }}
- restore-keys: |
- ${{ env.REPOSITORY_NAME }}-maven-third-party-it-cache-
- ${{ env.REPOSITORY_NAME }}-maven-third-party-
- - name: Build IT Image
- run: ./mvnw -B clean install -am -pl test/e2e/sql -Pit.env.docker
-DskipTests -Dspotless.apply.skip=true
- - name: Verify SQL CI Run
- run: ./mvnw -B install -pl test/e2e/sql -Dspotless.apply.skip=true
- - name: Save IT Image
- run: docker save -o /tmp/${{ env.REPOSITORY_NAME }}-proxy-test.tar
apache/shardingsphere-proxy-test:latest
- - uses: actions/upload-artifact@v3
- with:
- name: it-image
- path: /tmp/${{ env.REPOSITORY_NAME }}-proxy-test.tar
- retention-days: 1
-
- it-empty-rule:
- name: Empty Rule
- runs-on: ubuntu-latest
- timeout-minutes: 10
- needs: build-it-image
- strategy:
- max-parallel: 20
- fail-fast: false
- matrix:
- adapter: [ proxy, jdbc ]
- database: [ MySQL, PostgreSQL, openGauss ]
- scenario: [ empty_rules, rdl_empty_rules, passthrough ]
- exclude:
- - adapter: jdbc
- scenario: passthrough
- steps:
- - uses: actions/checkout@v3
- - uses: actions/cache@v3
- with:
- path: ~/.m2/repository
- key: ${{ env.REPOSITORY_NAME }}-maven-third-party-it-cache-${{
github.sha }}
- - uses: actions/setup-java@v3
- with:
- distribution: 'temurin'
- java-version: 11
- - name: Download IT Image
- if: matrix.adapter == 'proxy'
- uses: actions/download-artifact@v3
- with:
- name: it-image
- path: /tmp/
- - name: Load IT image
- if: matrix.adapter == 'proxy'
- run: docker load -i /tmp/${{ env.REPOSITORY_NAME }}-proxy-test.tar
- - name: Run E2E Test
- run: ./mvnw -nsu -B install -f test/e2e/sql/pom.xml
-Dspotless.apply.skip=true -Dit.run.modes=Cluster -Dit.scenarios=${{
matrix.scenario }} -Dit.cluster.adapters=${{ matrix.adapter }}
-Dit.cluster.databases=${{ matrix.database }} -Dit.cluster.env.type=DOCKER
-
- it-single-rule:
- name: Single Rule
- needs: it-empty-rule
- runs-on: ubuntu-latest
- timeout-minutes: 15
- strategy:
- max-parallel: 20
- fail-fast: false
- matrix:
- adapter: [ proxy, jdbc ]
- mode: [ standalone, Cluster ]
- database: [ MySQL, PostgreSQL, openGauss ]
- scenario: [ db, tbl, encrypt, readwrite_splitting, shadow ]
- exclude:
- - adapter: jdbc
- mode: Cluster
- steps:
- - uses: actions/checkout@v3
- - uses: actions/cache@v3
- with:
- path: ~/.m2/repository
- key: ${{ env.REPOSITORY_NAME }}-maven-third-party-it-cache-${{
github.sha }}
- - uses: actions/setup-java@v3
- with:
- distribution: 'temurin'
- java-version: 11
- - name: Download IT Image
- if: matrix.adapter == 'proxy'
- uses: actions/download-artifact@v3
- with:
- name: it-image
- path: /tmp/
- - name: Load IT Image
- if: matrix.adapter == 'proxy'
- run: docker load -i /tmp/${{ env.REPOSITORY_NAME }}-proxy-test.tar
- - name: Run E2E Test
- run: ./mvnw -nsu -B install -f test/e2e/sql/pom.xml
-Dspotless.apply.skip=true -Dit.cluster.env.type=DOCKER
-Dit.cluster.adapters=${{ matrix.adapter }} -Dit.run.modes=${{ matrix.mode }}
-Dit.cluster.databases=${{ matrix.database }} -Dit.scenarios=${{
matrix.scenario }}
-
- it-mixture-rule:
- name: Mixture Rule
- needs: it-single-rule
- runs-on: ubuntu-latest
- timeout-minutes: 15
- strategy:
- max-parallel: 20
- fail-fast: false
- matrix:
- adapter: [ proxy, jdbc ]
- mode: [ Standalone, Cluster ]
- database: [ MySQL, PostgreSQL, openGauss ]
- scenario: [ dbtbl_with_readwrite_splitting,
dbtbl_with_readwrite_splitting_and_encrypt, sharding_and_encrypt,
encrypt_and_readwrite_splitting, encrypt_shadow,
readwrite_splitting_and_shadow, sharding_and_shadow, sharding_encrypt_shadow ]
- exclude:
- - adapter: jdbc
- mode: Cluster
- steps:
- - uses: actions/checkout@v3
- - uses: actions/cache@v3
- with:
- path: ~/.m2/repository
- key: ${{ env.REPOSITORY_NAME }}-maven-third-party-it-cache-${{
github.sha }}
- - uses: actions/setup-java@v3
- with:
- distribution: 'temurin'
- java-version: 11
- - name: Download IT Image
- if: matrix.adapter == 'proxy'
- uses: actions/download-artifact@v3
- with:
- name: it-image
- path: /tmp/
- - name: Load IT Image
- if: matrix.adapter == 'proxy'
- run: docker load -i /tmp/${{ env.REPOSITORY_NAME }}-proxy-test.tar
- - name: Run E2E Test
- run: ./mvnw -nsu -B install -f test/e2e/sql/pom.xml
-Dspotless.apply.skip=true -Dit.cluster.env.type=DOCKER
-Dit.cluster.adapters=${{ matrix.adapter }} -Dit.run.modes=${{ matrix.mode }}
-Dit.cluster.databases=${{ matrix.database }} -Dit.scenarios=${{
matrix.scenario }}
diff --git a/.github/workflows/required-check.yml
b/.github/workflows/required-check.yml
index a324bbae099..05980426c81 100644
--- a/.github/workflows/required-check.yml
+++ b/.github/workflows/required-check.yml
@@ -36,12 +36,6 @@ jobs:
timeout-minutes: 10
steps:
- uses: actions/checkout@v3
- - uses: actions/cache@v3
- with:
- path: ~/.m2/repository
- key: ${{ env.REPOSITORY_NAME }}-maven-third-party-${{
hashFiles('**/pom.xml') }}
- restore-keys: |
- ${{ env.REPOSITORY_NAME }}-maven-third-party-
- name: Run CheckStyle and Spotless
run: ./mvnw checkstyle:check spotless:check -T1C
diff --git a/.github/workflows/schedule-check.yml
b/.github/workflows/schedule-report.yml
similarity index 100%
rename from .github/workflows/schedule-check.yml
rename to .github/workflows/schedule-report.yml
diff --git a/docs/community/content/involved/conduct/code.cn.md
b/docs/community/content/involved/conduct/code.cn.md
index b9e6fbaa70c..a7e198eeb82 100644
--- a/docs/community/content/involved/conduct/code.cn.md
+++ b/docs/community/content/involved/conduct/code.cn.md
@@ -114,7 +114,7 @@ chapter = true
- Workflow 文件名以 `.yml` 结尾。
- Workflow 文件名由 `触发方式-执行操作` 的小写字母组成。例如：`nightly-check.yml`。pull_request
触发的任务省略触发方式，例如：`check.yml`。
- 触发方式包括：pull_request（不加前缀）、nightly、schedule。
-- 执行操作包括：check、ci、e2e 、build。
+- 执行操作包括：check、ci、e2e 、build、report。
- Workflow 文件内的 `name` 属性命名与文件名一致，单词以 `-`
作为分隔符，分隔符两侧要加空格，每个单词首字母大写。例如：`Nightly - Check`。
- Step 下的 `name` 属性应该描述 step 的功能，每个单词首字母大写，介词小写。例如：`Build Project with Maven`。
- Workflow 中的 `job` 属性命名，须在 Workflow 中保持唯一。
diff --git a/docs/community/content/involved/conduct/code.en.md
b/docs/community/content/involved/conduct/code.en.md
index fe8ba907d24..29cc5e7952d 100644
--- a/docs/community/content/involved/conduct/code.en.md
+++ b/docs/community/content/involved/conduct/code.en.md
@@ -114,7 +114,7 @@ The following code of conduct is based on full compliance
with [ASF CODE OF COND
- Workflow file name must end with `.yml`.
- Workflow file name must consist with the lowercase of
`triggerType-actionType`. For example: `nightly-check.yml`. Omit trigger type
for pull_request. For example: `check.yml`.
- Trigger type includes: pull_request (without prefix), nightly, schedule.
-- Action type includes: check, ci, e2e, build.
+- Action type includes: check, ci, e2e, build, report.
- `name` property in workflow file should be same with file name, Words
separated by `-`, add space between `-` and words, first letter of every word
should be capital. For example: `Nightly - Check`.
- `name` property in step should describe the usage of step, first letter of
every word should be capital, preposition should be lowercase. For example:
`Build Project with Maven`.
- `job` property in workflow should be unique in that workflow file.
