thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-25 09:02:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #64890 from ClickHouse/fix-check-documentation

Browse Source 
Fix documentation enforcement
This commit is contained in:
Mikhail f. Shiryaev 2024-06-06 11:41:08 +00:00 committed by GitHub
commit 259e877d0d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
tests/ci/run_check.py
View File

@ -23,7 +23,7 @@ from lambda_shared_package.lambda_shared.pr import (
check_pr_description, check_pr_description,
) )
from pr_info import PRInfo from pr_info import PRInfo
from report import FAILURE, PENDING, SUCCESS from report import FAILURE, PENDING, SUCCESS, StatusType
TRUSTED_ORG_IDS = { TRUSTED_ORG_IDS = {
54801242, # clickhouse 54801242, # clickhouse
@ -58,7 +58,7 @@ def pr_is_by_trusted_user(pr_user_login, pr_user_orgs):
# Returns can_run, description # Returns can_run, description
def should_run_ci_for_pr(pr_info: PRInfo) -> Tuple[bool, str]: def should_run_ci_for_pr(pr_info: PRInfo) -> Tuple[bool, str]:
# Consider the labels and whether the user is trusted. # Consider the labels and whether the user is trusted.
print("Got labels", pr_info.labels) logging.info("Got labels: %s", pr_info.labels)
if OK_SKIP_LABELS.intersection(pr_info.labels): if OK_SKIP_LABELS.intersection(pr_info.labels):
return True, "Don't try new checks for release/backports/cherry-picks" return True, "Don't try new checks for release/backports/cherry-picks"
@ -66,9 +66,10 @@ def should_run_ci_for_pr(pr_info: PRInfo) -> Tuple[bool, str]:
if Labels.CAN_BE_TESTED not in pr_info.labels and not pr_is_by_trusted_user( if Labels.CAN_BE_TESTED not in pr_info.labels and not pr_is_by_trusted_user(
pr_info.user_login, pr_info.user_orgs pr_info.user_login, pr_info.user_orgs
): ):
print( logging.info(
f"PRs by untrusted users need the '{Labels.CAN_BE_TESTED}' label - " "PRs by untrusted users need the '%s' label - "
"please contact a member of the core team" "please contact a member of the core team",
Labels.CAN_BE_TESTED,
) )
return False, "Needs 'can be tested' label" return False, "Needs 'can be tested' label"
@ -93,6 +94,7 @@ def main():
description = format_description(description) description = format_description(description)
gh = Github(get_best_robot_token(), per_page=100) gh = Github(get_best_robot_token(), per_page=100)
commit = get_commit(gh, pr_info.sha) commit = get_commit(gh, pr_info.sha)
status = SUCCESS # type: StatusType
description_error, category = check_pr_description(pr_info.body, GITHUB_REPOSITORY) description_error, category = check_pr_description(pr_info.body, GITHUB_REPOSITORY)
pr_labels_to_add = [] pr_labels_to_add = []
@ -125,13 +127,16 @@ def main():
f"::notice :: Add backport labels [{backport_labels}] for a given PR category" f"::notice :: Add backport labels [{backport_labels}] for a given PR category"
) )
print(f"Change labels: add {pr_labels_to_add}, remove {pr_labels_to_remove}") logging.info(
"Change labels: add %s, remove %s", pr_labels_to_add, pr_labels_to_remove
)
if pr_labels_to_add: if pr_labels_to_add:
post_labels(gh, pr_info, pr_labels_to_add) post_labels(gh, pr_info, pr_labels_to_add)
if pr_labels_to_remove: if pr_labels_to_remove:
remove_labels(gh, pr_info, pr_labels_to_remove) remove_labels(gh, pr_info, pr_labels_to_remove)
# 1. Next three IFs are in a correct order. First - fatal error
if description_error: if description_error:
print( print(
"::error ::Cannot run, PR description does not match the template: " "::error ::Cannot run, PR description does not match the template: "
@ -146,9 +151,10 @@ def main():
f"{GITHUB_SERVER_URL}/{GITHUB_REPOSITORY}/" f"{GITHUB_SERVER_URL}/{GITHUB_REPOSITORY}/"
"blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1" "blob/master/.github/PULL_REQUEST_TEMPLATE.md?plain=1"
) )
status = FAILURE
post_commit_status( post_commit_status(
commit, commit,
FAILURE, status,
url, url,
format_description(description_error), format_description(description_error),
PR_CHECK, PR_CHECK,
@ -156,41 +162,38 @@ def main():
) )
sys.exit(1) sys.exit(1)
# 2. Then we check if the documentation is not created to fail the Mergeable check
if ( if (
Labels.PR_FEATURE in pr_info.labels Labels.PR_FEATURE in pr_info.labels
and not pr_info.has_changes_in_documentation() and not pr_info.has_changes_in_documentation()
): ):
print( print(
f"The '{Labels.PR_FEATURE}' in the labels, " f"::error ::The '{Labels.PR_FEATURE}' in the labels, "
"but there's no changed documentation" "but there's no changed documentation"
) )
post_commit_status( status = FAILURE
commit, description = f"expect adding docs for {Labels.PR_FEATURE}"
FAILURE, # 3. But we allow the workflow to continue
"",
f"expect adding docs for {Labels.PR_FEATURE}",
PR_CHECK,
pr_info,
)
# allow the workflow to continue
# 4. And post only a single commit status on a failure
if not can_run: if not can_run:
post_commit_status( post_commit_status(
commit, commit,
FAILURE, status,
"", "",
description, description,
PR_CHECK, PR_CHECK,
pr_info, pr_info,
) )
print("::notice ::Cannot run") print("::error ::Cannot run")
sys.exit(1) sys.exit(1)
# The status for continue can be posted only one time, not more.
post_commit_status( post_commit_status(
commit, commit,
SUCCESS, status,
"", "",
"ok", description,
PR_CHECK, PR_CHECK,
pr_info, pr_info,
) )