Refactor: Move Packages in @stdlib/math/base/ops to Respective Subnamespaces #332
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) 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: update_repl_docs | |
# Workflow triggers: | |
on: | |
pull_request_target: | |
branches: | |
- develop | |
types: | |
- closed | |
paths: | |
# List paths for which changes should trigger this workflow: | |
- 'lib/**/namespace/lib/**' | |
- 'lib/**/docs/repl.txt' | |
# List paths for which changes should *not* trigger this workflow: | |
- '!lib/**/_tools/**' | |
# Allow the workflow to be manually run: | |
workflow_dispatch: | |
# Global permissions: | |
permissions: | |
# Allow read-only access to the repository contents: | |
contents: read | |
# Workflow jobs: | |
jobs: | |
# Define a job for updating REPL documentation... | |
update: | |
# Define a display name: | |
name: 'Update REPL docs' | |
# Only run this job if the pull request was merged (or the job was triggered manually): | |
if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch' | |
# 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 most recent commit: | |
fetch-depth: 1 | |
# 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 | |
# Update REPL documentation: | |
- name: 'Update documentation' | |
run: | | |
make repl-docs | |
# Disable Git hooks: | |
- name: 'Disable Git hooks' | |
run: | | |
rm -rf .git/hooks | |
# Import GPG key to sign commits: | |
- name: 'Import GPG key to sign commits' | |
# Pin action to full length commit SHA | |
uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0 | |
with: | |
gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }} | |
passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }} | |
git_user_signingkey: true | |
git_commit_gpgsign: true | |
# Create a pull request: | |
- name: 'Create pull request' | |
id: cpr | |
# Pin action to full length commit SHA | |
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0 | |
with: | |
title: 'docs: update REPL namespace documentation' | |
body: | | |
This PR | |
- updates the REPL namespace documentation | |
commit-message: 'docs: update REPL namespace documentation' | |
committer: 'stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>' | |
signoff: true | |
token: ${{ secrets.PULL_REQUEST_TOKEN }} | |
labels: | | |
documentation | |
automated-pr | |
team-reviewers: | | |
reviewers | |
branch: update-repl-docs | |
delete-branch: true | |
# Create a pull request summary: | |
- name: 'Create summary' | |
run: | | |
echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY | |
echo "" >> $GITHUB_STEP_SUMMARY | |
echo "Pull request ${{ steps.cpr.outputs.pull-request-number }} was successfully ${{ steps.cpr.outputs.pull-request-operation }}." | |
echo ":link: [${{ steps.cpr.outputs.pull-request-url }}](${{ steps.cpr.outputs.pull-request-url }})." >> $GITHUB_STEP_SUMMARY | |
echo "Head SHA: [${{ steps.cpr.outputs.pull-request-head-sha }}](${{ steps.cpr.outputs.pull-request-url }}/commits/${{ steps.cpr.outputs.pull-request-head-sha }})." >> $GITHUB_STEP_SUMMARY |