This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/paimon-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 8a37da3 fix: remove invalid gh-pages key from .asf.yaml and add CI
validation (#159)
8a37da3 is described below
commit 8a37da306fe7b0b3acf2f70854bb12abbba72394
Author: XiaoHongbo <[email protected]>
AuthorDate: Mon Mar 30 13:26:29 2026 +0800
fix: remove invalid gh-pages key from .asf.yaml and add CI validation (#159)
The gh-pages key under github.features is not in the ASF .asf.yaml schema,
causing ASF infra errors after merge. Add a validation script to catch such
issues in CI before merge.
---
.asf.yaml | 2 -
.github/workflows/ci.yml | 3 +
scripts/validate_asf_yaml.py | 151 +++++++++++++++++++++++++++++++++++++++++++
3 files changed, 154 insertions(+), 2 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 0fc2e97..7480dfd 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -37,8 +37,6 @@ github:
discussions: true
wiki: false
projects: false
- gh-pages:
- whatever: Just a placeholder to make it take effects
protected_branches:
main:
required_pull_request_reviews:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index df0aebd..d53e58e 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -35,6 +35,9 @@ jobs:
steps:
- uses: actions/checkout@v4
+ - name: Validate .asf.yaml
+ run: python3 scripts/validate_asf_yaml.py
+
- name: Check License Header
uses: apache/skywalking-eyes/[email protected]
diff --git a/scripts/validate_asf_yaml.py b/scripts/validate_asf_yaml.py
new file mode 100644
index 0000000..c5534e7
--- /dev/null
+++ b/scripts/validate_asf_yaml.py
@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+# 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.
+
+"""Validate .asf.yaml against known ASF infrastructure schema.
+
+Reference: https://github.com/apache/infrastructure-asfyaml/blob/main/README.md
+"""
+
+import sys
+import yaml
+
+ASF_YAML_PATH = ".asf.yaml"
+
+# Known top-level keys in .asf.yaml
+VALID_TOP_LEVEL_KEYS = {
+ "github",
+ "notifications",
+ "staging",
+ "publish",
+ "pelican",
+}
+
+# Known keys under 'github'
+VALID_GITHUB_KEYS = {
+ "description",
+ "homepage",
+ "labels",
+ "features",
+ "enabled_merge_buttons",
+ "protected_branches",
+ "collaborators",
+ "autolinks",
+ "environments",
+ "dependabot_alerts",
+ "dependabot_updates",
+ "code_scanning",
+ "del_branch_on_merge",
+ "ghp_branch",
+ "ghp_path",
+}
+
+# Known keys under 'github.features'
+VALID_FEATURES_KEYS = {
+ "issues",
+ "discussions",
+ "wiki",
+ "projects",
+}
+
+# Known keys under 'github.enabled_merge_buttons'
+VALID_MERGE_BUTTON_KEYS = {
+ "squash",
+ "merge",
+ "rebase",
+}
+
+# Known keys under 'notifications'
+VALID_NOTIFICATIONS_KEYS = {
+ "commits",
+ "issues",
+ "pullrequests",
+ "jira_options",
+ "jobs",
+ "discussions",
+}
+
+
+def validate():
+ errors = []
+
+ try:
+ with open(ASF_YAML_PATH, "r") as f:
+ data = yaml.safe_load(f)
+ except FileNotFoundError:
+ print(f"SKIP: {ASF_YAML_PATH} not found")
+ return 0
+ except yaml.YAMLError as e:
+ print(f"ERROR: Invalid YAML syntax in {ASF_YAML_PATH}: {e}")
+ return 1
+
+ if not isinstance(data, dict):
+ print(f"ERROR: {ASF_YAML_PATH} root must be a mapping")
+ return 1
+
+ # Check top-level keys
+ for key in data:
+ if key not in VALID_TOP_LEVEL_KEYS:
+ errors.append(f"unexpected top-level key '{key}'")
+
+ github = data.get("github")
+ if isinstance(github, dict):
+ for key in github:
+ if key not in VALID_GITHUB_KEYS:
+ errors.append(f"unexpected key 'github.{key}'")
+
+ features = github.get("features")
+ if isinstance(features, dict):
+ for key in features:
+ if key not in VALID_FEATURES_KEYS:
+ errors.append(
+ f"unexpected key 'github.features.{key}' "
+ f"(allowed: {', '.join(sorted(VALID_FEATURES_KEYS))})"
+ )
+ elif not isinstance(features[key], bool):
+ errors.append(
+ f"'github.features.{key}' must be a boolean, "
+ f"got {type(features[key]).__name__}"
+ )
+
+ merge_buttons = github.get("enabled_merge_buttons")
+ if isinstance(merge_buttons, dict):
+ for key in merge_buttons:
+ if key not in VALID_MERGE_BUTTON_KEYS:
+ errors.append(
+ f"unexpected key 'github.enabled_merge_buttons.{key}' "
+ f"(allowed: {',
'.join(sorted(VALID_MERGE_BUTTON_KEYS))})"
+ )
+
+ notifications = data.get("notifications")
+ if isinstance(notifications, dict):
+ for key in notifications:
+ if key not in VALID_NOTIFICATIONS_KEYS:
+ errors.append(f"unexpected key 'notifications.{key}'")
+
+ if errors:
+ print(f"ERROR: {ASF_YAML_PATH} validation failed:")
+ for err in errors:
+ print(f" - {err}")
+ return 1
+
+ print(f"OK: {ASF_YAML_PATH} is valid")
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(validate())
