Skip to content

Update namespace TypeScript declarations #146

Update namespace TypeScript declarations

Update namespace TypeScript declarations #146

#/
# @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: namespace_declarations
# Workflow triggers:
on:
pull_request_target:
branches:
- develop
types:
- closed
paths:
# List paths for which changes should trigger this workflow:
- 'lib/**/types/index.d.ts'
# Allow the workflow to be manually run:
workflow_dispatch:
# Workflow jobs:
jobs:
# Define a job for updating namespace TypeScript declarations...
update:
# Define a display name:
name: 'Update TypeScript Declarations'
# Only run this job if the pull request was merged and did not have label `automated-pr` (or the job was triggered manually):
if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'automated-pr') == false || 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'
uses: actions/checkout@v3
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'
uses: actions/setup-node@v3
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
# Update namespace Typescript declarations:
- name: 'Update declarations'
run: |
make list-pkgs-namespaces | node lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js
# Disable Git hooks:
- name: 'Disable Git hooks'
run: |
rm -rf .git/hooks
# Create a pull request with the updated declarations:
- name: 'Create pull request'
id: cpr
uses: peter-evans/create-pull-request@v5
with:
title: 'Update namespace TypeScript declarations'
body: |
This PR
- updates namespace TypeScript declarations
commit-message: 'feat: update namespace TypeScript declarations'
committer: 'stdlib-bot <noreply@stdlib.io>'
token: ${{ secrets.PULL_REQUEST_TOKEN }}
labels: |
documentation
automated-pr
team-reviewers: |
reviewers
branch: update-namespace-declarations
delete-branch: true
# Create Markdown summary of the pull request:
- 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