OAK-11269 Commit Message Check

.commit-check.yml

@@ -0,0 +1,32 @@
+# 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.
+
+# format as outlined in https://github.com/commit-check/commit-check/blob/main/.commit-check.yml
+# further information in https://github.com/commit-check/commit-check/blob/main/README.rst
+checks:
+  - check: message
+    regex: '^OAK-\d+\s\S+.*'
+    error: "The commit message must start with 'OAK-<ID> ' followed by some descriptive text"
+    suggest: Please check your commit message whether it matches above regex
+
+  - check: author_name
+    regex: ^[A-Za-z ,.\'-]+$|.*(\[bot])
+    error: The committer name seems invalid
+    suggest: run command `git config user.name "Your Name"`
+
+  - check: author_email
+    regex: ^.+@.+$
+    error: The committer email seems invalid
+    suggest: run command `git config user.email [email protected]`

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-#   ~ Licensed to the Apache Software Foundation (ASF) under one
+#  ~ 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

.github/workflows/commit-check.yml

@@ -0,0 +1,49 @@
+#  ~ 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: Commit Check
+
+on:
+  pull_request:
+    branches: 'trunk'
+
+jobs:
+  commit-check:
+    runs-on: ubuntu-latest
+    permissions:  # use permissions because of use pr-comments
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}  # checkout PR HEAD commit
+          fetch-depth: 0  # required for merge-base check
+      # https://github.com/commit-check
+      # must be pinned due to https://infra.apache.org/github-actions-policy.html
+      - uses: commit-check/commit-check-action@8d507e12899a9feb405c3ed546252ff9508724e0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments
+        with:
+          # check commit message formatting convention
+          message: true
+          branch: true
+          author-name: true
+          author-email: true
+          commit-signoff: false
+          merge-base: false
+          job-summary: true
+          pr-comments: ${{ github.event_name == 'pull_request' }}

.github/workflows/stale.yml

@@ -1,4 +1,4 @@
-#   ~ Licensed to the Apache Software Foundation (ASF) under one
+#  ~ 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