docs: update namespace table of contents #7146
Workflow file for this run
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) 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: run_affected_examples | |
# Workflow triggers: | |
on: | |
push: | |
paths: | |
# List paths for which changes should trigger this workflow: | |
- 'lib/**/examples/**' | |
- 'lib/**/README.md' | |
pull_request: | |
types: | |
- opened | |
- synchronize | |
- reopened | |
paths: | |
# List paths for which changes should trigger this workflow: | |
- 'lib/**/examples/**' | |
- 'lib/**/README.md' | |
# Global permissions: | |
permissions: | |
# Allow read-only access to the repository contents: | |
contents: read | |
# Workflow jobs: | |
jobs: | |
# Define a job for running changed examples... | |
process: | |
# Define a display name: | |
name: 'Run changed examples' | |
# 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@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 | |
# Initialize development environment: | |
- name: 'Initialize development environment' | |
run: | | |
make init | |
timeout-minutes: 5 | |
# Get list of changed files: | |
- name: 'Get list of changed files' | |
id: changed-files | |
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 | |
# Keep only examples and `README.md` files: | |
files=$(echo "$files" | grep -E 'examples/|README.md' | tr '\n' ' ' | sed 's/ $//') | |
echo "files=${files}" >> $GITHUB_OUTPUT | |
# Run JavaScript examples: | |
- name: 'Run JavaScript examples' | |
run: | | |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.js$' | tr '\n' ' ' | sed 's/ $//') | |
if [ -n "$files" ]; then | |
make examples-javascript-files FILES="${files}" | |
fi | |
timeout-minutes: 15 | |
# Run C examples: | |
- name: 'Run C examples' | |
run: | | |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.c$' | sed "s|^|${GITHUB_WORKSPACE}/|" | tr '\n' ' ' | sed 's/ $//') | |
if [ -n "$files" ]; then | |
make examples-c-files FILES="${files}" | |
fi | |
timeout-minutes: 15 | |
# Run examples in Markdown files: | |
- name: 'Run examples in Markdown files' | |
run: | | |
files=$(echo "${{ steps.changed-files.outputs.files }}" | tr ' ' '\n' | grep -E '\.md$' | tr '\n' ' ' | sed 's/ $//') | |
if [ -n "$files" ]; then | |
make markdown-examples-javascript-files FILES="${files}" | |
fi | |
timeout-minutes: 15 |