HDDS-9603. Add PR title check (#69)
(cherry picked from commit d792ed1adb29f02df2c1f5ee389881ad6d4a8900)
diff --git a/.github/scripts/pr_title_check.sh b/.github/scripts/pr_title_check.sh
new file mode 100755
index 0000000..f50004a
--- /dev/null
+++ b/.github/scripts/pr_title_check.sh
@@ -0,0 +1,57 @@
+#!/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.
+
+TITLE=$1
+
+assertMatch() {
+ echo "${TITLE}" | grep -E "$1" >/dev/null
+ ret=$?
+ if [ $ret -ne 0 ]; then
+ echo $2
+ exit 1
+ fi
+}
+
+assertNotMatch() {
+ echo "${TITLE}" | grep -E -v "$1" >/dev/null
+ ret=$?
+ if [ $ret -ne 0 ]; then
+ echo $2
+ exit 1
+ fi
+}
+
+# strip starting 'Revert "', if any
+TITLE=${TITLE#Revert \"}
+if [ "$1" != "${TITLE}" ]; then
+ echo "Leading 'Revert \"' in the PR title has been stripped solely for this title checking purpose. Performing actual title check on:"
+ echo "${TITLE}"
+fi
+
+assertMatch '^HDDS' 'Fail: must start with HDDS'
+assertMatch '^HDDS-' 'Fail: missing dash in Jira'
+assertNotMatch '^HDDS-0' 'Fail: leading zero in Jira'
+assertMatch '^HDDS-[1-9][0-9]{0,4}[^0-9]' 'Fail: Jira must be 1 to 5 digits'
+assertMatch '^HDDS-[1-9][0-9]{0,4}\.' 'Fail: missing dot after Jira'
+assertMatch '^HDDS-[1-9][0-9]{0,4}\. ' 'Fail: missing space after Jira'
+assertNotMatch '[[:space:]]$' 'Fail: trailing space'
+assertNotMatch '\.{3,}$' 'Fail: trailing ellipsis indicates title is cut'
+assertNotMatch '…$' 'Fail: trailing ellipsis indicates title is cut'
+assertNotMatch '[[:space:]]{2}' 'Fail: two consecutive spaces'
+assertMatch '^HDDS-[1-9][0-9]{0,4}\. .*[^ ]$' 'Fail: not match "^HDDS-[1-9][0-9]{0,4}\. .*[^ ]$"'
+
+echo 'OK'
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
new file mode 100644
index 0000000..e4d0ab2
--- /dev/null
+++ b/.github/workflows/pull-request.yml
@@ -0,0 +1,37 @@
+# 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.
+
+name: pull request
+
+on:
+ pull_request:
+ types:
+ - reopened
+ - opened
+ - edited
+ - synchronize
+
+jobs:
+ title:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout project
+ uses: actions/checkout@v4
+ - name: Check pull request title
+ env:
+ TITLE: ${{ github.event.pull_request.title }}
+ run:
+ .github/scripts/pr_title_check.sh "${TITLE}"
+
