From 6736115f5849ffb12e95ddc3d89683c0f1c64048 Mon Sep 17 00:00:00 2001 From: xiangzihao <460888207@qq.com> Date: Mon, 17 Jun 2024 16:18:45 +0800 Subject: [PATCH] [Chore] Improve ci check (#16161) * improve ci check --- .github/PULL_REQUEST_TEMPLATE.md | 3 + .github/actions/auto-assign/auto-assign.yml | 22 ++++++ .github/boring-cyborg.yml | 71 +++++++++++++++++++ ...obot.yml => pull-request-target-robot.yml} | 12 +++- docs/docs/en/contribute/join/pull-request.md | 23 ++++-- docs/docs/zh/contribute/join/pull-request.md | 22 ++++-- 6 files changed, 142 insertions(+), 11 deletions(-) create mode 100644 .github/actions/auto-assign/auto-assign.yml create mode 100644 .github/boring-cyborg.yml rename .github/workflows/{pull-request-robot.yml => pull-request-target-robot.yml} (80%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 652e41a3bd..a3fcfc5686 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -31,4 +31,7 @@ This change added tests and can be verified as follows: (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` diff --git a/.github/actions/auto-assign/auto-assign.yml b/.github/actions/auto-assign/auto-assign.yml new file mode 100644 index 0000000000..986ed6c4f2 --- /dev/null +++ b/.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 diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml new file mode 100644 index 0000000000..60c452fedb --- /dev/null +++ b/.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! diff --git a/.github/workflows/pull-request-robot.yml b/.github/workflows/pull-request-target-robot.yml similarity index 80% rename from .github/workflows/pull-request-robot.yml rename to .github/workflows/pull-request-target-robot.yml index 731849e46d..90e6784eba 100644 --- a/.github/workflows/pull-request-robot.yml +++ b/.github/workflows/pull-request-target-robot.yml @@ -15,20 +15,21 @@ # limitations under the License. # -name: "pull-request-robot" +name: "pull-request-target-robot" on: pull_request_target: jobs: - labelRobot: + pullRequestTargetRobot: permissions: contents: read pull-requests: write runs-on: ubuntu-latest + timeout-minutes: 10 steps: - name: "Checkout ${{ github.ref }}" - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: persist-credentials: false submodules: true @@ -39,3 +40,8 @@ jobs: repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/actions/labeler/labeler.yml 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 diff --git a/docs/docs/en/contribute/join/pull-request.md b/docs/docs/en/contribute/join/pull-request.md index ad954a7c6e..10b51ba585 100644 --- a/docs/docs/en/contribute/join/pull-request.md +++ b/docs/docs/en/contribute/join/pull-request.md @@ -31,7 +31,7 @@ The corresponding relationship between `Pull Request Type` and `Issue Type` is a Bug Fix - [Fix-3333][server] Fix xxx + [Fix-3333][ui] Fix xxx Improvement @@ -44,9 +44,24 @@ The corresponding relationship between `Pull Request Type` and `Issue Type` is a [Test-3333][api] Add the e2e test of xxx - Sub-Task - (Parent type corresponding to Sub-Task) - [Feature-3333][server] Implement xxx + Doc + Doc + [Doc-3333] Improve xxx + + + E2E + E2E + [E2E-3333] Implement xxx + + + CI + CI + [CI] Improve xxx + + + Chore + Chore + [Chore] Improve xxx diff --git a/docs/docs/zh/contribute/join/pull-request.md b/docs/docs/zh/contribute/join/pull-request.md index e147a0a200..3ee6caf75e 100644 --- a/docs/docs/zh/contribute/join/pull-request.md +++ b/docs/docs/zh/contribute/join/pull-request.md @@ -33,7 +33,7 @@ waste time。 Bug Fix - [Fix-3333][server] Fix xxx + [Fix-3333][ui] Fix xxx Improvement @@ -46,9 +46,23 @@ waste time。 [Test-3333][api] Add the e2e test of xxx - Sub-Task - Sub-Task 对应的父类型 - [Feature-3333][server] Implement xxx + Doc + Doc + [Doc-3333] Improve xxx + + E2E + E2E + [E2E-3333] Implement xxx + + + CI + CI + [CI] Improve xxx + + + Chore + Chore + [Chore] Improve xxx