Skip to content

Commit dc180fa

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent e129b6e commit dc180fa

File tree

6 files changed

+216
-23
lines changed

6 files changed

+216
-23
lines changed

‎.editorconfig‎

Lines changed: 1 addition & 1 deletion
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/workflows/test_install.yml‎

Lines changed: 2 additions & 2 deletions
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:

‎.github/workflows/test_published_package.yml‎

Lines changed: 105 additions & 0 deletions
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: '32 8 * * 3'
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‎

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,79 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-09-07)
7+
## Unreleased (2024-12-29)
88

99
<section class="packages">
1010

1111
### Packages
1212

13+
<section class="package" id="random-array-tools-unreleased">
14+
15+
#### [@stdlib/random/array/tools](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools)
16+
17+
<details>
18+
19+
<section class="features">
20+
21+
##### Features
22+
23+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
24+
25+
</section>
26+
27+
<!-- /.features -->
28+
29+
<section class="bug-fixes">
30+
31+
##### Bug Fixes
32+
33+
- [`83f2a61`](https://github.com/stdlib-js/stdlib/commit/83f2a613faa1661bdf1aebea1b4723044204f561) - remove unused imports
34+
35+
</section>
36+
37+
<!-- /.bug-fixes -->
38+
39+
<section class="breaking-changes">
40+
41+
##### BREAKING CHANGES
42+
43+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
44+
45+
- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.
46+
47+
</section>
48+
49+
<!-- /.breaking-changes -->
50+
51+
</details>
52+
53+
</section>
54+
55+
<!-- /.package -->
56+
1357
</section>
1458

1559
<!-- /.packages -->
1660

61+
<section class="breaking-changes">
62+
63+
### BREAKING CHANGES
64+
65+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
66+
67+
- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.
68+
69+
</section>
70+
71+
<!-- /.breaking-changes -->
72+
1773
<section class="contributors">
1874

1975
### Contributors
2076

21-
A total of 3 people contributed to this release. Thank you to the following contributors:
77+
A total of 4 people contributed to this release. Thank you to the following contributors:
2278

79+
- Athan Reines
2380
- Jenish Thapa
2481
- Philipp Burckhardt
2582
- Tirtadwipa Manunggal
@@ -34,6 +91,11 @@ A total of 3 people contributed to this release. Thank you to the following cont
3491

3592
<details>
3693

94+
- [`b87254d`](https://github.com/stdlib-js/stdlib/commit/b87254d4535a3b90bf3d0068750ed6e9ca5dbc85) - **docs:** fix parameter descriptions in Weibull distribution packages _(by Philipp Burckhardt)_
95+
- [`32deb11`](https://github.com/stdlib-js/stdlib/commit/32deb11c6a2453748d8db9554b6bb3fdb73a077f) - **docs:** update related packages sections [(#3976)](https://github.com/stdlib-js/stdlib/pull/3976) _(by stdlib-bot)_
96+
- [`83f2a61`](https://github.com/stdlib-js/stdlib/commit/83f2a613faa1661bdf1aebea1b4723044204f561) - **fix:** remove unused imports _(by Athan Reines)_
97+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - **feat:** update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190) _(by stdlib-bot, Philipp Burckhardt)_
98+
- [`aad48ea`](https://github.com/stdlib-js/stdlib/commit/aad48eab1f19217854f4ffbfaed2a8be664b0f47) - **chore:** resolve lint errors _(by Philipp Burckhardt)_
3799
- [`62bb1e0`](https://github.com/stdlib-js/stdlib/commit/62bb1e0759f54abf61b84bb48ebf74a97128f779) - **docs:** improve examples of `random/array` namespace _(by Tirtadwipa Manunggal, Philipp Burckhardt)_
38100
- [`8e110d6`](https://github.com/stdlib-js/stdlib/commit/8e110d608afcc21dd633b7f1939f92ef7f3085e1) - **docs:** update examples for `random/array/tools` _(by Jenish Thapa, Philipp Burckhardt)_
39101
- [`53fd65d`](https://github.com/stdlib-js/stdlib/commit/53fd65de03a466f6cf3ca0752c0908a57ef151b1) - **docs:** update related packages sections [(#2240)](https://github.com/stdlib-js/stdlib/pull/2240) _(by stdlib-bot)_

‎CONTRIBUTORS‎

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
#
33
# Contributors listed in alphabetical order.
44

5+
Aadish Jain <[email protected]>
6+
Aayush Khanna <[email protected]>
7+
Abhijit Raut <[email protected]>
58
Adarsh Palaskar <[email protected]>
69
Aditya Sapra <[email protected]>
7-
AgPriyanshu18 <[email protected]>
10+
Ahmed Atwa <[email protected]>
11+
Ahmed Kashkoush <[email protected]>
12+
Ahmed Khaled <[email protected]>
813
Aleksandr <[email protected]>
914
Ali Salesi <[email protected]>
1015
Aman Bhansali <[email protected]>
@@ -20,62 +25,80 @@ Christopher Dambamuromo <[email protected]>
2025
Dan Rose <[email protected]>
2126
Daniel Killenberger <[email protected]>
2227
Daniel Yu <[email protected]>
28+
Debashis Maharana <[email protected]>
29+
Desh Deepak Kant <[email protected]>
30+
Divyansh Seth <[email protected]>
31+
Dominic Lim <[email protected]>
2332
Dominik Moritz <[email protected]>
2433
Dorrin Sotoudeh <[email protected]>
2534
EuniceSim142 <[email protected]>
2635
Frank Kovacs <[email protected]>
2736
Golden Kumar <[email protected]>
2837
Gunj Joshi <[email protected]>
38+
Gururaj Gurram <[email protected]>
2939
HarshaNP <[email protected]>
3040
Harshita Kalani <[email protected]>
3141
Hridyanshu <[email protected]>
3242
Jaimin Godhani <[email protected]>
3343
James Gelok <[email protected]>
3444
Jaysukh Makvana <[email protected]>
45+
Jenish Thapa <[email protected]>
3546
Jithin KS <[email protected]>
3647
Joel Mathew Koshy <[email protected]>
3748
Joey Reed <[email protected]>
3849
Jordan Gallivan <[email protected]>
3950
Joris Labie <[email protected]>
4051
Justin Dennison <[email protected]>
4152
Karthik Prakash <[email protected]>
42-
Khaldon <kahmd1444@gmail.com>
53+
Kohantika Nath <[email protected].com>
4354
Krishnendu Das <[email protected]>
44-
Lovelin <[email protected]>
55+
Kshitij-Dale <[email protected]>
56+
Lovelin Dhoni J B <[email protected]>
4557
Manik Sharma <[email protected]>
58+
Manvith M <[email protected]>
4659
Marcus Fantham <[email protected]>
4760
Matt Cochrane <[email protected]>
4861
Mihir Pandit <[email protected]>
4962
Milan Raj <[email protected]>
50-
Mohammad Kaif <[email protected].com>
63+
Mohammad Kaif <mdkaifprofession@gmail.com>
5164
Momtchil Momtchev <[email protected]>
5265
Muhammad Haris <[email protected]>
5366
Naresh Jagadeesan <[email protected]>
54-
NightKnight <[email protected]>
67+
Naveen Kumar <[email protected]>
68+
Neeraj Pathak <[email protected]>
69+
Nishant Shinde <[email protected]>
5570
Nithin Katta <[email protected]>
5671
Nourhan Hasan <[email protected]>
5772
Ognjen Jevremović <[email protected]>
5873
Oneday12323 <[email protected]>
74+
Ori Miles <[email protected]>
5975
Philipp Burckhardt <[email protected]>
6076
Prajwal Kulkarni <[email protected]>
6177
Pranav Goswami <[email protected]>
62-
Praneki <[email protected]>
63-
Pratik <[email protected]>
64-
Priyansh <[email protected]>
78+
Pranjal Jha <[email protected]>
79+
Prashant Kumar Yadav <[email protected]>
80+
Pratik Singh <[email protected]>
81+
Pratyush Kumar Chouhan <[email protected]>
82+
Priyansh Prajapati <[email protected]>
83+
Priyanshu Agarwal <[email protected]>
6584
Pushpendra Chandravanshi <[email protected]>
6685
Raunak Kumar Gupta <[email protected]>
6786
Rejoan Sardar <[email protected]>
6887
Ricky Reusser <[email protected]>
6988
Ridam Garg <[email protected]>
89+
Rishav <[email protected]>
7090
Robert Gislason <[email protected]>
7191
Roman Stetsyk <[email protected]>
72-
Rutam <[email protected]>
92+
Rutam Kathale <[email protected]>
93+
Ruthwik Chikoti <[email protected]>
7394
Ryan Seal <[email protected]>
95+
Rylan Yang <[email protected]>
7496
Sai Srikar Dumpeti <[email protected]>
75-
SarthakPaandey <[email protected]>
97+
Sarthak Paandey <[email protected]>
98+
Saurabh Singh <[email protected]>
7699
Seyyed Parsa Neshaei <[email protected]>
77100
Shashank Shekhar Singh <[email protected]>
78-
Shivam <[email protected]>
101+
Shivam Ahir <[email protected]>
79102
Shraddheya Shendre <[email protected]>
80103
Shubh Mehta <[email protected]>
81104
Shubham Mishra <[email protected]>
@@ -84,17 +107,20 @@ Snehil Shah <[email protected]>
84107
Soumajit Chatterjee <[email protected]>
85108
Spandan Barve <[email protected]>
86109
Stephannie Jiménez Gacha <[email protected]>
87-
Suraj kumar <[email protected]>
110+
Suraj Kumar <[email protected]>
88111
Tirtadwipa Manunggal <[email protected]>
89112
Tudor Pagu <[email protected]>
113+
Tufailahmed Bargir <[email protected]>
90114
Utkarsh <http://[email protected]>
91115
Utkarsh Raj <[email protected]>
116+
UtkershBasnet <[email protected]>
117+
Vaibhav Patel <[email protected]>
92118
Varad Gupta <[email protected]>
119+
Vinit Pandit <[email protected]>
120+
Vivek maurya <[email protected]>
93121
Xiaochuan Ye <[email protected]>
122+
Yaswanth Kosuru <[email protected]>
94123
Yernar Yergaziyev <[email protected]>
95-
naveen <[email protected]>
96-
nishant-s7 <[email protected]>
97-
orimiles5 <[email protected]>
124+
olenkabilonizhka <[email protected]>
98125
rainn <[email protected]>
99126
rei2hu <[email protected]>
100-
yaswanth <[email protected]>

‎docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -821,8 +821,8 @@ interface Namespace {
821821
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
822822
*
823823
* @param len - array length
824-
* @param k - scale parameter
825-
* @param lambda - shape parameter
824+
* @param k - shape parameter
825+
* @param lambda - scale parameter
826826
* @param options - function options
827827
* @returns output array
828828
*

0 commit comments

Comments
 (0)