Browse Source

[ci] Milestone and Label are required before the PR merged (#12222)

To make our release process easier, I plan to mark milestone
and label is required before the PR merged, they use for

* label: In this path we required label with at least on with
  'feature|bug|improvement|document|chore' to make our changelog
  more convenient
* milestone: For easier to cherry-pick PR, currently some of
  our milestone only exists in issue and not exists in related
  PR, it may
labbomb
Jiajie Zhong 2 years ago committed by GitHub
parent
commit
a973054950
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 1
      .asf.yaml
  2. 2
      .github/ISSUE_TEMPLATE/feature-request.yml
  3. 14
      .github/mergeable.yml
  4. 4
      .github/workflows/stale.yml
  5. 2
      docs/docs/en/contribute/join/commit-message.md
  6. 2
      docs/docs/en/contribute/join/contribute.md
  7. 2
      docs/docs/en/contribute/join/issue.md

1
.asf.yaml

@ -45,6 +45,7 @@ github:
- Build - Build
- Unit Test - Unit Test
- E2E - E2E
- "Mergeable: milestone-label-check"
required_pull_request_reviews: required_pull_request_reviews:
dismiss_stale_reviews: true dismiss_stale_reviews: true
required_approving_review_count: 1 required_approving_review_count: 1

2
.github/ISSUE_TEMPLATE/feature-request.yml

@ -17,7 +17,7 @@
name: Feature request name: Feature request
description: Suggest an idea for this project description: Suggest an idea for this project
title: "[Feature][Module Name] Feature title" title: "[Feature][Module Name] Feature title"
labels: [ "new feature", "Waiting for reply" ] labels: [ "feature", "Waiting for reply" ]
body: body:
- type: markdown - type: markdown
attributes: attributes:

14
.github/mergeable.yml

@ -22,7 +22,7 @@ mergeable:
# GitHub action workflow `pull_requests` https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request like, # GitHub action workflow `pull_requests` https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request like,
# which only trigger runs when a pull_request event's activity type is opened, synchronize, or reopened # which only trigger runs when a pull_request event's activity type is opened, synchronize, or reopened
- when: pull_request.opened, pull_request.reopened, pull_request.synchronize - when: pull_request.opened, pull_request.reopened, pull_request.synchronize
name: synchronize change for sql files name: sync-sql-ddl
validate: validate:
# Sql files must change synchronize # Sql files must change synchronize
- do: dependent - do: dependent
@ -44,3 +44,15 @@ mergeable:
pass: pass:
- do: labels - do: labels
delete: 'sql not sync' delete: 'sql not sync'
- when: pull_request.*
name: milestone-label-check
validate:
- do: milestone
no_empty:
enabled: true # Cannot be empty when true.
message: 'Milestone is required and cannot be empty.'
- do: label
must_include:
regex: 'feature|bug|improvement|document|chore'
message: 'Label must include one of the following: `feature`, `bug`, `improvement`, `document`, `chore`'

4
.github/workflows/stale.yml

@ -32,8 +32,8 @@ jobs:
# Stale Issues # Stale Issues
days-before-issue-stale: 30 days-before-issue-stale: 30
days-before-issue-close: 7 days-before-issue-close: 7
# We do not stale Issues with label `Waiting for reply`, `new feature` and `DSIP` # We do not stale Issues with label `Waiting for reply`, `feature` and `DSIP`
exempt-issue-labels: 'Waiting for reply,new feature,DSIP,security' exempt-issue-labels: 'Waiting for reply,feature,DSIP,security'
stale-issue-message: > stale-issue-message: >
This issue has been automatically marked as stale because it has not had recent activity This issue has been automatically marked as stale because it has not had recent activity
for 30 days. It will be closed in next 7 days if no further activity occurs. for 30 days. It will be closed in next 7 days if no further activity occurs.

2
docs/docs/en/contribute/join/commit-message.md

@ -29,7 +29,7 @@ The header part has only one line, including three fields: type (required), scop
(1) Type is used to indicate the category of commit, and only the following 7 types are allowed. (1) Type is used to indicate the category of commit, and only the following 7 types are allowed.
- feat:New features - feat:features
- fix:Bug fixes - fix:Bug fixes
- docs:Documentation - docs:Documentation
- style: Format (does not affect changes in code operation) - style: Format (does not affect changes in code operation)

2
docs/docs/en/contribute/join/contribute.md

@ -31,7 +31,7 @@ Refer to the [Submit Guide-Issue Notice](./issue.md), [Submit Guide-Pull Request
If you want to implement a Feature or fix a Bug. Please refer to the following: If you want to implement a Feature or fix a Bug. Please refer to the following:
* All Bugs and the new Features are recommended and managed using the Issues Page. * All bugs and the features are recommended and managed using the GitHub issues(https://github.com/apache/dolphinscheduler/issues).
* If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment. * If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment.
* It's a good idea to find a mentor (or an instructor) in the core contributors who gives immediate feedback on design and functional implementation. * It's a good idea to find a mentor (or an instructor) in the core contributors who gives immediate feedback on design and functional implementation.
* You should create a new branch to start your work, to get the name of the branch refer to the [Submit Guide-Pull Request Notice](./pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor. * You should create a new branch to start your work, to get the name of the branch refer to the [Submit Guide-Pull Request Notice](./pull-request.md). For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor.

2
docs/docs/en/contribute/join/issue.md

@ -30,7 +30,7 @@ The `Issue Type` is as follows:
<tbody> <tbody>
<tr> <tr>
<td style="text-align: center;">Feature</td> <td style="text-align: center;">Feature</td>
<td style="text-align: center;">Include expected new features and functions</td> <td style="text-align: center;">Include expected features and functions</td>
<td style="text-align: center;">[Feature][api] Add xxx api in xxx controller</td> <td style="text-align: center;">[Feature][api] Add xxx api in xxx controller</td>
</tr> </tr>
<tr> <tr>

Loading…
Cancel
Save