Skip to content

docs: update REPL namespace documentation #5

docs: update REPL namespace documentation

docs: update REPL namespace documentation #5

#/
# @license Apache-2.0
#
# Copyright (c) 2021 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: standalone_push_changes
# Workflow triggers:
on:
push:
branches:
- develop
paths:
# List paths for which changes should trigger this workflow:
- 'lib/node_modules/@stdlib/**'
# List paths for which changes should *not* trigger this workflow:
- '!lib/node_modules/@stdlib/_tools/**'
# Global permissions:
permissions:
# Allow read-only access to the repository contents:
contents: read
# Workflow jobs:
jobs:
# Define a job for pushing changes to standalone packages...
push:
# Define a display name:
name: 'Push changes'
# 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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
# Specify whether to remove untracked files before checking out the repository:
clean: false
# Limit clone depth to the most recent 100 commits:
fetch-depth: 100
# 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@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: '16' # '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
# Retrieve list of changed packages:
- name: 'Find changed packages'
id: 'changed_packages'
# Pin action to full length commit SHA
uses: stdlib-js/changed-packages-action@e489c6b4eff164c5912a0b2d17d7462f38c11712 # v2.0.0
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Push changes to the package repositories:
- name: 'Push changes'
if: ${{ steps.changed_packages.outputs.packages != '[]' }}
env:
GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
run: |
echo "Pushing changes to the following repositories: ${{ steps.changed_packages.outputs.packages }}"
node lib/node_modules/@stdlib/_tools/scripts/publish_packages.js ${{ join( fromJSON( steps.changed_packages.outputs.packages ), ' ' ) }}
# Define a job for sending notifications to Slack...
slack:
# Define a display name:
name: 'Slack notification'
# Define the type of virtual host machine:
runs-on: 'ubuntu-latest'
# Indicate that this job depends on the prior job finishing:
needs: push
# Run this job regardless of the outcome of the prior job:
if: always()
# Set defaults:
defaults:
run:
# Set the default shell to `bash`:
shell: bash --noprofile --norc -eo pipefail {0}
# Define the sequence of job steps...
steps:
# Resolve notification data:
- name: 'Resolve notification data'
run: |
echo 'NOTIFICATION_STATUS=${{ needs.push.result}}' >> $GITHUB_ENV
if [[ "${{ needs.push.result }}" = "success" ]]; then
echo 'NOTIFICATION_TEXT=**standalone_push_changes** workflow succeeded' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Success' >> $GITHUB_ENV
elif [[ "${{ needs.push.result }}" = "failure" ]]; then
echo 'NOTIFICATION_TEXT=**standalone_push_changes** workflow failed' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Failure' >> $GITHUB_ENV
elif [[ "${{ needs.push.result }}" = "cancelled" ]]; then
echo 'NOTIFICATION_TEXT=**standalone_push_changes** workflow was canceled' >> $GITHUB_ENV
echo 'NOTIFICATION_AUTHOR_NAME=Canceled' >> $GITHUB_ENV
else
exit 1
fi
timeout-minutes: 5
# Send notification to Slack:
- name: 'Send notification'
# Pin action to full length commit SHA
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
if: success()
with:
status: "${{ env.NOTIFICATION_STATUS }}"
fields: repo,commit,message
text: "${{ env.NOTIFICATION_TEXT }}"
author_name: "${{ env.NOTIFICATION_AUTHOR_NAME }}"
env:
SLACK_WEBHOOK_URL: ${{ secrets.REPO_SLACK_WEBHOOK_URL }}
timeout-minutes: 5