Browse Source

[Chore] Improve ci check (#16161)

* improve ci check
dev
xiangzihao 5 months ago committed by GitHub
parent
commit
6736115f58
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 3
      .github/PULL_REQUEST_TEMPLATE.md
  2. 22
      .github/actions/auto-assign/auto-assign.yml
  3. 71
      .github/boring-cyborg.yml
  4. 12
      .github/workflows/pull-request-target-robot.yml
  5. 23
      docs/docs/en/contribute/join/pull-request.md
  6. 22
      docs/docs/zh/contribute/join/pull-request.md

3
.github/PULL_REQUEST_TEMPLATE.md

@ -31,4 +31,7 @@ This change added tests and can be verified as follows:
(or) (or)
## Pull Request Notice
[Pull Request Notice](https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/contribute/join/pull-request.md)
If your pull request contain incompatible change, you should also add it to `docs/docs/en/guide/upgrede/incompatible.md` If your pull request contain incompatible change, you should also add it to `docs/docs/en/guide/upgrede/incompatible.md`

22
.github/actions/auto-assign/auto-assign.yml

@ -0,0 +1,22 @@
#
# 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.
#
# Set addAssignees to 'author' to set the PR creator as the assignee.
addAssignees: author
# Enable it to run on drafts
runOnDraft: true

71
.github/boring-cyborg.yml

@ -0,0 +1,71 @@
################################################################################
# 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.
###### IssueLink Adder #################################################################################################
# Insert Issue (Jira/Github etc) link in PR description based on the Issue ID in PR title.
insertIssueLinkInPrDescription:
# specify the placeholder for the issue link that should be present in the description
descriptionIssuePlaceholderRegexp: "^fix: (.*)$"
matchers:
# you can have several matches - for different types of issues
# only the first matching entry is replaced
jiraIssueMatch:
# specify the regexp of issue id that you can find in the title of the PR
# the match groups can be used to build the issue id (${1}, ${2}, etc.).
titleIssueIdRegexp: \[(Feature|Fix|Improvement|Test|E2E|Doc-[0-9]+)\]
# the issue link to be added. ${1}, ${2} ... are replaced with the match groups from the
# title match (remember to use quotes)
descriptionIssueLink: "[${1}](https://github.com/apache/dolphinschedule/${1}/)"
###### Title Validator #################################################################################################
# Verifies if commit/PR titles match the regexp specified
verifyTitles:
# Regular expression that should be matched by titles of commits or PR
titleRegexp: ^\[Feature-[0-9]+\].*$|^\[Fix-[0-9]+\].*$|^\[Doc-[0-9]+\].*$|^\[Improvement-[0-9]+\].*$|^\[Test-[0-9]+\].*$|^\[E2E-[0-9]+\].*$|^\[CI].*$|^\[Chore].*$
# If set to true, it will always check the PR title (as opposed to the individual commits).
alwaysUsePrTitle: false
# If set to true, it will only check the commit in case there is a single commit.
# In case of multiple commits it will check PR title.
# This reflects the standard behaviour of Github that for `Squash & Merge` GitHub
# uses the PR title rather than commit messages for the squashed commit ¯\_(ツ)_/¯
# For single-commit PRs it takes the squashed commit message from the commit as expected.
#
# If set to false it will check all commit messages. This is useful when you do not squash commits at merge.
validateEitherPrOrSingleCommitTitle: true
# The title the GitHub status should appear from.
statusTitle: "Title Validator"
# A custom message to be displayed when the title passes validation.
successMessage: "Validation successful!"
# A custom message to be displayed when the title fails validation.
# Allows insertion of ${type} (commit/PR), ${title} (the title validated) and ${regex} (the titleRegexp above).
failureMessage: "Wrong ${type} title: ${title}"
# Various Flags to control behaviour of the "Labeler"
labelerFlags:
# If this flag is changed to 'false', labels would only be added when the PR is first created
# and not when existing PR is updated.
# The default is 'true' which means the labels would be added when PR is updated even if they
# were removed by the user
labelOnPRUpdates: true
# Comment to be posted to welcome users when they open their first PR
firstPRWelcomeComment: >
Thanks for opening this pull request! Please check out our contributing guidelines. (https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/contribute/join/pull-request.md)
# Comment to be posted to congratulate user on their first merged PR
firstPRMergeComment: >
Awesome work, congrats on your first merged pull request!

12
.github/workflows/pull-request-robot.yml → .github/workflows/pull-request-target-robot.yml

@ -15,20 +15,21 @@
# limitations under the License. # limitations under the License.
# #
name: "pull-request-robot" name: "pull-request-target-robot"
on: on:
pull_request_target: pull_request_target:
jobs: jobs:
labelRobot: pullRequestTargetRobot:
permissions: permissions:
contents: read contents: read
pull-requests: write pull-requests: write
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 10
steps: steps:
- name: "Checkout ${{ github.ref }}" - name: "Checkout ${{ github.ref }}"
uses: actions/checkout@v2 uses: actions/checkout@v4
with: with:
persist-credentials: false persist-credentials: false
submodules: true submodules: true
@ -39,3 +40,8 @@ jobs:
repo-token: "${{ secrets.GITHUB_TOKEN }}" repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: .github/actions/labeler/labeler.yml configuration-path: .github/actions/labeler/labeler.yml
sync-labels: true sync-labels: true
- name: "Auto assign in pull request"
uses: kentaro-m/auto-assign-action@v2.0.0
with:
configuration-path: .github/actions/auto-assign/auto-assign.yml

23
docs/docs/en/contribute/join/pull-request.md

@ -31,7 +31,7 @@ The corresponding relationship between `Pull Request Type` and `Issue Type` is a
<tr> <tr>
<td style="text-align: center;">Bug</td> <td style="text-align: center;">Bug</td>
<td style="text-align: center;">Fix</td> <td style="text-align: center;">Fix</td>
<td style="text-align: center;">[Fix-3333][server] Fix xxx</td> <td style="text-align: center;">[Fix-3333][ui] Fix xxx</td>
</tr> </tr>
<tr> <tr>
<td style="text-align: center;">Improvement</td> <td style="text-align: center;">Improvement</td>
@ -44,9 +44,24 @@ The corresponding relationship between `Pull Request Type` and `Issue Type` is a
<td style="text-align: center;">[Test-3333][api] Add the e2e test of xxx</td> <td style="text-align: center;">[Test-3333][api] Add the e2e test of xxx</td>
</tr> </tr>
<tr> <tr>
<td style="text-align: center;">Sub-Task</td> <td style="text-align: center;">Doc</td>
<td style="text-align: center;">(Parent type corresponding to Sub-Task)</td> <td style="text-align: center;">Doc</td>
<td style="text-align: center;">[Feature-3333][server] Implement xxx</td> <td style="text-align: center;">[Doc-3333] Improve xxx</td>
</tr>
<tr>
<td style="text-align: center;">E2E</td>
<td style="text-align: center;">E2E</td>
<td style="text-align: center;">[E2E-3333] Implement xxx</td>
</tr>
<tr>
<td style="text-align: center;">CI</td>
<td style="text-align: center;">CI</td>
<td style="text-align: center;">[CI] Improve xxx</td>
</tr>
<tr>
<td style="text-align: center;">Chore</td>
<td style="text-align: center;">Chore</td>
<td style="text-align: center;">[Chore] Improve xxx</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

22
docs/docs/zh/contribute/join/pull-request.md

@ -33,7 +33,7 @@ waste time。
<tr> <tr>
<td style="text-align: center;">Bug</td> <td style="text-align: center;">Bug</td>
<td style="text-align: center;">Fix</td> <td style="text-align: center;">Fix</td>
<td style="text-align: center;">[Fix-3333][server] Fix xxx</td> <td style="text-align: center;">[Fix-3333][ui] Fix xxx</td>
</tr> </tr>
<tr> <tr>
<td style="text-align: center;">Improvement</td> <td style="text-align: center;">Improvement</td>
@ -46,9 +46,23 @@ waste time。
<td style="text-align: center;">[Test-3333][api] Add the e2e test of xxx</td> <td style="text-align: center;">[Test-3333][api] Add the e2e test of xxx</td>
</tr> </tr>
<tr> <tr>
<td style="text-align: center;">Sub-Task</td> <td style="text-align: center;">Doc</td>
<td style="text-align: center;">Sub-Task 对应的父类型</td> <td style="text-align: center;">Doc</td>
<td style="text-align: center;">[Feature-3333][server] Implement xxx</td> <td style="text-align: center;">[Doc-3333] Improve xxx</td>
<tr>
<td style="text-align: center;">E2E</td>
<td style="text-align: center;">E2E</td>
<td style="text-align: center;">[E2E-3333] Implement xxx</td>
</tr>
<tr>
<td style="text-align: center;">CI</td>
<td style="text-align: center;">CI</td>
<td style="text-align: center;">[CI] Improve xxx</td>
</tr>
<tr>
<td style="text-align: center;">Chore</td>
<td style="text-align: center;">Chore</td>
<td style="text-align: center;">[Chore] Improve xxx</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

Loading…
Cancel
Save