Merge remote-tracking branch 'upstream/develop' into dtrti2

Author: stdlib-bot

.clang-format

@@ -121,7 +121,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]

.editorconfig

@@ -27,3 +27,15 @@ LAPACK:
 Math:
 - changed-files:
   - any-glob-to-all-files: '**/math/**/*'
+
+REPL:
+- changed-files:
+  - any-glob-to-all-files: '**/repl/**/*'
+
+Statistics:
+- changed-files:
+  - any-glob-to-all-files: '**/stats/**/*'
+
+Tools:
+- changed-files:
+  - any-glob-to-all-files: '**/_tools/**/*'

.github/labeler.yml

@@ -62,7 +62,7 @@ jobs:
 
             If you would prefer to avoid manual setup, you could also consider using a pre-configured [development container](https://github.com/stdlib-js/stdlib/tree/develop/.devcontainer) for use locally or in GitHub Codespaces.
 
-            Thank you again for your interest in stdlib, and we look forward to reviewing your future contriubtions.
+            Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.
 
   # Define a job which closes a pull request if a contributor failed to follow contributing guidelines:
   contributor_guidelines:
@@ -98,7 +98,7 @@ jobs:
 
             If you would prefer to avoid manual setup, you could also consider using a pre-configured [development container](https://github.com/stdlib-js/stdlib/tree/develop/.devcontainer) for use locally or in GitHub Codespaces.
 
-            Thank you again for your interest in stdlib, and we look forward to reviewing your future contriubtions.
+            Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.
 
   # Define a job which closes a pull request if a contributor failed to follow project conventions:
   project_conventions:
@@ -138,7 +138,7 @@ jobs:
 
             In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase **before** continuing to work on this pull request.
 
-            Thank you again for your interest in stdlib, and we look forward to reviewing your future contriubtions.
+            Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.
 
   # Define a job which closes a pull request if a pull request is considered spam:
   spam:
@@ -170,7 +170,7 @@ jobs:
           BODY: |
             Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not meet the standards of this project.
 
-            Thank you again for your interest in stdlib, and we look forward to reviewing your future contriubtions.
+            Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.
 
       # Lock pull request conversation:
       - name: 'Lock conversation'
@@ -179,3 +179,35 @@ jobs:
           GH_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
           GH_REPO: ${{ github.repository }}
           NUMBER: ${{ github.event.pull_request.number }}
+
+  # Define a job which closes a pull request if a pull request is considered stale:
+  stale:
+
+    # Define job name:
+    name: 'Check for stale label'
+
+    # 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
+
+    # Define the sequence of job steps:
+    steps:
+      # Close the pull request:
+      - name: 'Close pull request'
+        run: gh pr close "$NUMBER" --comment "$BODY"
+        env:
+          GH_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.pull_request.number }}
+          BODY: |
+            This pull request has been automatically closed because it has been inactive for an extended period after changes were requested. If you still wish to pursue this contribution, feel free to reopen the pull request or submit a new one.
+
+            We appreciate your interest in contributing to stdlib!

.github/workflows/autoclose.yml

@@ -81,7 +81,7 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA
-        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
           node-version: '20' # 'lts/*'
         timeout-minutes: 5
@@ -128,7 +128,7 @@ jobs:
       # Upload the log file:
       - name: 'Upload log file'
         # Pin action to full length commit SHA
-        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
+        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
         if: always()
         with:
           # Define a name for the uploaded artifact:

.github/workflows/check_licenses.yml

@@ -0,0 +1,78 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 The Stdlib Authors.
+#
+# Licensed 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.
+#/
+
+# Workflow name:
+name: cleanup_coverage
+
+# Workflow triggers:
+on:
+
+  # Trigger the workflow when a pull request is closed (e.g., merged or closed without merging):
+  pull_request_target:
+    types:
+      - closed
+
+# Workflow jobs:
+jobs:
+
+  # Define a job to perform coverage cleanup...
+  cleanup:
+
+    # Define a display name:
+    name: 'Cleanup coverage'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Delete the 'pr-<number>' branch from the 'stdlib-js/www-test-code-coverage' repository:
+      - name: 'Delete coverage branch for PR'
+        env:
+          REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: |
+          curl -X DELETE -H "Authorization: token $REPO_GITHUB_TOKEN" \
+            "https://api.github.com/repos/stdlib-js/www-test-code-coverage/git/refs/heads/pr-${PR_NUMBER}" \
+            || echo "Branch pr-${PR_NUMBER} does not exist or could not be deleted."
+
+      # Find and update the '## Coverage Report' comment in the PR
+      - name: 'Update coverage comment in PR'
+        # Pin action to full length commit SHA
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }}
+          script: |
+            const prNumber = context.payload.pull_request.number;
+            const { data: comments } = await github.rest.issues.listComments({
+              'owner': context.repo.owner,
+              'repo': context.repo.repo,
+              'issue_number': prNumber
+            });
+            const coverageComment = comments.find( comment => comment.body && comment.body.includes( '## Coverage Report' ) );
+            if ( coverageComment ) {
+              // Replace URLs with plain text in the coverage report comment body:
+              const updatedBody = coverageComment.body.replace( /<a href="[^"]+">([^<]+)<\/a>/g, '$1' );
+              await github.rest.issues.updateComment({
+                'owner': context.repo.owner,
+                'repo': context.repo.repo,
+                'comment_id': coverageComment.id,
+                'body': updatedBody
+              });
+            } else {
+              console.log( 'No Coverage Report comment found.' );
+            }

.github/workflows/cleanup_coverage.yml

@@ -121,7 +121,7 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA
-        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
           node-version: '20' # 'lts/*'
         timeout-minutes: 5

.github/workflows/codeql.yml

@@ -0,0 +1,103 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 The Stdlib Authors.
+#
+# Licensed 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.
+#/
+
+# Workflow name:
+name: generate_pr_commit_message
+
+# Workflow triggers:
+on:
+  pull_request_target:
+    types:
+      - labeled
+
+# Global permissions:
+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:
+
+  # Job to generate commit message draft:
+  generate-commit-message:
+
+    # Define a display name:
+    name: 'Generate PR Commit Message Draft'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Ensure the job only runs when the specified label is added:
+    if: github.event.label.name == 'Ready to Merge'
+
+    # Define environment variables:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      PR_NUMBER: ${{ github.event.pull_request.number }}
+
+    # Define the sequence of job steps...
+    steps:
+      # Checkout repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+        with:
+          # Fetch all commits to ensure we have the full commit history:
+          fetch-depth: 0
+
+      # Generate commit message:
+      - name: 'Generate commit message'
+        id: commit_message
+        run: |
+          COMMIT_MESSAGE=$($GITHUB_WORKSPACE/.github/workflows/scripts/generate_pr_commit_message $PR_NUMBER)
+          EXIT_CODE=$?
+
+          echo "commit_message<<EOF" >> $GITHUB_OUTPUT
+          echo "$COMMIT_MESSAGE" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          if [ $EXIT_CODE -eq 200 ]; then
+            echo "has_tracking_issue=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_tracking_issue=false" >> $GITHUB_OUTPUT
+          fi
+
+          # Ensure the script itself doesn't fail the workflow:
+          exit 0
+
+      # Post commit message as PR comment:
+      - name: 'Post commit message as PR comment'
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.CHATBOT_GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            ### PR Commit Message
+
+            ```text
+            ${{ steps.commit_message.outputs.commit_message }}
+            ```
+
+            *Please review the above commit message and make any necessary adjustments.*
+
+            ${{ steps.commit_message.outputs.has_tracking_issue == 'true' && '⚠️ **Action Required**: This PR references tracking issues. Please update the PR description to replace any "Closes", "Fixes", or "Resolves" keywords with "Ref" when referencing these issues.' || '' }}