Merge pull request #1 from stdlib-js/develop

update

Author: Pushpendra766

.github/workflows/check_licenses.yml

@@ -81,7 +81,7 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA
-        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: '20' # 'lts/*'
         timeout-minutes: 5

.github/workflows/check_required_files.yml

@@ -21,9 +21,33 @@ name: check_required_files
 
 # Workflow triggers:
 on:
-  # Trigger the workflow when a PR review is requested:
-  pull_request_target:
-    types: [review_requested]
+  # Allow the workflow to be triggered by other workflows
+  workflow_call:
+    # Define the input parameters for the workflow:
+    inputs:
+      pull_request_number:
+        description: 'Pull request number'
+        required: true
+        type: number
+      user:
+        required: true
+        type: string
+    # Define the secrets accessible by the workflow:
+    secrets:
+      STDLIB_BOT_GITHUB_TOKEN:
+        description: 'stdlib-bot GitHub token to create pull request comments'
+        required: true
+
+  # Allow the workflow to be manually triggered:
+  workflow_dispatch:
+    inputs:
+      pull_request_number:
+        description: 'Pull request number'
+        required: true
+        type: number
+      user:
+        required: true
+        type: string
 
 # Global permissions:
 permissions:
@@ -45,58 +69,15 @@ jobs:
     # Define the sequence of job steps...
     steps:
 
-      # Checkout the repository:
-      - name: 'Checkout repository'
-        # Pin action to full length commit SHA
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-        with:
-          # Specify whether to remove untracked files before checking out the repository:
-          clean: true
-
-          # Refers to the development branch:
-          ref: 'develop'
-
-          # Refers to the repository name of the pull request:
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-
-          # Limit clone depth to the most recent commit:
-          fetch-depth: 1
-
-          # Specify whether to download Git-LFS files:
-          lfs: false
-        timeout-minutes: 10
-
-      # Check if the review is requested from the `stdlib-bot` user:
-      - name: 'Check if review is requested from stdlib-bot'
-        id: check-reviewers
-        run: |
-          # Get the list of reviewers:
-          reviewers=$(jq -r '.pull_request.requested_reviewers | .[] | .login' "$GITHUB_EVENT_PATH")
-
-          # Check if the list of reviewers contains the `stdlib-bot` user:
-          if [[ $reviewers == *"stdlib-bot"* ]]; then
-            echo "is_stdlib_bot=true" >> $GITHUB_OUTPUT
-          else
-            echo "is_stdlib_bot=false" >> $GITHUB_OUTPUT
-          fi
-
-      # Configure git:
-      - name: 'Configure git'
-        if: steps.check-reviewers.outputs.is_stdlib_bot == 'true'
-        run: |
-          git config --local user.email "[email protected]"
-          git config --local user.name "stdlib-bot"
-          git fetch --all
-
       # Get list of added files:
       - name: 'Get list of added files'
-        if: steps.check-reviewers.outputs.is_stdlib_bot == 'true'
         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.STDLIB_BOT_GITHUB_TOKEN }}" "https://api.github.com/repos/stdlib-js/stdlib/pulls/${{ github.event.pull_request.number }}/files?page=$page&per_page=100" | jq -r '.[] | select(.status == "added") | .filename')
+              new_files=$(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 }}/files?page=$page&per_page=100" | jq -r '.[] | select(.status == "added") | .filename')
               if [ -z "$new_files" ]; then
                   break
               fi
@@ -108,7 +89,6 @@ jobs:
 
       # Check whether the pull request contains a new `README.md` file; if not, exit with a non-zero exit code:
       - name: 'Exit if pull request does not contain a new README.md file'
-        if: steps.check-reviewers.outputs.is_stdlib_bot == 'true'
         run: |
           if [[ ! "${{ steps.added-files.outputs.files }}" =~ "README.md" ]]; then
             echo "Pull request does not contain a new README.md file."
@@ -117,8 +97,6 @@ jobs:
 
       # Check whether the pull request contains files which are required to be present for all packages:
       - name: 'Check whether the pull request contains files which are required to be present for all packages'
-        if: steps.check-reviewers.outputs.is_stdlib_bot == 'true'
-        id: check-required-files
         run: |
           # Define a list of required files:
           required_files=(
@@ -188,15 +166,15 @@ jobs:
 
           body=""
           if [[ "${#missing_files[@]}" -eq 0 ]]; then
-            body="Hi @${{ github.event.pull_request.user.login }}, thank you for your contribution!
+            body="Hi @${{ inputs.user }}, thank you for your contribution!
 
             :tada: Your pull request contains all required files for the new package: :tada:
 
             ${checkbox_list}
 
             -- stdlib-bot"
           else
-            body="Hi @${{ github.event.pull_request.user.login }}, thank you for your contribution! Your pull request contains a new package, but is missing some of the required files.
+            body="Hi @${{ inputs.user }}, thank you for your contribution! Your pull request contains a new package, but is missing some of the required files.
 
             Use the following checklist to keep track of the required files and which ones are still missing:
 
@@ -207,23 +185,22 @@ jobs:
             -- stdlib-bot"
           fi
 
-          # Add the comment body to the workflow output after escaping to preserve newlines:
-          body="${body//'%'/'%25'}"
-          body="${body//$'\n'/'%0A'}"
-          body="${body//$'\r'/'%0D'}"
-          echo "comment-body=${body}" >> $GITHUB_OUTPUT
+          # Write the comment body to a file:
+          echo "${body}" > ./comment-body.txt
 
         shell: bash
         timeout-minutes: 10
 
       # Create a comment on the pull request informing the user whether the pull request is missing required files:
       - name: 'Create a comment on the pull request informing the user whether the pull request is missing required files'
-        if: steps.check-reviewers.outputs.is_stdlib_bot == 'true'
         # Pin action to full length commit SHA
         uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
         with:
           # Specify the issue or pull request number:
-          issue-number: ${{ github.event.pull_request.number }}
+          issue-number: ${{ inputs.pull_request_number }}
+
+          # Specify the comment body path:
+          body-path: ./comment-body.txt
 
-          # Specify the comment body:
-          body: ${{ steps.check-required-files.outputs.comment-body }}
+          # GitHub token:
+          token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}

.github/workflows/codeql.yml

@@ -118,7 +118,7 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA
-        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: '20' # 'lts/*'
         timeout-minutes: 5

.github/workflows/lint_autofix.yml

@@ -0,0 +1,172 @@
+#/
+# @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_autofix
+
+  # 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:
+
+    # Define a job for automatically fixing lint errors:
+    autofix:
+
+      # Define a display name:
+      name: 'Fix lint errors'
+
+      # Define the type of virtual host machine:
+      runs-on: ubuntu-latest
+
+      # Define the sequence of job 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's branch
+            pr_repo_full_name=$(echo "$pr_response" | jq -r '.head.repo.full_name') # PR's repo full name
+
+            # Set outputs for the branch and repository:
+            echo "branch=$pr_branch" >> $GITHUB_OUTPUT
+            echo "repository=$pr_repo_full_name" >> $GITHUB_OUTPUT
+
+        # Checkout the repository:
+        - name: 'Checkout repository'
+          # Pin action to full length commit SHA
+          uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+          with:
+            # Refers to the branch name of the branch being pushed:
+            ref: ${{ steps.pr-details.outputs.branch }}
+
+            # Refers to the repository name:
+            repository: ${{ steps.pr-details.outputs.repository }}
+
+            # Token for accessing the repository:
+            token: ${{ secrets.REPO_GITHUB_TOKEN }}
+
+            # File path to checkout to:
+            path: './'
+
+        # Install Node.js:
+        - name: 'Install Node.js'
+          # Pin action to full length commit SHA
+          uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+          with:
+            node-version: '20' # '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
+
+        # Initialize development environment:
+        - name: 'Initialize development environment'
+          run: |
+            make init
+          timeout-minutes: 5
+
+        # Get list of changed files:
+        - name: 'Get list of changed files'
+          id: changed-files
+          run: |
+            page=1
+            files=""
+            while true; do
+                changed_files=$(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 }}/files?page=$page&per_page=100" | jq -r '.[] | .filename')
+                if [ -z "$changed_files" ]; then
+                    break
+                fi
+                files="$files $changed_files"
+                page=$((page+1))
+            done
+            files=$(echo "$files" | tr '\n' ' ' | sed 's/^ //;s/ $//')
+            echo "files=${files}" >> $GITHUB_OUTPUT
+
+        # Fix JavaScript lint errors:
+        - name: 'Fix JavaScript lint errors'
+          id: fix-lint-errors
+          run: |
+            files="${{ steps.changed-files.outputs.files }}"
+            FIX=1 . "$GITHUB_WORKSPACE/.github/workflows/scripts/lint_javascript_files" "$files"
+
+        # 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@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.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
+
+        # Commit and push changes:
+        - name: 'Commit and push changes'
+          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: |
+            git config --local user.email "[email protected]"
+            git config --local user.name "stdlib-bot"
+            git add .
+            git commit -m "fix: resolve lint errors"
+            git push "https://$USER_NAME:[email protected]/$REPO_NAME.git" $BRANCH_NAME

.github/workflows/lint_changed_files.yml

@@ -67,7 +67,7 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA
-        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: '20' # 'lts/*'
         timeout-minutes: 5
@@ -248,7 +248,7 @@ jobs:
       - name: 'Setup R'
         if: ( success() || failure() ) && steps.check-r-files.outputs.files != ''
         # Pin action to full length commit SHA
-        uses: r-lib/actions/setup-r@55acd27e7b238c53bbe735b7a459c203a3b3d579 # v2.6.4
+        uses: r-lib/actions/setup-r@0ed4cdf40958ef43a6b33b9792e07ac76c3239e3 # v2.6.4
         with:
           r-version: '3.5.3'