test_published_package #1
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) 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: | |
| # * is a special character in YAML so you have to quote this string | |
| - cron: '9 21 * * 5' | |
| # Run workflow upon completion of `publish` workflow run: | |
| workflow_run: | |
| workflows: ["publish"] | |
| types: [completed] | |
| # Allow workflow to be manually run: | |
| workflow_dispatch: | |
| # 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: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} | |
| # Run workflow job if `publish` workflow run is successful or when the workflow is manually run: | |
| if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }} | |
| # Define the job's steps: | |
| steps: | |
| # Checkout the repository: | |
| - name: 'Checkout repository' | |
| uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 | |
| # Install Node.js: | |
| - name: 'Install Node.js' | |
| uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 | |
| 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 Slack notification if job fails: | |
| - name: 'Send notification to Slack in case of failure' | |
| uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 | |
| with: | |
| status: ${{ job.status }} | |
| channel: '#npm-ci' | |
| if: failure() |