Skip to content

namespace_exports

namespace_exports #791

#/
# @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: namespace_exports
# Workflow triggers:
on:
# 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 namespace exports...
update:
# Define a display name:
name: 'Update Namespace Exports'
# Ensure the job does not run on forks:
if: github.repository == 'stdlib-js/stdlib'
# 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
# Avoid storing GitHub token in local Git configuration:
persist-credentials: false
timeout-minutes: 10
# Install Node.js:
- name: 'Install Node.js'
# Pin action to full length commit SHA
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: '20' # '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 namespace exports:
- name: 'Update namespace exports'
run: |
# Determine root directory:
root=$(git rev-parse --show-toplevel)
# Get list of namespaces (e.g., '@stdlib/math/base' or '@stdlib/string'):
namespaces=$(make list-pkgs-namespaces)
# Prepend `${root}/lib/node_modules/` to each namespace:
namespaces=$(echo "${namespaces}" | sed "s|^|${root}/lib/node_modules/|")
# Append `/lib/index.js` to each namespace:
namespaces=$(echo "${namespaces}" | sed "s|$|/lib/index.js|")
# Replace newlines with spaces:
namespaces=$(echo "${namespaces}" | tr '\n' ' ')
# Print the list of namespaces files to update:
echo "${namespaces}"
# Lint and fix namespace exports:
make FILES="${namespaces}" FIX=1 FIX_TYPE="suggestion" lint-javascript-files
# 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@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.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 with the updated namespace exports:
- name: 'Create pull request'
id: cpr
# Pin action to full length commit SHA
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
with:
title: 'feat: update namespace exports'
body: |
This PR
- updates namespace exports
commit-message: 'feat: update namespace exports'
committer: 'stdlib-bot <[email protected]>'
signoff: true
token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
labels: |
automated-pr
team-reviewers: |
reviewers
branch: update-namespace-exports
delete-branch: true