#/ # @license Apache-2.0 # # Copyright (c) 2022 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: productionize # Workflow triggers: on: # Run workflow when a new commit is pushed to the main branch: push: branches: - main # Allow the workflow to be manually run: workflow_dispatch: inputs: require-passing-tests: description: 'Require passing tests for creating bundles' type: boolean default: true # Run workflow upon completion of `publish` workflow run: workflow_run: workflows: ["publish"] types: [completed] # Concurrency group to prevent multiple concurrent executions: concurrency: group: productionize cancel-in-progress: true # Workflow jobs: jobs: # Define a job to create a production build... productionize: # Define display name: name: 'Productionize' # Define the type of virtual host machine: runs-on: 'ubuntu-latest' # Define the sequence of job steps... steps: # Checkout main branch of repository: - name: 'Checkout main branch' # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 with: ref: main # Install Node.js: - name: 'Install Node.js' # Pin action to full length commit SHA uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 with: node-version: 20 timeout-minutes: 5 # Create production branch: - name: 'Create production branch' run: | git checkout -b production # Transform error messages: - name: 'Transform error messages' id: transform-error-messages uses: stdlib-js/transform-errors-action@main # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - name: 'Update dependencies in package.json' run: | PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) if grep -q '"@stdlib/string-format"' package.json; then sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json else node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" fi # Configure Git: - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" # Commit changes: - name: 'Commit changes' run: | git add -A git commit -m "Transform error messages" # Push changes: - name: 'Push changes' run: | SLUG=${{ github.repository }} echo "Pushing changes to $SLUG..." git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force # Define a job for running tests of the productionized code... test: # Define a display name: name: 'Run Tests' # Define the type of virtual host machine: runs-on: 'ubuntu-latest' # Indicate that this job depends on the prior job finishing: needs: productionize # Run this job regardless of the outcome of the prior job: if: always() # Define the sequence of job steps... steps: # Checkout the repository: - name: 'Checkout repository' if: ${{ github.event.inputs.require-passing-tests == 'true' }} # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 with: # Use the `production` branch: ref: production # Install Node.js: - name: 'Install Node.js' if: ${{ github.event.inputs.require-passing-tests == 'true' }} # Pin action to full length commit SHA uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 with: node-version: 20 timeout-minutes: 5 # Install dependencies: - name: 'Install production and development dependencies' if: ${{ github.event.inputs.require-passing-tests == 'true' }} id: install run: | npm install || npm install || npm install timeout-minutes: 15 # Build native add-on if present: - name: 'Build native add-on (if present)' if: ${{ github.event.inputs.require-passing-tests == 'true' }} run: | if [ -f "binding.gyp" ]; then npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild fi # Run tests: - name: 'Run tests' if: ${{ github.event.inputs.require-passing-tests == 'true' }} id: tests run: | npm test || npm test || npm test # Define job to create a bundle for use in Deno... deno: # Define display name: name: 'Create Deno bundle' # Define the type of virtual host machine on which to run the job: runs-on: ubuntu-latest # Indicate that this job depends on the test job finishing: needs: test # Define the sequence of job steps... steps: # Checkout the repository: - name: 'Checkout repository' # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 # Configure Git: - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" # Check if remote `deno` branch exists: - name: 'Check if remote `deno` branch exists' id: deno-branch-exists continue-on-error: true run: | git fetch --all git ls-remote --exit-code --heads origin deno if [ $? -eq 0 ]; then echo "remote-exists=true" >> $GITHUB_OUTPUT else echo "remote-exists=false" >> $GITHUB_OUTPUT fi # If `deno` exists, delete everything in branch and merge `production` into it - name: 'If `deno` exists, delete everything in branch and merge `production` into it' if: steps.deno-branch-exists.outputs.remote-exists run: | git checkout -b deno origin/deno find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf git add -A git commit -m "Remove files" --allow-empty git config merge.theirs.name 'simulate `-s theirs`' git config merge.theirs.driver 'cat %B > %A' GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories # Copy files from `production` branch if necessary: git checkout origin/production -- . if [ -n "$(git status --porcelain)" ]; then git add -A git commit -m "Auto-generated commit" fi # If `deno` does not exist, create `deno` branch: - name: 'If `deno` does not exist, create `deno` branch' if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} run: | git checkout production git checkout -b deno # Copy files to deno directory: - name: 'Copy files to deno directory' run: | mkdir -p deno cp README.md LICENSE CONTRIBUTORS NOTICE ./deno # Copy TypeScript definitions to deno directory: if [ -d index.d.ts ]; then cp index.d.ts ./deno/index.d.ts fi if [ -e ./docs/types/index.d.ts ]; then cp ./docs/types/index.d.ts ./deno/mod.d.ts fi # Install Node.js: - name: 'Install Node.js' # Pin action to full length commit SHA uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 with: node-version: 20 timeout-minutes: 5 # Install dependencies: - name: Install production and development dependencies id: install run: | npm install || npm install || npm install timeout-minutes: 15 # Bundle package for use in Deno: - name: 'Bundle package for Deno' id: deno-bundle uses: stdlib-js/bundle-action@main with: target: 'deno' # Rewrite file contents: - name: 'Rewrite file contents' run: | # Replace links to other packages with links to the deno branch: find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; # Replace reference to `@stdlib/types` with CDN link: find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" # Change wording of project description to avoid reference to JavaScript and Node.js: find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" # Rewrite all `require()`s to use jsDelivr links: find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ s/';/@deno\/mod.js';/ }" # Rewrite first `import` to show importing of named exports if available: exports=$(cat lib/index.js | \ grep -E 'setReadOnly\(.*,.*,.*\)' | \ sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ sed -E "s/'//g" | \ sort) if [ -n "$exports" ]; then find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" fi # Remove `installation`, `cli`, and `c` sections: find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" # Create package.json file for deno branch: jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json # Delete everything in current directory aside from deno folder: - name: 'Delete everything in current directory aside from deno folder' run: | find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf # Move deno directory to root: - name: 'Move deno directory to root' run: | mv ./deno/* . rmdir ./deno # Commit changes: - name: 'Commit changes' run: | git add -A git commit -m "Auto-generated commit" # Push changes to `deno` branch: - name: 'Push changes to `deno` branch' run: | SLUG=${{ github.repository }} echo "Pushing changes to $SLUG..." git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno # Send notification to Zulip 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-standalone' type: 'stream' topic: ${{ github.event.repository.name }} 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 }}) # Define job to create a UMD bundle... umd: # Define display name: name: 'Create UMD bundle' # Define the type of virtual host machine on which to run the job: runs-on: ubuntu-latest # Indicate that this job depends on the test job finishing: needs: test # Define the sequence of job steps... steps: # Checkout the repository: - name: 'Checkout repository' # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 # Configure Git: - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" # Check if remote `umd` branch exists: - name: 'Check if remote `umd` branch exists' id: umd-branch-exists continue-on-error: true run: | git fetch --all git ls-remote --exit-code --heads origin umd if [ $? -eq 0 ]; then echo "remote-exists=true" >> $GITHUB_OUTPUT else echo "remote-exists=false" >> $GITHUB_OUTPUT fi # If `umd` exists, delete everything in branch and merge `production` into it - name: 'If `umd` exists, delete everything in branch and merge `production` into it' if: steps.umd-branch-exists.outputs.remote-exists run: | git checkout -b umd origin/umd find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf git add -A git commit -m "Remove files" --allow-empty git config merge.theirs.name 'simulate `-s theirs`' git config merge.theirs.driver 'cat %B > %A' GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories # Copy files from `production` branch if necessary: git checkout origin/production -- . if [ -n "$(git status --porcelain)" ]; then git add -A git commit -m "Auto-generated commit" fi # If `umd` does not exist, create `umd` branch: - name: 'If `umd` does not exist, create `umd` branch' if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} run: | git checkout production git checkout -b umd # Copy files to umd directory: - name: 'Copy files to umd directory' run: | mkdir -p umd cp README.md LICENSE CONTRIBUTORS NOTICE ./umd # Install Node.js - name: 'Install Node.js' # Pin action to full length commit SHA uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 with: node-version: 20 timeout-minutes: 5 # Install dependencies: - name: 'Install production and development dependencies' id: install run: | npm install || npm install || npm install timeout-minutes: 15 # Extract alias: - name: 'Extract alias' id: extract-alias run: | alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') echo "alias=${alias}" >> $GITHUB_OUTPUT # Create Universal Module Definition (UMD) Node.js bundle: - name: 'Create Universal Module Definition (UMD) Node.js bundle' id: umd-bundle-node uses: stdlib-js/bundle-action@main with: target: 'umd-node' alias: ${{ steps.extract-alias.outputs.alias }} # Create Universal Module Definition (UMD) browser bundle: - name: 'Create Universal Module Definition (UMD) browser bundle' id: umd-bundle-browser uses: stdlib-js/bundle-action@main with: target: 'umd-browser' alias: ${{ steps.extract-alias.outputs.alias }} # Rewrite file contents: - name: 'Rewrite file contents' run: | # Replace links to other packages with links to the umd branch: find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; # Remove `installation`, `cli`, and `c` sections: find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n