chore: fix copyright years and disable lint rules #8510
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #/ | |
| # @license Apache-2.0 | |
| # | |
| # Copyright (c) 2023 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: run_tests_coverage.yml | |
| # Workflow triggers: | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| paths: | |
| # List paths for which changes should trigger this workflow: | |
| - 'lib/**/bin/**' | |
| - 'lib/**/data/**' | |
| - 'lib/**/etc/**' | |
| - 'lib/**/include/**' | |
| - 'lib/**/lib/**' | |
| - 'lib/**/src/**' | |
| - 'lib/**/test/**' | |
| - 'lib/**/*.gyp' | |
| - 'lib/**/*.gypi' | |
| - 'lib/**/manifest.json' | |
| - 'package.json' | |
| # List paths for which changes should *not* trigger this workflow: | |
| - '!lib/**/_tools/**' | |
| pull_request_target: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| paths: | |
| # List paths for which changes should trigger this workflow: | |
| - 'lib/**/bin/**' | |
| - 'lib/**/data/**' | |
| - 'lib/**/etc/**' | |
| - 'lib/**/include/**' | |
| - 'lib/**/lib/**' | |
| - 'lib/**/src/**' | |
| - 'lib/**/test/**' | |
| - 'lib/**/*.gyp' | |
| - 'lib/**/*.gypi' | |
| - 'lib/**/manifest.json' | |
| - 'package.json' | |
| # List paths for which changes should *not* trigger this workflow: | |
| - '!lib/**/_tools/**' | |
| workflow_dispatch: | |
| inputs: | |
| directories: | |
| description: 'List of changed directories for which to run tests (space separated):' | |
| # Global permissions: | |
| permissions: | |
| # Allow read-only access to the repository contents: | |
| contents: read | |
| # Workflow jobs: | |
| jobs: | |
| # Define a job for calculating test coverage for changed files... | |
| coverage: | |
| # Define a display name: | |
| name: 'Calculate test coverage for packages' | |
| # 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@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: 1000 | |
| # Specify whether to download Git-LFS files: | |
| lfs: false | |
| timeout-minutes: 10 | |
| # Install Node.js: | |
| - name: 'Install Node.js' | |
| # Pin action to full length commit SHA | |
| uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 | |
| 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 directories from PR and push events: | |
| - name: 'Get list of changed directories' | |
| if: github.event_name != 'workflow_dispatch' | |
| id: changed-directories | |
| continue-on-error: true | |
| run: | | |
| if [ -n "${{ github.event.pull_request.number }}" ]; then | |
| # Get the list of changed files in pull request: | |
| ancestor_commit=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) | |
| files=$(git diff --diff-filter=AM --name-only $ancestor_commit ${{ github.event.pull_request.head.sha }}) | |
| else | |
| # Get changed files by comparing the current commit to the commit before the push event or with its parent: | |
| if [ "${{ github.event.before }}" == "0000000000000000000000000000000000000000" ]; then | |
| files=$(git diff --diff-filter=AM --name-only HEAD~ ${{ github.event.after }}) | |
| else | |
| files=$(git diff --diff-filter=AM --name-only ${{ github.event.before }} ${{ github.event.after }}) | |
| fi | |
| fi | |
| directories=$(for file in $files; do dirname $file; done | uniq | tr '\n' ' ' | sed 's/ $//') | |
| echo "directories=${directories}" >> $GITHUB_OUTPUT | |
| # Get list of changed directories from workflow dispatch event: | |
| - name: 'Get list of changed directories (from user input)' | |
| if: github.event_name == 'workflow_dispatch' | |
| id: changed-directories-user-input | |
| run: | | |
| echo "directories=${{ github.event.inputs.directories }}" >> $GITHUB_OUTPUT | |
| timeout-minutes: 5 | |
| # Run JavaScript tests: | |
| - name: 'Run JavaScript tests' | |
| id: extract-coverage | |
| env: | |
| GITHUB_REPO: ${{ github.repository }} | |
| GITHUB_REF: ${{ github.ref }} | |
| run: | | |
| if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then | |
| directories="${{ steps.changed-directories-user-input.outputs.directories }}" | |
| else | |
| directories="${{ steps.changed-directories.outputs.directories }}" | |
| fi | |
| . "$GITHUB_WORKSPACE/.github/workflows/scripts/run_tests_coverage" "$directories" | |
| timeout-minutes: 30 | |
| # Create final coverage report: | |
| - name: 'Create final coverage report' | |
| id: create-report | |
| run: | | |
| table="${{ steps.extract-coverage.outputs.table }}" | |
| if [ -z "$table" ]; then | |
| report="## Coverage Report\n\nNo coverage information available." | |
| else | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| compare_url="https://github.com/stdlib-js/stdlib/compare/${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }}" | |
| compare_txt="The above coverage report was generated for the [changes in this PR]($compare_url)." | |
| elif [ "${{ github.event_name }}" == "push" ]; then | |
| compare_url="https://github.com/stdlib-js/stdlib/compare/${{ github.event.before }}...${{ github.event.after }}" | |
| compare_txt="The above coverage report was generated for the [changes in this push]($compare_url)." | |
| else | |
| compare_txt="" | |
| fi | |
| report="## Coverage Report\n\n${table}\n\n${compare_txt}" | |
| fi | |
| echo "report=$report" >> $GITHUB_OUTPUT | |
| # Post report as comment to PR: | |
| - name: 'Post report as comment to PR' | |
| if: github.event_name == 'pull_request_target' | |
| # Pin action to full length commit SHA | |
| uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 | |
| with: | |
| github-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }} | |
| script: | | |
| const { data: comments } = await github.rest.issues.listComments({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| }); | |
| const isBotComment = comments.find(comment => comment.user.login === 'stdlib-bot' && comment.body.includes('## Coverage Report')); | |
| if (isBotComment) { | |
| await github.rest.issues.updateComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| comment_id: botComment.id, | |
| body: `${{ steps.create-report.outputs.report }}`, | |
| }); | |
| } else { | |
| await github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: `${{ steps.create-report.outputs.report }}`, | |
| }); | |
| } | |
| # Post report as comment to commit: | |
| - name: 'Post report as comment to commit' | |
| if: github.event_name == 'push' | |
| # Pin action to full length commit SHA | |
| uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 | |
| with: | |
| github-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }} | |
| script: | | |
| github.rest.repos.createCommitComment({ | |
| commit_sha: context.sha, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: '${{ steps.create-report.outputs.report }}' | |
| }) | |
| # Checkout coverage repository: | |
| - name: 'Checkout coverage repository' | |
| # Pin action to full length commit SHA | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| # Code coverage repository: | |
| repository: 'stdlib-js/www-test-code-coverage' | |
| # File path to checkout to: | |
| path: './www-test-code-coverage' | |
| # Specify whether to remove untracked files before checking out the repository: | |
| clean: false | |
| # Limit clone depth to the most recent commit: | |
| fetch-depth: 1 | |
| # Token for accessing the repository: | |
| token: ${{ secrets.REPO_GITHUB_TOKEN }} | |
| # Checkout coverage repository branch: | |
| - name: 'Checkout coverage repository branch' | |
| run: | | |
| cd ./www-test-code-coverage | |
| if [[ "${{ github.event_name }}" == "pull_request" ]]; then | |
| BRANCH_NAME="pr-${{ github.event.pull_request.number }}" | |
| git fetch origin $BRANCH_NAME || true | |
| git checkout $BRANCH_NAME || git checkout -b $BRANCH_NAME | |
| else | |
| BRANCH_NAME="main" | |
| fi | |
| # Copy artifacts to the repository: | |
| - name: 'Copy artifacts to the repository' | |
| run: | | |
| if [ -d "./artifacts" ]; then | |
| cp -R ./artifacts/* ./www-test-code-coverage | |
| # Get commit SHA and timestamp: | |
| commit_sha=$(git rev-parse HEAD) | |
| commit_timestamp=$(git show -s --format=%ci $commit_sha) | |
| # Append coverage to ndjson files: | |
| files=$(find ./artifacts -name 'index.html') | |
| for file in $files; do | |
| file=${file//artifacts/www-test-code-coverage} | |
| coverage=$(echo -n '['; grep -oP "(?<=class='fraction'>)[0-9]+/[0-9]+" $file | awk -F/ '{ if ($2 != 0) print $1 "," $2 "," ($1/$2)*100; else print $1 "," $2 ",100" }' | tr '\n' ',' | sed 's/,$//'; echo -n ",\"$commit_sha\",\"$commit_timestamp\"]") | |
| echo $coverage >> $(dirname $file)/coverage.ndjson | |
| done | |
| else | |
| echo "The artifacts directory does not exist." | |
| fi | |
| # 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 | |
| # Commit and push changes: | |
| - name: 'Commit and push changes' | |
| env: | |
| REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} | |
| USER_NAME: stdlib-bot | |
| run: | | |
| cd ./www-test-code-coverage | |
| git config --local user.email "82920195+stdlib-bot@users.noreply.github.com" | |
| git config --local user.name "stdlib-bot" | |
| git add . | |
| git commit -m "Update artifacts" || exit 0 | |
| git push "https://$USER_NAME:$REPO_GITHUB_TOKEN@github.com/stdlib-js/www-test-code-coverage.git" $BRANCH_NAME |