Skip to content

Commit ff9a60b

Browse files
stdlib-botstdlib-bot
committedJan 20, 2025·
Auto-generated commit
1 parent 4e38468 commit ff9a60b

18 files changed

+445
-102
lines changed
 

‎.editorconfig

+1-2
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ indent_style = tab
8686
[*.{f,f.txt}]
8787
indent_style = space
8888
indent_size = 2
89-
insert_final_newline = false
9089

9190
# Set properties for shell files:
9291
[*.{sh,sh.txt}]
@@ -121,7 +120,7 @@ indent_style = tab
121120
[*.{md,md.txt}]
122121
indent_style = space
123122
indent_size = 4
124-
trim_trailing_whitespace = false
123+
trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
125124
126125
# Set properties for `usage.txt` files:
127126
[usage.txt]

‎.gitattributes

+23-6
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,27 @@
4040
*.mov binary
4141

4242
# Override what is considered "vendored" by GitHub's linguist:
43-
/deps/** linguist-vendored=false
44-
/lib/node_modules/** linguist-vendored=false linguist-generated=false
45-
test/fixtures/** linguist-vendored=false
46-
tools/** linguist-vendored=false
43+
/lib/node_modules/** -linguist-vendored -linguist-generated
4744

48-
# Override what is considered "documentation" by GitHub's linguist:
49-
examples/** linguist-documentation=false
45+
# Configure directories which should *not* be included in GitHub language statistics:
46+
/deps/** linguist-vendored
47+
/dist/** linguist-generated
48+
/workshops/** linguist-vendored
49+
50+
benchmark/** linguist-vendored
51+
docs/* linguist-documentation
52+
etc/** linguist-vendored
53+
examples/** linguist-documentation
54+
scripts/** linguist-vendored
55+
test/** linguist-vendored
56+
tools/** linguist-vendored
57+
58+
# Configure files which should *not* be included in GitHub language statistics:
59+
Makefile linguist-vendored
60+
*.mk linguist-vendored
61+
*.jl linguist-vendored
62+
*.py linguist-vendored
63+
*.R linguist-vendored
64+
65+
# Configure files which should be included in GitHub language statistics:
66+
docs/types/*.d.ts -linguist-documentation

‎.github/.keepalive

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-01-20T01:36:06.789Z

‎.github/workflows/productionize.yml

+12-16
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ jobs:
9393
node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );"
9494
fi
9595
96-
# Configure git:
97-
- name: 'Configure git'
96+
# Configure Git:
97+
- name: 'Configure Git'
9898
run: |
9999
git config --local user.email "noreply@stdlib.io"
100100
git config --local user.name "stdlib-bot"
@@ -190,8 +190,8 @@ jobs:
190190
# Pin action to full length commit SHA
191191
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
192192

193-
# Configure git:
194-
- name: 'Configure git'
193+
# Configure Git:
194+
- name: 'Configure Git'
195195
run: |
196196
git config --local user.email "noreply@stdlib.io"
197197
git config --local user.name "stdlib-bot"
@@ -343,7 +343,6 @@ jobs:
343343
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
344344
with:
345345
status: ${{ job.status }}
346-
steps: ${{ toJson(steps) }}
347346
channel: '#npm-ci'
348347
if: failure()
349348

@@ -366,8 +365,8 @@ jobs:
366365
# Pin action to full length commit SHA
367366
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
368367

369-
# Configure git:
370-
- name: 'Configure git'
368+
# Configure Git:
369+
- name: 'Configure Git'
371370
run: |
372371
git config --local user.email "noreply@stdlib.io"
373372
git config --local user.name "stdlib-bot"
@@ -516,7 +515,6 @@ jobs:
516515
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
517516
with:
518517
status: ${{ job.status }}
519-
steps: ${{ toJson(steps) }}
520518
channel: '#npm-ci'
521519
if: failure()
522520

@@ -539,8 +537,8 @@ jobs:
539537
# Pin action to full length commit SHA
540538
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
541539

542-
# Configure git:
543-
- name: 'Configure git'
540+
# Configure Git:
541+
- name: 'Configure Git'
544542
run: |
545543
git config --local user.email "noreply@stdlib.io"
546544
git config --local user.name "stdlib-bot"
@@ -695,7 +693,6 @@ jobs:
695693
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
696694
with:
697695
status: ${{ job.status }}
698-
steps: ${{ toJson(steps) }}
699696
channel: '#npm-ci'
700697
if: failure()
701698

@@ -718,8 +715,8 @@ jobs:
718715
# Pin action to full length commit SHA
719716
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
720717

721-
# Configure git:
722-
- name: 'Configure git'
718+
# Configure Git:
719+
- name: 'Configure Git'
723720
run: |
724721
git config --local user.email "noreply@stdlib.io"
725722
git config --local user.name "stdlib-bot"
@@ -893,7 +890,6 @@ jobs:
893890
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
894891
with:
895892
status: ${{ job.status }}
896-
steps: ${{ toJson(steps) }}
897893
channel: '#npm-ci'
898894
if: failure()
899895

@@ -933,8 +929,8 @@ jobs:
933929
echo "bump=true" >> $GITHUB_OUTPUT
934930
fi
935931
936-
# Configure git:
937-
- name: 'Configure git'
932+
# Configure Git:
933+
- name: 'Configure Git'
938934
if: steps.check-if-bump.outputs.bump
939935
run: |
940936
git config --local user.email "noreply@stdlib.io"

‎.github/workflows/publish.yml

+7-4
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ jobs:
7272
node-version: 20
7373
timeout-minutes: 5
7474

75-
# Configure git:
76-
- name: 'Configure git'
75+
# Configure Git:
76+
- name: 'Configure Git'
7777
run: |
7878
git config --local user.email "noreply@stdlib.io"
7979
git config --local user.name "stdlib-bot"
@@ -94,6 +94,10 @@ jobs:
9494
# Replace branch in README.md link definitions for badges with the new version:
9595
find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g"
9696
97+
# Rewrite CHANGELOG.md to replace "Unreleased" with the new version:
98+
sed -Ei "s/Unreleased/${NEW_VERSION}/g" CHANGELOG.md
99+
sed -Ei "s/unreleased/v${NEW_VERSION}/g" CHANGELOG.md
100+
97101
# Create a new commit and tag:
98102
git add package.json README.md
99103
git commit -m "Release v${NEW_VERSION}"
@@ -202,7 +206,7 @@ jobs:
202206
# Publish package to npm:
203207
- name: 'Publish package to npm'
204208
# Pin action to full length commit SHA
205-
uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
209+
uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
206210
with:
207211
token: ${{ secrets.NPM_TOKEN }}
208212
access: public
@@ -218,7 +222,6 @@ jobs:
218222
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
219223
with:
220224
status: ${{ job.status }}
221-
steps: ${{ toJson(steps) }}
222225
channel: '#npm-ci'
223226
if: failure()
224227

‎.github/workflows/publish_cli.yml

+3-4
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ jobs:
7474
node-version: 20
7575
timeout-minutes: 5
7676

77-
# Configure git:
78-
- name: 'Configure git'
77+
# Configure Git:
78+
- name: 'Configure Git'
7979
run: |
8080
git config --local user.email "noreply@stdlib.io"
8181
git config --local user.name "stdlib-bot"
@@ -129,7 +129,7 @@ jobs:
129129
# Publish package to npm:
130130
- name: 'Publish package to npm'
131131
# Pin action to full length commit SHA
132-
uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
132+
uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
133133
with:
134134
token: ${{ secrets.NPM_TOKEN }}
135135
access: public
@@ -145,7 +145,6 @@ jobs:
145145
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
146146
with:
147147
status: ${{ job.status }}
148-
steps: ${{ toJson(steps) }}
149148
channel: '#npm-ci'
150149
if: failure()
151150

‎.github/workflows/test.yml

-1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,5 @@ jobs:
9595
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
9696
with:
9797
status: ${{ job.status }}
98-
steps: ${{ toJson(steps) }}
9998
channel: '#npm-ci'
10099
if: failure()

‎.github/workflows/test_bundles.yml

-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ jobs:
9494
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
9595
with:
9696
status: ${{ job.status }}
97-
steps: ${{ toJson(steps) }}
9897
channel: '#npm-ci'
9998
if: failure()
10099

@@ -139,7 +138,6 @@ jobs:
139138
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
140139
with:
141140
status: ${{ job.status }}
142-
steps: ${{ toJson(steps) }}
143141
channel: '#npm-ci'
144142
if: failure()
145143

@@ -184,6 +182,5 @@ jobs:
184182
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
185183
with:
186184
status: ${{ job.status }}
187-
steps: ${{ toJson(steps) }}
188185
channel: '#npm-ci'
189186
if: failure()

‎.github/workflows/test_coverage.yml

-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ jobs:
119119
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
120120
with:
121121
status: ${{ job.status }}
122-
steps: ${{ toJson(steps) }}
123122
channel: '#npm-ci'
124123
if: failure()
125124

‎.github/workflows/test_install.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ jobs:
5050
env:
5151
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
5252

53-
# Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
54-
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
53+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
54+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
5555

5656
# Define the sequence of job steps...
5757
steps:
@@ -81,6 +81,5 @@ jobs:
8181
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
8282
with:
8383
status: ${{ job.status }}
84-
steps: ${{ toJson(steps) }}
8584
channel: '#npm-ci'
8685
if: failure()

‎.github/workflows/test_published_package.yml

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2024 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# Workflow name:
20+
name: test_published_package
21+
22+
# Workflow triggers:
23+
on:
24+
# Run workflow on a weekly schedule:
25+
schedule:
26+
# * is a special character in YAML so you have to quote this string
27+
- cron: '45 21 * * 2'
28+
29+
# Run workflow upon completion of `publish` workflow run:
30+
workflow_run:
31+
workflows: ["publish"]
32+
types: [completed]
33+
34+
# Allow workflow to be manually run:
35+
workflow_dispatch:
36+
37+
# Workflow jobs:
38+
jobs:
39+
test-published:
40+
# Define a display name:
41+
name: 'Test running examples of published package'
42+
43+
# Define the type of virtual host machine:
44+
runs-on: ubuntu-latest
45+
46+
# Define environment variables:
47+
env:
48+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
49+
50+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
51+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
52+
53+
# Define the job's steps:
54+
steps:
55+
# Checkout the repository:
56+
- name: 'Checkout repository'
57+
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
58+
59+
# Install Node.js:
60+
- name: 'Install Node.js'
61+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
62+
with:
63+
node-version: 20
64+
timeout-minutes: 5
65+
66+
# Create test directory and run examples:
67+
- name: 'Create test directory and run examples'
68+
run: |
69+
cd ..
70+
mkdir test-published
71+
cd test-published
72+
73+
# Copy example file:
74+
cp $GITHUB_WORKSPACE/examples/index.js .
75+
76+
# Create a minimal package.json
77+
echo '{
78+
"name": "test-published",
79+
"version": "1.0.0",
80+
"main": "index.js",
81+
"dependencies": {}
82+
}' > package.json
83+
84+
# Get package name and modify example file:
85+
PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
86+
ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
87+
88+
sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
89+
90+
# Extract and install dependencies:
91+
DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
92+
for dep in $DEPS; do
93+
npm install $dep --save
94+
done
95+
96+
# Run the example:
97+
node index.js
98+
99+
# Send Slack notification if job fails:
100+
- name: 'Send notification to Slack in case of failure'
101+
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
102+
with:
103+
status: ${{ job.status }}
104+
channel: '#npm-ci'
105+
if: failure()

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ docs/**/node_modules/
101101
pids
102102
*.pid
103103
*.seed
104+
yarn.lock
105+
package-lock.json
104106

105107
# Typescript #
106108
##############

‎.npmrc

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ shrinkwrap = false
2727
# Disable automatically "saving" dependencies on install:
2828
save = false
2929

30-
# Generate provenance metadata:
31-
provenance = true
30+
# Do not generate provenance metadata:
31+
provenance = false

0 commit comments

Comments
 (0)
Please sign in to comment.