martin-g commented on code in PR #18660: URL: https://github.com/apache/datafusion/pull/18660#discussion_r2521938963
########## dev/release/add-branch-protection.sh: ########## @@ -0,0 +1,160 @@ +#!/usr/bin/env bash +# 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 -e + +# Script to add branch protection for a new release branch in .asf.yaml +# +# This script automates the process of adding branch protection rules to .asf.yaml +# for new release branches. It ensures the branch protection block doesn't already +# exist before adding it. +# +# Usage: +# ./dev/release/add-branch-protection.sh <release_number> +# +# Examples: +# ./dev/release/add-branch-protection.sh 52 +# ./dev/release/add-branch-protection.sh 53 +# +# The script will: +# 1. Validate the release number is a positive integer +# 2. Check if branch protection already exists for branch-<release_number> +# 3. Add the branch protection block to .asf.yaml if it doesn't exist +# 4. Error out if the block already exists + +# Check if release number is provided +if [ $# -eq 0 ]; then + echo "Error: Release number is required" + echo "Usage: $0 <release_number>" + echo "Example: $0 52" + exit 1 +fi + +RELEASE_NUM=$1 +BRANCH_NAME="branch-${RELEASE_NUM}" +ASF_YAML_FILE=".asf.yaml" + +# Validate release number is a positive integer +if ! [[ "$RELEASE_NUM" =~ ^[0-9]+$ ]]; then + echo "Error: Release number must be a positive integer" + echo "Provided: $RELEASE_NUM" + echo "Example: ./dev/release/add-branch-protection.sh 52" + exit 1 +fi + +# Check if .asf.yaml exists +if [ ! -f "$ASF_YAML_FILE" ]; then + echo "Error: $ASF_YAML_FILE not found in current directory" + echo "Please run this script from the repository root" + exit 1 +fi + +# Check if the branch exists in the official Apache DataFusion repository +GITHUB_API_URL="https://api.github.com/repos/apache/datafusion/branches/${BRANCH_NAME}"; +HTTP_STATUS=$(curl -s -o /dev/null -w "%{http_code}" "$GITHUB_API_URL") + +if [ "$HTTP_STATUS" != "200" ]; then + echo "Error: Branch ${BRANCH_NAME} does not exist in the official Apache DataFusion repository" + echo "Please create the branch '${BRANCH_NAME}' first before adding branch protection" + echo "" + echo "To check existing branches, visit:" + echo " https://github.com/apache/datafusion/branches"; + exit 1 +fi + +# Check if branch protection already exists for this release +if grep -q "^[[:space:]]*${BRANCH_NAME}:" "$ASF_YAML_FILE"; then + echo "Error: Branch protection for ${BRANCH_NAME} already exists in $ASF_YAML_FILE" + exit 1 +fi + +# Create a temporary file +TEMP_FILE=$(mktemp) + +# Read the file and insert the new branch protection block Review Comment: Have you considered using `yq` or similar command line YAML tool to insert the new item ? The syntax would be something like: ```shell yq -i ".github.protected_branches += [{\"${BRANCH_NAME}\": {\"required_pull_request_reviews\": {\"required_approving_review_count\": 1}}}]" ${ASF_YAML_FILE} ``` It requires installing a third-party tool but would avoid the AWK script below. ########## dev/release/add-branch-protection.sh: ########## @@ -0,0 +1,160 @@ +#!/usr/bin/env bash +# 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 -e Review Comment: ```suggestion set -eu ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
