Skip to content

Commit 3c32b23

Browse files
committed
Auto-generated commit
1 parent 59e0858 commit 3c32b23

File tree

8 files changed

+214
-39
lines changed

8 files changed

+214
-39
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ indent_style = tab
121121
[*.{md,md.txt}]
122122
indent_style = space
123123
indent_size = 4
124-
trim_trailing_whitespace = false
124+
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.
125125
126126
# Set properties for `usage.txt` files:
127127
[usage.txt]

.github/.keepalive

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-08-01T06:11:49.430Z
1+
2025-01-13T02:16:50.400Z

.github/workflows/test_install.yml

+2-2
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:
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: '40 16 * * 6'
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()

CHANGELOG.md

+58-20
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,49 @@
22

33
> Package changelog.
44
5-
<section class="release" id="unreleased">
5+
<section class="release" id="v0.2.2">
6+
7+
## 0.2.2 (2024-07-29)
8+
9+
No changes reported for this release.
10+
11+
</section>
12+
13+
<!-- /.release -->
14+
15+
<section class="release" id="v0.2.1">
16+
17+
## 0.2.1 (2024-02-25)
18+
19+
No changes reported for this release.
620

7-
## Unreleased (2024-08-01)
21+
</section>
22+
23+
<!-- /.release -->
24+
25+
<section class="release" id="v0.2.0">
26+
27+
## 0.2.0 (2024-02-15)
28+
29+
<section class="bug-fixes">
30+
31+
### Bug Fixes
32+
33+
- [`8fccaaa`](https://github.com/stdlib-js/stdlib/commit/8fccaaa1d2ce14f2ee512f0ea307b53f9bd16211) - move links
34+
35+
</section>
36+
37+
<!-- /.bug-fixes -->
838

939
<section class="commits">
1040

1141
### Commits
1242

1343
<details>
1444

15-
- [`22c4d29`](https://github.com/stdlib-js/stdlib/commit/22c4d29898e2b5bb4cb071a6b7f62536027eaf28) - **docs:** remove blank line _(by Athan Reines)_
45+
- [`6b34523`](https://github.com/stdlib-js/stdlib/commit/6b3452322174342479d6c8b3277c3efee65d4cc0) - **docs:** update links _(by Athan Reines)_
46+
- [`8fccaaa`](https://github.com/stdlib-js/stdlib/commit/8fccaaa1d2ce14f2ee512f0ea307b53f9bd16211) - **fix:** move links _(by Athan Reines)_
47+
- [`54bec59`](https://github.com/stdlib-js/stdlib/commit/54bec5942986105b25f88fe9a633df91c837623a) - **refactor:** use accessor utility _(by Athan Reines)_
1648

1749
</details>
1850

@@ -36,41 +68,47 @@ A total of 1 person contributed to this release. Thank you to this contributor:
3668

3769
<!-- /.release -->
3870

39-
<section class="release" id="v0.2.2">
71+
<section class="release" id="v0.1.0">
4072

41-
## 0.2.2 (2024-07-29)
73+
## 0.1.0 (2023-09-24)
4274

43-
No changes reported for this release.
75+
<section class="bug-fixes">
76+
77+
### Bug Fixes
78+
79+
- [`2ef370c`](https://github.com/stdlib-js/stdlib/commit/2ef370c299de57a389c57f1815824b05665c9ece) - add missing test fixture [(#1054)](https://github.com/stdlib-js/stdlib/pull/1054)
4480

4581
</section>
4682

47-
<!-- /.release -->
83+
<!-- /.bug-fixes -->
4884

49-
<section class="release" id="v0.2.1">
85+
<section class="commits">
5086

51-
## 0.2.1 (2024-02-25)
87+
### Commits
5288

53-
No changes reported for this release.
89+
<details>
5490

55-
</section>
91+
- [`d358245`](https://github.com/stdlib-js/stdlib/commit/d358245c921277b5069a5baa037582adf22d22f7) - **docs:** fix require paths in README _(by Athan Reines)_
92+
- [`2ef370c`](https://github.com/stdlib-js/stdlib/commit/2ef370c299de57a389c57f1815824b05665c9ece) - **fix:** add missing test fixture [(#1054)](https://github.com/stdlib-js/stdlib/pull/1054) _(by Dan Rose)_
5693

57-
<!-- /.release -->
94+
</details>
5895

59-
<section class="release" id="v0.2.0">
96+
</section>
6097

61-
## 0.2.0 (2024-02-15)
98+
<!-- /.commits -->
6299

63-
No changes reported for this release.
100+
<section class="contributors">
64101

65-
</section>
102+
### Contributors
66103

67-
<!-- /.release -->
104+
A total of 2 people contributed to this release. Thank you to the following contributors:
68105

69-
<section class="release" id="v0.1.0">
106+
- Athan Reines
107+
- Dan Rose
70108

71-
## 0.1.0 (2023-09-24)
109+
</section>
72110

73-
No changes reported for this release.
111+
<!-- /.contributors -->
74112

75113
</section>
76114

CONTRIBUTORS

+45-13
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
#
33
# Contributors listed in alphabetical order.
44

5+
Aadish Jain <jain.aadishj@gmail.com>
6+
Aayush Khanna <aayushiitbhu23@gmail.com>
7+
Abhijit Raut <abhijitmraut8010@gmail.com>
58
Adarsh Palaskar <adarshpalaskar99@gmail.com>
69
Aditya Sapra <adityaework@gmail.com>
7-
AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com>
10+
Ahmed Atwa <Ahmedatwa866@yahoo.com>
11+
Ahmed Kashkoush <ahmedkashkoush464@gmail.com>
12+
Ahmed Khaled <kahmd1444@gmail.com>
813
Aleksandr <112382387+alextes90@users.noreply.github.com>
914
Ali Salesi <ali_sal1381@yahoo.com>
1015
Aman Bhansali <bhansali.1@iitj.ac.in>
@@ -20,59 +25,82 @@ Christopher Dambamuromo <chridam@gmail.com>
2025
Dan Rose <danoftheroses@gmail.com>
2126
Daniel Killenberger <daniel.killenberger@gmail.com>
2227
Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
28+
Debashis Maharana <debashismaharana7854@gmail.com>
29+
Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
30+
Dhruv Arvind Singh <154677013+DhruvArvindSingh@users.noreply.github.com>
31+
Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
32+
Dominic Lim <46486515+domlimm@users.noreply.github.com>
2333
Dominik Moritz <domoritz@gmail.com>
2434
Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
2535
EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
2636
Frank Kovacs <fran70kk@gmail.com>
2737
Golden Kumar <103646877+AuenKr@users.noreply.github.com>
2838
Gunj Joshi <gunjjoshi8372@gmail.com>
39+
Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>
40+
HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
2941
Harshita Kalani <harshitakalani02@gmail.com>
3042
Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
3143
Jaimin Godhani <112328542+Jai0401@users.noreply.github.com>
3244
James Gelok <jdgelok@gmail.com>
3345
Jaysukh Makvana <jaysukhmakvana2004@gmail.com>
46+
Jenish Thapa <141203631+jenish-thapa@users.noreply.github.com>
3447
Jithin KS <jithinks112@gmail.com>
3548
Joel Mathew Koshy <joelmathewkoshy@gmail.com>
3649
Joey Reed <joeyrreed@gmail.com>
3750
Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
3851
Joris Labie <joris.labie1@gmail.com>
3952
Justin Dennison <justin1dennison@gmail.com>
53+
Karan Anand <119553199+anandkaranubc@users.noreply.github.com>
4054
Karthik Prakash <116057817+skoriop@users.noreply.github.com>
41-
Khaldon <kahmd1444@gmail.com>
55+
Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
4256
Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
43-
Lovelin <100030865+lovelindhoni@users.noreply.github.com>
57+
Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
58+
Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
4459
Manik Sharma <maniksharma.rke@gmail.com>
60+
Manvith M <148960168+manvith2003@users.noreply.github.com>
4561
Marcus Fantham <mfantham@users.noreply.github.com>
4662
Matt Cochrane <matthew.cochrane.eng@gmail.com>
4763
Mihir Pandit <129577900+MSP20086@users.noreply.github.com>
4864
Milan Raj <rajsite@users.noreply.github.com>
65+
Mohammad Kaif <mdkaifprofession@gmail.com>
4966
Momtchil Momtchev <momtchil@momtchev.com>
5067
Muhammad Haris <harriskhan047@outlook.com>
5168
Naresh Jagadeesan <naresh.naresh000@gmail.com>
52-
NightKnight <Ahmedatwa866@yahoo.com>
69+
Naveen Kumar <stupiddint@gmail.com>
70+
Neeraj Pathak <neerajrpathak710@gmail.com>
71+
Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
5372
Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
5473
Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
5574
Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
5675
Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
76+
Ori Miles <97595296+orimiles5@users.noreply.github.com>
5777
Philipp Burckhardt <pburckhardt@outlook.com>
5878
Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
5979
Pranav Goswami <goswami.4@iitj.ac.in>
60-
Praneki <97080887+PraneGIT@users.noreply.github.com>
61-
Pratik <97464067+Pratik772846@users.noreply.github.com>
62-
Priyansh <88396544+itsspriyansh@users.noreply.github.com>
80+
Pranjal Jha <97080887+PraneGIT@users.noreply.github.com>
81+
Prashant Kumar Yadav <144602492+0PrashantYadav0@users.noreply.github.com>
82+
Pratik Singh <97464067+Pratik772846@users.noreply.github.com>
83+
Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
84+
Priyansh Prajapati <88396544+itsspriyansh@users.noreply.github.com>
85+
Priyanshu Agarwal <113460573+AgPriyanshu18@users.noreply.github.com>
6386
Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
6487
Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
6588
Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com>
6689
Ricky Reusser <rsreusser@gmail.com>
6790
Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
91+
Rishav <115060907+rishav2404@users.noreply.github.com>
6892
Robert Gislason <gztown2216@yahoo.com>
6993
Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
70-
Rutam <138517416+performant23@users.noreply.github.com>
94+
Rutam Kathale <138517416+performant23@users.noreply.github.com>
95+
Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
7196
Ryan Seal <splrk@users.noreply.github.com>
97+
Rylan Yang <137365285+rylany27@users.noreply.github.com>
7298
Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
99+
Sarthak Paandey <145528240+SarthakPaandey@users.noreply.github.com>
100+
Saurabh Singh <saurabhsraghuvanshi@gmail.com>
73101
Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
74102
Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
75-
Shivam <11shivam00@gmail.com>
103+
Shivam Ahir <11shivam00@gmail.com>
76104
Shraddheya Shendre <shendreshraddheya@gmail.com>
77105
Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
78106
Shubham Mishra <shubh622005@gmail.com>
@@ -81,16 +109,20 @@ Snehil Shah <snehilshah.989@gmail.com>
81109
Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com>
82110
Spandan Barve <contact@marsian.dev>
83111
Stephannie Jiménez Gacha <steff456@hotmail.com>
84-
Suraj kumar <125961509+kumarsuraj212003@users.noreply.github.com>
112+
Suraj Kumar <125961509+kumarsuraj212003@users.noreply.github.com>
85113
Tirtadwipa Manunggal <tirtadwipa.manunggal@gmail.com>
86114
Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
115+
Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
87116
Utkarsh <http://utkarsh11105@gmail.com>
88117
Utkarsh Raj <rajutkarsh2505@gmail.com>
118+
UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
119+
Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
89120
Varad Gupta <varadgupta21@gmail.com>
121+
Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
122+
Vivek Maurya <vm8118134@gmail.com>
90123
Xiaochuan Ye <tap91624@gmail.com>
124+
Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
91125
Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
92-
naveen <stupiddint@gmail.com>
93-
nishant-s7 <97207366+nishant-s7@users.noreply.github.com>
94-
orimiles5 <97595296+orimiles5@users.noreply.github.com>
126+
olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
95127
rainn <88160429+AmCodesLame@users.noreply.github.com>
96128
rei2hu <reimu@reimu.ws>

NOTICE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright (c) 2016-2024 The Stdlib Authors.
1+
Copyright (c) 2016-2025 The Stdlib Authors.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ See [LICENSE][stdlib-license].
238238

239239
## Copyright
240240

241-
Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
241+
Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
242242

243243
</section>
244244

0 commit comments

Comments
 (0)