Merge branch 'stdlib-js:develop' into accessor-gsumkbn

stdlib-js · Jan 29, 2025 · 656cb60 · 656cb60
2 parents 5569287 + 7456e9f
commit 656cb60
Show file tree

Hide file tree

Showing 311 changed files with 3,526 additions and 2,343 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -117,5 +117,5 @@ body:
       options:
         - label: Read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
           required: true
-        - label:  Searched for existing issues and pull requests.
+        - label: Searched for existing issues and pull requests.
           required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -18,10 +18,10 @@
 
 contact_links:
   - name: 👩‍🏫 Frequently Asked Questions
-    url:  https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
+    url: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
     about: Consult the FAQ in case we have already answered your question there.
   - name: 💬 Question
-    url:  https://gitter.im/stdlib-js/stdlib
+    url: https://gitter.im/stdlib-js/stdlib
     about: Got a (non-bug related) question we haven't already answered? Ask us on Gitter! 🤗
   - name: 👏 Support Us
     url: https://github.com/stdlib-js/stdlib/blob/develop/docs/support_the_project.md

diff --git a/.github/workflows/do_not_merge.yml b/.github/workflows/do_not_merge.yml
@@ -43,8 +43,7 @@ jobs:
 
     # Define job permissions:
     permissions:
-      contents: read
-      pull-requests: write
+      pull-requests: read
 
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/first_time_greeting.yml b/.github/workflows/first_time_greeting.yml
@@ -24,8 +24,8 @@ on: [pull_request_target, issues]
 
 # Global permissions:
 permissions:
-  # Allow read-only access to the repository contents:
-  contents: read
+  # Do not give the workflow any permissions:
+  contents: none
 
 # Workflow jobs:
 jobs:
@@ -47,7 +47,7 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/first-interaction@34f15e814fe48ac9312ccf29db4e74fa767cbab7 # v1.3.0
         with:
-          repo-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }}
+          repo-token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           issue-message: |
             :wave: Hi there! :wave:
 

diff --git a/.github/workflows/lint_pr_title.yml b/.github/workflows/lint_pr_title.yml
@@ -84,8 +84,10 @@ jobs:
 
       # Perform linting:
       - name: 'Perform linting'
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
         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='${{ github.event.pull_request.title }}'
+          make lint-commit-message GIT_COMMIT_MESSAGE="${PR_TITLE}"
         timeout-minutes: 5
diff --git a/.github/workflows/make.yml b/.github/workflows/make.yml
@@ -64,6 +64,9 @@ jobs:
 
           # 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:

diff --git a/.github/workflows/markdown_equations.yml b/.github/workflows/markdown_equations.yml
@@ -64,6 +64,9 @@ jobs:
 
           # 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:
@@ -103,7 +106,6 @@ jobs:
           git_user_signingkey: true
           git_commit_gpgsign: true
 
-
       # Generate list of changed Markdown files:
       - name: 'Find changed Markdown files'
         run: |
@@ -161,7 +163,7 @@ jobs:
           commit-message: 'docs: update Markdown equation elements'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

diff --git a/.github/workflows/markdown_links.yml b/.github/workflows/markdown_links.yml
@@ -23,7 +23,7 @@ name: markdown_links
 on:
   schedule:
     # Run the workflow once a month on the 1st day of every month:
-    - cron:  "0 0 1 * *"
+    - cron: '0 0 1 * *'
 
   # Allow the workflow to be manually run:
   workflow_dispatch:
@@ -76,6 +76,9 @@ jobs:
 
           # Specify whether to download Git-LFS files:
           lfs: false
+
+          # Avoid storing GitHub token in local Git configuration:
+          persist-credentials: false
         timeout-minutes: 10
 
       # Initialize log files:

diff --git a/.github/workflows/markdown_pkg_urls.yml b/.github/workflows/markdown_pkg_urls.yml
@@ -70,6 +70,10 @@ jobs:
 
           # 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:
@@ -131,7 +135,7 @@ jobs:
           fi
         timeout-minutes: 10
 
-     # Create a pull request with the changes:
+      # Create a pull request with the changes:
       - name: 'Create pull request'
         id: cpr
         if: steps.update-markdown-pkg-urls.outputs.changed == 'true'
@@ -147,7 +151,7 @@ jobs:
           commit-message: 'docs: update Markdown stdlib package URLs'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

diff --git a/.github/workflows/markdown_related_packages.yml b/.github/workflows/markdown_related_packages.yml
@@ -68,6 +68,9 @@ jobs:
 
           # 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:
@@ -159,7 +162,7 @@ jobs:
           commit-message: 'docs: update related packages sections'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

diff --git a/.github/workflows/markdown_src_attributes.yml b/.github/workflows/markdown_src_attributes.yml
@@ -23,7 +23,7 @@ name: markdown_src_attributes
 on:
   schedule:
     # Run the workflow once a month on the 1st day of every month:
-    - cron:  "0 0 1 * *"
+    - cron: '0 0 1 * *'
 
   # Allow the workflow to be manually run:
   workflow_dispatch:
@@ -73,6 +73,9 @@ jobs:
 
           # Specify whether to download Git-LFS files:
           lfs: false
+
+          # Avoid storing GitHub token in local Git configuration:
+          persist-credentials: false
         timeout-minutes: 10
 
       # Initialize log files:

diff --git a/.github/workflows/markdown_tocs.yml b/.github/workflows/markdown_tocs.yml
@@ -64,6 +64,9 @@ jobs:
 
           # 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:
@@ -129,7 +132,7 @@ jobs:
           commit-message: 'docs: update namespace table of contents'
           signoff: true
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

diff --git a/.github/workflows/namespace_declarations.yml b/.github/workflows/namespace_declarations.yml
@@ -64,6 +64,9 @@ jobs:
 
           # 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:
@@ -124,7 +127,7 @@ jobs:
           commit-message: 'feat: update namespace TypeScript declarations'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr

diff --git a/.github/workflows/namespace_exports.yml b/.github/workflows/namespace_exports.yml
@@ -60,6 +60,9 @@ jobs:
 
           # 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:
@@ -136,7 +139,7 @@ jobs:
           commit-message: 'feat: update namespace exports'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             automated-pr
           team-reviewers: |

diff --git a/.github/workflows/random_examples.yml b/.github/workflows/random_examples.yml
@@ -63,6 +63,9 @@ jobs:
 
           # 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:

diff --git a/.github/workflows/run_affected_benchmarks.yml b/.github/workflows/run_affected_benchmarks.yml
@@ -73,6 +73,9 @@ jobs:
 
           # 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:

diff --git a/.github/workflows/run_affected_examples.yml b/.github/workflows/run_affected_examples.yml
@@ -69,6 +69,9 @@ jobs:
 
           # 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:

diff --git a/.github/workflows/run_affected_tests.yml b/.github/workflows/run_affected_tests.yml
@@ -104,6 +104,9 @@ jobs:
 
           # 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:

diff --git a/.github/workflows/slash_commands.yml b/.github/workflows/slash_commands.yml
@@ -59,21 +59,33 @@ jobs:
 
       # Add initial reaction to comment with slash command:
       - name: 'Add initial reaction'
-        run: |
-          COMMENT="${{ github.event.comment.body }}"
-          if [[ $COMMENT =~ ^/stdlib\ (help|check-files|update-copyright-years|lint-autofix|merge|rebase) ]]; then
-            curl -X POST \
-              -H "Accept: application/vnd.github.v3+json" \
-              -H "Authorization: Bearer ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}" \
-              "https://api.github.com/repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions" \
-              -d '{"content":"eyes"}'
-          else
-            curl -X POST \
-              -H "Accept: application/vnd.github.v3+json" \
-              -H "Authorization: Bearer ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}" \
-              "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/comments" \
-              -d '{"body":"@${{ github.event.comment.user.login }}, slash command not recognized. Please use `/stdlib help` to view available commands."}'
-          fi
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+          script: |
+            const commentBody = github.event.comment.body.trim();
+            const RE_COMMANDS = /^\/stdlib\s+(help|check-files|update-copyright-years|lint-autofix|merge|rebase)$/i;
+            const isRecognizedCommand = RE_COMMANDS.test( commentBody );
+
+            if ( isRecognizedCommand ) {
+              await github.rest.reactions.createForIssueComment({
+                'owner': context.repo.owner,
+                'repo': context.repo.repo,
+                'comment_id': github.event.comment.id,
+                'content': 'eyes'
+              });
+            } else {
+              // Include the full user comment as a Markdown quote block in response:
+              const lines = commentBody.split( '\n' );
+              const quote = lines.map( line => `> ${line}` ).join( '\n' );
+
+              await github.rest.issues.createComment({
+                'owner': context.repo.owner,
+                'repo': context.repo.repo,
+                'issue_number': github.event.issue.number,
+                'body': `${quote}\n\n@${github.event.comment.user.login}, slash command not recognized. Please use \`/stdlib help\` to view available commands.`
+              });
+            }
 
   # Define a job for checking for required files:
   check_files:

diff --git a/.github/workflows/test_published_package.yml b/.github/workflows/test_published_package.yml
@@ -28,6 +28,11 @@ on:
   # Allow workflow to be manually run:
   workflow_dispatch:
 
+# Global permissions:
+permissions:
+  # Allow read-only access to the repository contents:
+  contents: read
+
 # Workflow jobs:
 jobs:
   test-published:
@@ -46,6 +51,9 @@ jobs:
       # Checkout the repository:
       - name: 'Checkout repository'
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+        with:
+          # Do not persist GitHub token in local Git configuration since no continued authentication is needed:
+          persist-credentials: false
 
       # Install Node.js:
       - name: 'Install Node.js'

diff --git a/.github/workflows/track_todos.yml b/.github/workflows/track_todos.yml
@@ -23,7 +23,7 @@ name: track_todos
 on:
   schedule:
     # Run the workflow once a month on the 1st day of every month:
-    - cron:  "0 0 1 * *"
+    - cron: '0 0 1 * *'
 
   # Allow the workflow to be manually run:
   workflow_dispatch:

diff --git a/.github/workflows/update_cli_permissions.yml b/.github/workflows/update_cli_permissions.yml
@@ -64,6 +64,9 @@ jobs:
 
           # Specify whether to download Git-LFS files:
           lfs: false
+
+          # Avoid storing GitHub token in local Git configuration:
+          persist-credentials: false
         timeout-minutes: 10
 
       # Make CLI scripts executable:
@@ -102,7 +105,7 @@ jobs:
           signoff: true
           body: |
             This PR changes the permissions of project `cli` scripts to be executable.
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             automated-pr
           team-reviewers: |

diff --git a/.github/workflows/update_contributors.yml b/.github/workflows/update_contributors.yml
@@ -67,6 +67,9 @@ jobs:
 
           # Specify whether to download Git-LFS files:
           lfs: false
+
+          # Avoid storing GitHub token in local Git configuration:
+          persist-credentials: false
         timeout-minutes: 10
 
       # Update the contributors list:
@@ -115,7 +118,7 @@ jobs:
           commit-message: 'docs: update list of contributors'
           committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>'
           signoff: true
-          token: ${{ secrets.PULL_REQUEST_TOKEN }}
+          token: ${{ secrets.STDLIB_BOT_FGPAT_PR_WRITE }}
           labels: |
             documentation
             automated-pr