test_published_package #3
This file contains hidden or 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) 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: test_published_package | |
| # Workflow triggers: | |
| on: | |
| # Run workflow on a weekly schedule: | |
| schedule: | |
| - cron: '0 0 * * 0' | |
| # 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: | |
| # Define a display name: | |
| name: 'Test running examples of published package' | |
| # Define the type of virtual host machine: | |
| runs-on: ubuntu-latest | |
| # Define environment variables: | |
| env: | |
| ZULIP_API_KEY: ${{ secrets.ZULIP_API_KEY }} | |
| # Define the job's steps: | |
| steps: | |
| # Checkout the repository: | |
| - name: 'Checkout repository' | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| 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' | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| with: | |
| node-version: 20 | |
| timeout-minutes: 5 | |
| # Create test directory and run examples: | |
| - name: 'Create test directory and run examples' | |
| run: | | |
| cd .. | |
| mkdir test-published | |
| cd test-published | |
| # Copy example file: | |
| cp $GITHUB_WORKSPACE/examples/index.js . | |
| # Create a minimal package.json | |
| echo '{ | |
| "name": "test-published", | |
| "version": "1.0.0", | |
| "main": "index.js", | |
| "dependencies": {} | |
| }' > package.json | |
| # Get package name and modify example file: | |
| PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json) | |
| ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g') | |
| sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js | |
| # Extract and install dependencies: | |
| DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.") | |
| for dep in $DEPS; do | |
| npm install $dep --save | |
| done | |
| # Run the example: | |
| node index.js | |
| # Send Zulip notification if job fails: | |
| - name: 'Send notification to Zulip in case of failure' | |
| # Pin action to full length commit SHA | |
| uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 | |
| if: failure() | |
| with: | |
| api-key: ${{ secrets.ZULIP_API_KEY }} | |
| email: 'github-actions-bot@stdlib.zulipchat.com' | |
| organization-url: 'https://stdlib.zulipchat.com' | |
| to: 'workflows' | |
| type: 'stream' | |
| topic: 'test-published-package' | |
| content: | | |
| :cross_mark: **${{ github.workflow }}** workflow failed | |
| **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) | |
| **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) |