Merge branch 'develop' into issue-5898

Signed-off-by: JaySoni1 <[email protected]>

Author: JaySoni1

.github/workflows/autoclose.yml

@@ -37,11 +37,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: EditorConfig' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -73,11 +68,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: Contributor Guidelines' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -109,11 +99,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: Project Conventions' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -149,11 +134,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: Spam' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -189,12 +169,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: Stale' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      issues: write
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -221,11 +195,6 @@ jobs:
     # Only run this job if the pull request has a specific label:
     if: "${{ github.event.label.name == 'autoclose: Git History' }}"
 
-    # Define job permissions:
-    permissions:
-      contents: read
-      pull-requests: write
-
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 

.github/workflows/check_commit_metadata.yml

@@ -53,14 +53,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Specify whether to remove untracked files before checking out the repository:
-          clean: true
-
-          # Limit clone depth to the most recent commit:
-          fetch-depth: 1
-
-          # Specify whether to download Git-LFS files:
-          lfs: false
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+              .github/workflows/scripts
+          sparse-checkout-cone-mode: false
         timeout-minutes: 10
 
       # Extract commit metadata from commit messages as JSON:

.github/workflows/check_contributing_guidelines_acceptance.yml

@@ -50,9 +50,6 @@ permissions:
   # Allow read-only access to the repository contents:
   contents: read
 
-  # Allow write access to pull requests:
-  pull-requests: write
-
 # Workflow jobs:
 jobs:
 
@@ -75,14 +72,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Specify whether to remove untracked files before checking out the repository:
-          clean: true
-
-          # Limit clone depth to the most recent commit:
-          fetch-depth: 1
-
-          # Specify whether to download Git-LFS files:
-          lfs: false
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+              .github/workflows/scripts
+          sparse-checkout-cone-mode: false
         timeout-minutes: 10
 
       # Check contributing guidelines acceptance:

.github/workflows/create_address_commit_comment_issues.yml

@@ -55,14 +55,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Specify whether to remove untracked files before checking out the repository:
-          clean: false
-
-          # Limit clone depth to the most recent commit:
-          fetch-depth: 1
-
-          # Specify whether to download Git-LFS files:
-          lfs: false
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+              .github/workflows/scripts
+          sparse-checkout-cone-mode: false
         timeout-minutes: 10
 
       # Create issues from commit comments:

.github/workflows/generate_pr_commit_message.yml

@@ -30,12 +30,6 @@ permissions:
   # Allow read-only access to the repository contents:
   contents: read
 
-  # Allow write access to issues, assignees, labels, and milestones:
-  issues: write
-
-  # Allow write access to pull requests:
-  pull-requests: write
-
 # Workflow jobs:
 jobs:
 
@@ -62,8 +56,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Fetch all commits to ensure we have the full commit history:
-          fetch-depth: 0
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+            .github/workflows/scripts
+          sparse-checkout-cone-mode: false
 
       # Generate commit message:
       - name: 'Generate commit message'

.github/workflows/good_first_issue.yml

@@ -40,7 +40,6 @@ jobs:
     # Define job permissions:
     permissions:
       contents: read
-      pull-requests: write
 
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest

.github/workflows/label_good_first_prs.yml

@@ -43,8 +43,8 @@ jobs:
 
     # Define job permissions:
     permissions:
+      # Allow read-only access to the repository contents:
       contents: read
-      pull-requests: write
 
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
@@ -56,14 +56,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Specify whether to remove untracked files before checking out the repository:
-          clean: true
-
-          # Limit clone depth to the most recent commit:
-          fetch-depth: 1
-
-          # Specify whether to download Git-LFS files:
-          lfs: false
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+              .github/workflows/scripts
+          sparse-checkout-cone-mode: false
         timeout-minutes: 10
 
       # Check whether any of the referenced issues is a "Good First Issue":

.github/workflows/labeler.yml

@@ -49,7 +49,6 @@ jobs:
     # Define job permissions:
     permissions:
       contents: read
-      pull-requests: write
 
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest

.github/workflows/lint_pr_title.yml

@@ -62,8 +62,8 @@ jobs:
           # Specify whether to remove untracked files before checking out the repository:
           clean: false
 
-          # Limit clone depth to the most recent 100 commits:
-          fetch-depth: 100
+          # Limit clone depth to the most recent commit:
+          fetch-depth: 1
 
           # Specify whether to download Git-LFS files:
           lfs: false
@@ -90,5 +90,7 @@ jobs:
         run: |
           echo "Pull request titles should follow stdlib's Git commit message conventions."
           echo "Linting pull request title..."
-          make lint-commit-message GIT_COMMIT_MESSAGE="${PR_TITLE}"
+          PR_TITLE_FILE="${GITHUB_WORKSPACE}/pr_title.txt"
+          printf '%s\n' "$PR_TITLE" > "$PR_TITLE_FILE"
+          make lint-commit-files FILES="$PR_TITLE_FILE"
         timeout-minutes: 5

.github/workflows/lint_random_files.yml

@@ -230,6 +230,12 @@ jobs:
           \`\`\`
           $(cat lint_editorconfig_errors.txt | strip_ansi)
           \`\`\`
+
+          ### Pull Request Instructions
+
+          -   Please use the following PR title format:
+          "chore: fix EditorConfig lint errors (issue #<ISSUE_NUMBER>)".
+          -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
@@ -370,20 +376,26 @@ jobs:
         run: |
           BODY_FILE="$GITHUB_WORKSPACE/lint_issue_body.md"
           cat << EOF > "$BODY_FILE"
-          ## JavaScript Linting Failures
+            ## JavaScript Linting Failures
 
-          Linting failures were detected in the automated JavaScript lint workflow run.
+            Linting failures were detected in the automated JavaScript lint workflow run.
 
-          ### Workflow Details
+            ### Workflow Details
 
-          - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
-          - Type: JavaScript Linting
-          - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
+            - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+            - Type: JavaScript Linting
+            - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
 
-          ### Error Details
-          \`\`\`
-          $(cat lint_javascript_errors.txt)
-          \`\`\`
+            ### Error Details
+            \`\`\`
+            $(cat lint_javascript_errors.txt)
+            \`\`\`
+
+            ### Pull Request Instructions
+
+            -   Please use the following PR title format:
+            "chore: fix JavaScript lint errors (issue #<ISSUE_NUMBER>)".
+            -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
@@ -524,6 +536,12 @@ jobs:
           \`\`\`
           $(grep -B 1 -A 2 "style:\|warning:\|error:" "lint_c_errors.txt")
           \`\`\`
+
+          ### Pull Request Instructions
+
+          -   Please use the following PR title format:
+          "chore: fix C lint errors (issue #<ISSUE_NUMBER>)".
+          -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \