Merge branch 'main' into issue_263

envoyproxy · Feb 1, 2025 · bc174ec · bc174ec
2 parents cf8deb2 + c7d0187
commit bc174ec
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 14 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,4 @@
-**Commit Message**:
+**Commit Message**
 
 <!--
 Please write the commit message here, which
@@ -11,7 +11,7 @@ text from English to Spanish. This feature is useful for users who want to
 translate text from English to Spanish.
 -->
 
-**Related Issues/PRs (if applicable)**:
+**Related Issues/PRs (if applicable)**
 
 <!--
 Please add the related issues or PRs here.
@@ -23,7 +23,7 @@ Close #12346
 Related PR: #12347
 -->
 
-**Special notes for reviewers (if applicable)**:
+**Special notes for reviewers (if applicable)**
 
 <!--
 Please add any special notes for reviewers here.

diff --git a/.github/workflows/pr_title_check.yaml → .github/workflows/pr_style_check.yaml b/.github/workflows/pr_title_check.yaml → .github/workflows/pr_style_check.yaml
@@ -14,23 +14,28 @@ jobs:
   description:
     name: Description
     runs-on: ubuntu-latest
+    env:
+      # Do not use ${{ github.event.pull_request.body }} directly in run command.
+      BODY: ${{ github.event.pull_request.body }}
     steps:
-      - name: Check PR description
-        env:
-          # Do noe use ${{ github.event.pull_request.body }} directly in run command.
-          TITLE: ${{ github.event.pull_request.body }}
+      - name: Check comment out lines
         run: |
-          if [[ $TITLE =~ "<!--" ]]; then
+          if [[ $BODY =~ "<!--" ]]; then
               echo "PR description contains '<!--'. Please remove all the comment out lines in the template after carefully reading them."
               exit 1
           fi
-          if [[ $TITLE =~ "-->" ]]; then
+          if [[ $BODY =~ "-->" ]]; then
               echo "PR description contains '-->'. Please remove all the comment out lines in the template after carefully reading them."
               exit 1
           fi
-          if [[ ! $TITLE =~ "**Commit Message**:" ]]; then
-              echo "PR description must begin with '**Commit Message**:'."
-              exit 1
+      - name: Check the first line matches '**Commit Message**'
+        run: |
+          first_line=$(echo -n "$BODY" | head -n 1)
+          trimmed_first_line=$(echo "$first_line" | sed 's/[[:space:]]*$//')
+          echo "$trimmed_first_line='$trimmed_first_line'"
+          if [[ "$trimmed_first_line" != "**Commit Message**" ]]; then
+            echo "The first line of the PR description must be '**Commit Message**'"
+            exit 1
           fi
 
   title:
@@ -63,3 +68,16 @@ jobs:
             The subject "{subject}" found in the pull request title "{title}"
             didn't match the configured pattern. Please ensure that the subject
             doesn't start with an uppercase character.
+
+      - name: Check length of PR title
+        env:
+          # Do not use ${{ github.event.pull_request.title }} directly in run command.
+          TITLE: ${{ github.event.pull_request.title }}
+        # We want to make sure that each commit "subject" is under 60 characters not to
+        # be truncated in the git log as well as in the GitHub UI.
+        # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?id=bc7938deaca7f474918c41a0372a410049bd4e13#n664
+        run: |
+          if (( ${#TITLE} >= 60 )); then
+            echo "The PR title is too long. Please keep it under 60 characters."
+            exit 1
+          fi
diff --git a/site/docs/getting-started/installation.md b/site/docs/getting-started/installation.md
@@ -19,8 +19,6 @@ helm upgrade -i aieg oci://ghcr.io/envoyproxy/ai-gateway/ai-gateway-helm \
     --namespace envoy-ai-gateway-system \
     --create-namespace
 
-kubectl wait --timeout=2m -n envoy-ai-gateway-system deployment/ai-gateway-controller --for=create
-
 kubectl wait --timeout=2m -n envoy-ai-gateway-system deployment/ai-gateway-controller --for=condition=Available
 ```