Merge branch 'develop' into feature/add

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

Author: kgryte

.github/workflows/pr_commands_comment.yml

@@ -29,6 +29,11 @@ on:
         description: 'Pull request number'
         required: true
         type: number
+      debug:
+        description: 'Enable debug output'
+        required: false
+        default: false
+        type: boolean
 
     # Define the secrets accessible by the workflow:
     secrets:
@@ -43,6 +48,14 @@ on:
         description: 'Pull request number'
         required: true
         type: number
+      debug:
+        description: 'Enable debug output'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'true'
+          - 'false'
 
 # Global permissions:
 permissions:
@@ -63,11 +76,23 @@ jobs:
 
     # Define the sequence of job steps...
     steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        # Pin action to full length commit SHA
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          # Ensure we have access to the scripts directory:
+          sparse-checkout: |
+              .github/workflows/scripts
+          sparse-checkout-cone-mode: false
+        timeout-minutes: 10
 
       # Leave comment with package make command instructions:
       - name: 'Leave comment with package make command instructions'
         env:
           PR_NUMBER: ${{ inputs.pull_request_number }}
+          GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN || secrets.STDLIB_BOT_PAT_REPO_WRITE }}
+          DEBUG: ${{ inputs.debug || 'false' }}
         run: |
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/package_commands_comment" "$PR_NUMBER"
         timeout-minutes: 30

.github/workflows/random_benchmarks.yml

@@ -0,0 +1,95 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2025 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: random_benchmarks
+
+# Workflow triggers:
+on:
+  # Trigger the workflow every 24 hours:
+  schedule:
+    - cron: '0 0 * * *'
+
+  # Allow the workflow to be manually run:
+  workflow_dispatch:
+
+# Global permissions:
+permissions:
+  # Allow read-only access to the repository contents:
+  contents: read
+
+# Workflow jobs:
+jobs:
+
+  # Define a job for running random benchmarks...
+  process:
+
+    # Define a display name:
+    name: 'Run random benchmarks'
+
+    # Ensure the job does not run on forks:
+    if: github.repository == 'stdlib-js/stdlib'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the sequence of job steps...
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        # 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 last 1000 commits:
+          fetch-depth: 1000
+
+          # Specify whether to download Git-LFS files:
+          lfs: false
+
+          # Avoid storing GitHub token in local Git configuration:
+          persist-credentials: false
+        timeout-minutes: 10
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        with:
+          node-version: '18' # 'lts/*'
+        timeout-minutes: 5
+
+      # Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
+      - name: 'Install dependencies'
+        run: |
+          make install-node-modules || make install-node-modules || make install-node-modules
+        timeout-minutes: 15
+
+      # Run JavaScript and native add-on benchmarks:
+      - name: 'Run JavaScript and native add-on benchmarks'
+        run: |
+          make benchmark-random-javascript RANDOM_SELECTION_SIZE=50 BUILD_ADDONS=1
+        timeout-minutes: 60
+
+      # Run C benchmarks:
+      - name: 'Run C benchmarks'
+        run: |
+          make benchmark-random-c RANDOM_SELECTION_SIZE=10
+        timeout-minutes: 60

.github/workflows/random_examples.yml

@@ -87,3 +87,9 @@ jobs:
         run: |
           make examples-random-javascript RANDOM_SELECTION_SIZE=50
         timeout-minutes: 60
+
+      # Run C examples:
+      - name: 'Run C examples'
+        run: |
+          make examples-random-c RANDOM_SELECTION_SIZE=10
+        timeout-minutes: 60

.github/workflows/run_affected_benchmarks.yml

@@ -50,10 +50,12 @@ jobs:
 
   # Define a job for running changed benchmarks...
   process:
-
     # Define a display name:
     name: 'Run affected benchmarks'
 
+    # Only run this job if a pull request does not have a "ci: Skip" label:
+    if: "${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'ci: Skip') }}"
+
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -149,4 +151,4 @@ jobs:
             directories="${{ steps.changed-directories.outputs.directories }}"
           fi
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/run_affected_benchmarks" "$directories"
-        timeout-minutes: 30
+        timeout-minutes: 60

.github/workflows/run_affected_examples.yml

@@ -51,6 +51,9 @@ jobs:
     # Define a display name:
     name: 'Run changed examples'
 
+    # Only run this job if a pull request does not have a "ci: Skip" label:
+    if: "${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'ci: Skip') }}"
+
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 

.github/workflows/run_affected_tests.yml

@@ -86,6 +86,9 @@ jobs:
     # Define a display name:
     name: 'Run affected tests'
 
+    # Only run this job if a pull request does not have a "ci: Skip" label:
+    if: "${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'ci: Skip') }}"
+
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 

.github/workflows/run_tests_coverage.yml

@@ -86,6 +86,9 @@ jobs:
     # Define a display name:
     name: 'Calculate test coverage for packages'
 
+    # Only run this job if a pull request does not have a "ci: Skip" label:
+    if: "${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'ci: Skip') }}"
+
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 

.github/workflows/scripts/lint_package_json_files

@@ -32,18 +32,30 @@ root=$(git rev-parse --show-toplevel)
 # Define the path to a utility for linting package.json files:
 lint_package_json="${root}/lib/node_modules/@stdlib/_tools/lint/pkg-json/bin/cli"
 
+# Define the path to the package name validation tool:
+validate_package_names="${root}/lib/node_modules/@stdlib/_tools/lint/pkg-json-names/bin/cli"
+
 # Define paths to utilities for updating package.json metadata fields:
 update_package_json_directories="${root}/lib/node_modules/@stdlib/_tools/package-json/scripts/update_directories"
 update_package_json_gypfile="${root}/lib/node_modules/@stdlib/_tools/package-json/scripts/update_gypfile"
 
 # Files to process:
 files_to_process="$*"
 
+# Initialize needs_changes flag:
+needs_changes=0
+
 # Lint package.json files:
 files=$(echo "${files_to_process}" | tr ' ' '\n' | grep 'package\.json$' | grep -v 'datapackage\.json$' | tr '\n' ' ' | sed 's/ $//')
 if [ -n "${files}" ]; then
 	echo "Linting package.json files..."
 	printf '%s' "${files}" | "${lint_package_json}" --split=" "
+
+	echo "Validating package names..."
+	if ! printf '%s' "${files}" | "${validate_package_names}" --split=" "; then
+		echo "ERROR: Package name validation failed"
+		needs_changes=1
+	fi
 else
 	echo "No package.json files to lint."
 fi
@@ -55,8 +67,6 @@ dirs=$(echo "${files_to_process}" | tr ' ' '\n' | \
 	sort -u)
 
 echo "Checking package.json files in directories: ${dirs}"
-
-needs_changes=0
 for dir in ${dirs}; do
 	echo "Checking package.json in ${dir}..."
 	package_json="${dir}/package.json"

.github/workflows/scripts/package_commands_comment

@@ -27,6 +27,7 @@
 # Environment variables:
 #
 #   GITHUB_TOKEN   GitHub token for authentication.
+#   DEBUG          Whether to enable verbose debug output. Default: `false`.
 
 # Ensure that the exit status of pipelines is non-zero in the event that at least one of the commands in a pipeline fails:
 set -o pipefail
@@ -44,9 +45,22 @@ github_api_url="https://api.github.com"
 repo_owner="stdlib-js"
 repo_name="stdlib"
 
+# Set debug mode:
+debug="${DEBUG:-false}"
+
 
 # FUNCTIONS #
 
+# Prints debug messages if DEBUG environment variable is set to "true".
+#
+# $1 - debug message
+debug_log() {
+	# Only print debug messages if DEBUG environment variable is set to "true":
+	if [ "$debug" = true ]; then
+		echo "[DEBUG] $1" >&2
+	fi
+}
+
 # Error handler.
 #
 # $1 - error status
@@ -70,6 +84,8 @@ github_api() {
 	local endpoint="$2"
 	local data="$3"
 
+	debug_log "Making API request: ${method} ${endpoint}"
+
 	# Initialize an array to hold curl headers:
 	local headers=()
 
@@ -117,12 +133,20 @@ main() {
 		on_error 1
 	fi
 
+	debug_log "Processing PR #${pr_number}"
+
 	# Fetch changed files in pull request:
 	response=$(github_api "GET" "/repos/${repo_owner}/${repo_name}/pulls/${pr_number}/files?per_page=100")
 	files=$(echo "${response}" | jq -r '.[] | .filename')
+	debug_log "Found $(echo "${files}" | wc -l) changed files"
 
 	# Extract files associated with native add-ons:
-	c_files=$(echo "${files}" | grep -e '/benchmark/c' -e '/examples/c' -e '/binding.gyp' -e '/include.gypi' -e '/src/')
+	c_files=$(echo "${files}" | grep -e '/benchmark/c' -e '/examples/c' -e '/binding.gyp' -e '/include.gypi' -e '/src/' || true)
+	if [[ -z "${c_files}" ]]; then
+		debug_log "No native add-on files found"
+	else
+		debug_log "Found native add-on files: $(echo "${c_files}" | wc -l) files"
+	fi
 
 	# Find unique package directories:
 	directories=$(echo "${files}" | tr ' ' '\n' | \
@@ -133,6 +157,7 @@ main() {
 
 	# Extract package names from changed package directories (e.g., @stdlib/math/base/special/sin) by removing the leading 'lib/node_modules/':
 	packages=$(echo "${directories}" | sed -E 's/^lib\/node_modules\///')
+	debug_log "Found packages: $(echo "${packages}" | tr '\n' ' ')"
 
 	# Documentation links:
 	docs_links="
@@ -148,9 +173,11 @@ main() {
 
 	# Count the number of packages:
 	package_count=$(echo "${packages}" | wc -l)
+	debug_log "Package count: ${package_count}"
 
 	if [[ $package_count -gt 1 ]]; then
 		# Multiple packages case:
+		debug_log "Multiple packages detected, generating multi-package comment"
 		comment="Hello! 👋
 
 Pro-tip: This PR changes multiple packages. You can use various \`make\` rules with \`*_FILTER\` environment variables to run tests, benchmarks, and examples for specific packages.
@@ -174,7 +201,9 @@ ${docs_links}"
 
 	else
 		# Single package case:
-		if [[ "${#c_files[@]}" -eq 0 ]]; then
+		debug_log "Single package detected: ${packages}"
+		if [[ -z "${c_files}" ]]; then
+			debug_log "No C files found, generating JS-only comment"
 			comment="Hello! 👋
 
 Pro-tip: Use the \`make\` commands below during local development to ensure that all tests, examples, and benchmark files in your PR run successfully.
@@ -200,6 +229,7 @@ make examples EXAMPLES_FILTER=\".*/${packages}/.*\"
 \`\`\`
 ${docs_links}"
 		else
+			debug_log "C files found, generating native addon comment"
 			comment="Hello! 👋
 
 Pro-tip: Use the \`make\` below commands during local development to ensure that all tests, examples, and benchmark files in your PR run successfully.
@@ -241,10 +271,12 @@ ${docs_links}"
 		fi
 	fi
 
+	debug_log "Posting comment on PR #${pr_number}"
 	if ! github_api "POST" "/repos/${repo_owner}/${repo_name}/issues/${pr_number}/comments" "{\"body\":$(echo "${comment}" | jq -R -s -c .)}"; then
 		echo "Failed to post comment on PR."
 		on_error 1
 	fi
+	debug_log "Successfully posted comment on PR #${pr_number}"
 
 	print_success
 	exit 0

.github/workflows/scripts/run_tests_coverage

@@ -144,8 +144,10 @@ compare_cov() {
 main() {
 	start_heartbeat "${heartbeat_interval}"
 
-	# Only keep files which reside in package directories:
-	changed=$(echo "${changed}" | tr ' ' '\n' | grep '^lib/node_modules/@stdlib') || true
+	# Only keep files which reside in package directories, but exclude _tools:
+	changed=$(echo "${changed}" | tr ' ' '\n' | \
+	  grep '^lib/node_modules/@stdlib' | \
+	  grep -v '^lib/node_modules/@stdlib/_tools') || true
 
 	# Find unique package directories:
 	directories=$(echo "${changed}" | tr ' ' '\n' | sed -E 's/\/(benchmark|bin|data|docs|etc|examples|include|lib|scripts|src|test)(\/.*)?\/?$//' | uniq)