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

.github/workflows/cleanup_coverage.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/lint_autofix.yml

@@ -25,25 +25,26 @@ on:
   # Allow the workflow to be triggered by other workflows
   workflow_call:
     # Define the input parameters for the workflow:
-      inputs:
-        pull_request_number:
-          description: 'PR number'
-          required: true
-          type: number
-      # Define the secrets accessible by the workflow:
-      secrets:
-        STDLIB_BOT_GITHUB_TOKEN:
-          description: 'GitHub token for stdlb-bot'
-          required: true
-        REPO_GITHUB_TOKEN:
-          description: 'GitHub token for accessing the repository'
-          required: true
-        STDLIB_BOT_GPG_PRIVATE_KEY:
-          description: 'GPG private key for stdlb-bot'
-          required: true
-        STDLIB_BOT_GPG_PASSPHRASE:
-          description: 'GPG passphrase for stdlb-bot'
-          required: true
+    inputs:
+      pull_request_number:
+        description: 'PR number'
+        required: true
+        type: number
+
+    # Define the secrets accessible by the workflow:
+    secrets:
+      STDLIB_BOT_GITHUB_TOKEN:
+        description: 'GitHub token for stdlb-bot'
+        required: true
+      REPO_GITHUB_TOKEN:
+        description: 'GitHub token for accessing the repository'
+        required: true
+      STDLIB_BOT_GPG_PRIVATE_KEY:
+        description: 'GPG private key for stdlb-bot'
+        required: true
+      STDLIB_BOT_GPG_PASSPHRASE:
+        description: 'GPG passphrase for stdlb-bot'
+        required: true
 
 # Workflow jobs:
 jobs:

.github/workflows/lint_copyright_years.yml

@@ -0,0 +1,116 @@
+#/
+# @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: 'lint_copyright_years'
+
+# Workflow triggers:
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+# Global permissions:
+permissions:
+  # Allow read-only access to the repository contents:
+  contents: read
+
+# Workflow jobs:
+jobs:
+  # Define a job for linting copyright years in newly added files:
+  lint:
+    name: 'Lint Copyright Years'
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        # Pin action to full length commit SHA
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          # Specify whether to remove untracked files before checking out the repository:
+          clean: true
+
+          # Limit clone depth to the last 1000 commits:
+          fetch-depth: 100
+
+          # Specify whether to download Git-LFS files:
+          lfs: false
+        timeout-minutes: 10
+
+      # Get list of newly added files:
+      - name: 'Get list of newly added files'
+        id: added-files
+        run: |
+          page=1
+          files=""
+          while true; do
+              new_files=$(curl -s \
+                -H "Accept: application/vnd.github.v3+json" \
+                -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "${{ github.api_url }}/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files?page=$page&per_page=100" \
+                | jq -r '.[] | select(.status == "added") | .filename')
+              if [ -z "$new_files" ]; then
+                  break
+              fi
+              files="$files $new_files"
+              page=$((page+1))
+          done
+          files=$(echo "$files" | tr '\n' ' ' | sed 's/^ //;s/ $//')
+          echo "files=${files}" >> $GITHUB_OUTPUT
+
+      # Check copyright years in newly added files:
+      - name: 'Check copyright years'
+        run: |
+          current_year=$(date +"%Y")
+          files="${{ steps.added-files.outputs.files }}"
+          exit_code=0
+
+          echo "## 📄 Copyright Year Check Results" >> $GITHUB_STEP_SUMMARY
+          echo "_Only newly added files are checked for the current year in the copyright notice._" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          if [[ -z "$files" ]]; then
+            echo "No newly added files to check."
+            echo "No newly added files to check." >> $GITHUB_STEP_SUMMARY
+            exit 0
+          fi
+
+          for file in $files; do
+            if [[ ! -f "$file" ]]; then
+              continue
+            fi
+
+            # Check if file contains stdlib copyright notice:
+            year=$(grep -o 'Copyright (c) [0-9]\{4\} The Stdlib Authors\.' "$file" | sed -E 's/^Copyright \(c\) ([0-9]{4}) The Stdlib Authors\./\1/' || true)
+
+            if [[ -n "$year" ]]; then
+              if [[ "$year" == "$current_year" ]]; then
+                echo "✅ $file: Correct year $year"
+                echo "- ✅ \`$file\`: Year is correct (**$year**)" >> $GITHUB_STEP_SUMMARY
+              else
+                echo "❌ $file: Expected $current_year, found $year"
+                echo "- ❌ **Error**: \`$file\` — Expected year **$current_year**, found **$year**" >> $GITHUB_STEP_SUMMARY
+                exit_code=1
+              fi
+            else
+              echo "⚠️ $file: No copyright notice found"
+              echo "- ⚠️ No copyright notice found in \`$file\`" >> $GITHUB_STEP_SUMMARY
+            fi
+          done
+
+          exit $exit_code

.github/workflows/pr_merge_develop.yml

@@ -0,0 +1,125 @@
+#/
+# @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: pr_merge_develop
+
+# Workflow triggers:
+on:
+
+  # Allow the workflow to be triggered by other workflows
+  workflow_call:
+    # Define the input parameters for the workflow:
+    inputs:
+      pull_request_number:
+        description: 'PR number'
+        required: true
+        type: number
+
+    # Define the secrets accessible by the workflow:
+    secrets:
+      STDLIB_BOT_GITHUB_TOKEN:
+        description: 'GitHub token for stdlb-bot'
+        required: true
+      REPO_GITHUB_TOKEN:
+        description: 'GitHub token for accessing the repository'
+        required: true
+      STDLIB_BOT_GPG_PRIVATE_KEY:
+        description: 'GPG private key for stdlb-bot'
+        required: true
+      STDLIB_BOT_GPG_PASSPHRASE:
+        description: 'GPG passphrase for stdlb-bot'
+        required: true
+
+# Workflow jobs:
+jobs:
+  merge:
+    # Define a display name:
+    name: 'Merge Develop into PR Branch'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the job's steps:
+    steps:
+      # Get PR details:
+      - name: 'Get PR details'
+        id: pr-details
+        run: |
+          pr_response=$(curl -s \
+            -H "Accept: application/vnd.github.v3+json" \
+            -H "Authorization: Bearer ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}" \
+            "https://api.github.com/repos/stdlib-js/stdlib/pulls/${{ inputs.pull_request_number }}")
+
+          # Escape control characters:
+          pr_response=$(echo "$pr_response" | tr -d '\000-\031')
+
+          # Extract the needed details:
+          pr_branch=$(echo "$pr_response" | jq -r '.head.ref')
+          pr_repo_full_name=$(echo "$pr_response" | jq -r '.head.repo.full_name')
+
+          echo "branch=$pr_branch" >> $GITHUB_OUTPUT
+          echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
+
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          ref: ${{ steps.pr-details.outputs.branch }}
+          repository: ${{ steps.pr-details.outputs.repository }}
+          token: ${{ secrets.REPO_GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      # Disable Git hooks:
+      - name: 'Disable Git hooks'
+        run: |
+          rm -rf .git/hooks
+
+      # Import GPG key to sign commits:
+      - name: 'Import GPG key to sign commits'
+        # Pin action to full length commit SHA
+        uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
+        with:
+          gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+
+      # Merge the develop branch into the PR branch:
+      - name: 'Merge develop branch'
+        env:
+          REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+          USER_NAME: stdlb-bot
+          BRANCH_NAME: ${{ steps.pr-details.outputs.branch }}
+          REPO_NAME: ${{ steps.pr-details.outputs.repository }}
+        run: |
+          # Configure Git user:
+          git config --local user.email "[email protected]"
+          git config --local user.name "stdlib-bot"
+
+          # Add upstream remote pointing to the original repository:
+          git remote add upstream https://github.com/stdlib-js/stdlib.git
+
+          # Fetch the develop branch from upstream:
+          git fetch upstream develop
+
+          # Merge upstream develop into the current branch:
+          git merge upstream/develop --no-edit
+
+          # Push the updated branch back to the forked repository:
+          git push "https://$USER_NAME:[email protected]/$REPO_NAME.git" $BRANCH_NAME