Skip to content

Commit 3355066

Browse files
committed
Auto-generated commit
1 parent bf986de commit 3355066

10 files changed

+219
-79
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/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: '27 15 * * 1'
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

+5-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-07-31)
7+
## Unreleased (2025-01-11)
88

99
<section class="commits">
1010

1111
### Commits
1212

1313
<details>
1414

15+
- [`b24284b`](https://github.com/stdlib-js/stdlib/commit/b24284bcc4a781d2ef01efc6bb1f0c8fd631dcb3) - **test:** improve test values to resolve ambiguity in expected values _(by Athan Reines)_
16+
- [`e0cef99`](https://github.com/stdlib-js/stdlib/commit/e0cef995e884021db3001dc1a3cfef0ca7b368c2) - **style:** remove extra spaces for regular expressions in publish script _(by Philipp Burckhardt)_
1517
- [`e712640`](https://github.com/stdlib-js/stdlib/commit/e71264067123dab80b4f387574583d3c176523d9) - **docs:** fix offset types _(by Athan Reines)_
1618

1719
</details>
@@ -24,9 +26,10 @@
2426

2527
### Contributors
2628

27-
A total of 1 person contributed to this release. Thank you to this contributor:
29+
A total of 2 people contributed to this release. Thank you to the following contributors:
2830

2931
- Athan Reines
32+
- Philipp Burckhardt
3033

3134
</section>
3235

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 <[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,59 +25,82 @@ Christopher Dambamuromo <[email protected]>
2025
2126
Daniel Killenberger <[email protected]>
2227
Daniel Yu <[email protected]>
28+
Debashis Maharana <[email protected]>
29+
Desh Deepak Kant <[email protected]>
30+
Dhruv Arvind Singh <[email protected]>
31+
Divyansh Seth <[email protected]>
32+
Dominic Lim <[email protected]>
2333
Dominik Moritz <[email protected]>
2434
Dorrin Sotoudeh <[email protected]>
2535
EuniceSim142 <[email protected]>
2636
Frank Kovacs <[email protected]>
2737
Golden Kumar <[email protected]>
2838
Gunj Joshi <[email protected]>
39+
Gururaj Gurram <[email protected]>
40+
2941
Harshita Kalani <[email protected]>
3042
Hridyanshu <[email protected]>
3143
Jaimin Godhani <[email protected]>
3244
James Gelok <[email protected]>
3345
Jaysukh Makvana <[email protected]>
46+
Jenish Thapa <[email protected]>
3447
Jithin KS <[email protected]>
3548
Joel Mathew Koshy <[email protected]>
3649
Joey Reed <[email protected]>
3750
Jordan Gallivan <[email protected]>
3851
Joris Labie <[email protected]>
3952
Justin Dennison <[email protected]>
53+
Karan Anand <[email protected]>
4054
Karthik Prakash <[email protected]>
41-
Khaldon <kahmd1444@gmail.com>
55+
Kohantika Nath <[email protected].com>
4256
Krishnendu Das <[email protected]>
43-
57+
Kshitij-Dale <[email protected]>
58+
Lovelin Dhoni J B <[email protected]>
4459
Manik Sharma <[email protected]>
60+
Manvith M <[email protected]>
4561
Marcus Fantham <[email protected]>
4662
Matt Cochrane <[email protected]>
4763
Mihir Pandit <[email protected]>
4864
Milan Raj <[email protected]>
65+
Mohammad Kaif <[email protected]>
4966
Momtchil Momtchev <[email protected]>
5067
Muhammad Haris <[email protected]>
5168
Naresh Jagadeesan <[email protected]>
52-
NightKnight <[email protected]>
69+
Naveen Kumar <[email protected]>
70+
Neeraj Pathak <[email protected]>
71+
Nishant Shinde <[email protected]>
5372
Nithin Katta <[email protected]>
5473
Nourhan Hasan <[email protected]>
5574
Ognjen Jevremović <[email protected]>
5675
Oneday12323 <[email protected]>
76+
Ori Miles <[email protected]>
5777
Philipp Burckhardt <[email protected]>
5878
Prajwal Kulkarni <[email protected]>
5979
Pranav Goswami <[email protected]>
60-
61-
62-
80+
Pranjal Jha <[email protected]>
81+
Prashant Kumar Yadav <[email protected]>
82+
Pratik Singh <[email protected]>
83+
Pratyush Kumar Chouhan <[email protected]>
84+
Priyansh Prajapati <[email protected]>
85+
Priyanshu Agarwal <[email protected]>
6386
Pushpendra Chandravanshi <[email protected]>
6487
Raunak Kumar Gupta <[email protected]>
6588
Rejoan Sardar <[email protected]>
6689
Ricky Reusser <[email protected]>
6790
Ridam Garg <[email protected]>
91+
6892
Robert Gislason <[email protected]>
6993
Roman Stetsyk <[email protected]>
70-
94+
Rutam Kathale <[email protected]>
95+
Ruthwik Chikoti <[email protected]>
7196
Ryan Seal <[email protected]>
97+
Rylan Yang <[email protected]>
7298
Sai Srikar Dumpeti <[email protected]>
99+
Sarthak Paandey <[email protected]>
100+
Saurabh Singh <[email protected]>
73101
Seyyed Parsa Neshaei <[email protected]>
74102
Shashank Shekhar Singh <[email protected]>
75-
103+
Shivam Ahir <[email protected]>
76104
Shraddheya Shendre <[email protected]>
77105
Shubh Mehta <[email protected]>
78106
Shubham Mishra <[email protected]>
@@ -81,16 +109,20 @@ Snehil Shah <[email protected]>
81109
Soumajit Chatterjee <[email protected]>
82110
Spandan Barve <[email protected]>
83111
Stephannie Jiménez Gacha <[email protected]>
84-
Suraj kumar <[email protected]>
112+
Suraj Kumar <[email protected]>
85113
Tirtadwipa Manunggal <[email protected]>
86114
Tudor Pagu <[email protected]>
115+
Tufailahmed Bargir <[email protected]>
87116
Utkarsh <http://[email protected]>
88117
Utkarsh Raj <[email protected]>
118+
UtkershBasnet <[email protected]>
119+
Vaibhav Patel <[email protected]>
89120
Varad Gupta <[email protected]>
121+
Vinit Pandit <[email protected]>
122+
Vivek Maurya <[email protected]>
90123
Xiaochuan Ye <[email protected]>
124+
Yaswanth Kosuru <[email protected]>
91125
Yernar Yergaziyev <[email protected]>
92-
93-
nishant-s7 <[email protected]>
94-
orimiles5 <[email protected]>
126+
olenkabilonizhka <[email protected]>
95127
96128

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

+22-22
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,27 @@ limitations under the License.
3535

3636
> Copy all or part of a matrix `A` to another matrix `B`.
3737
38-
<section class = "usage">
38+
<section class="installation">
39+
40+
## Installation
41+
42+
```bash
43+
npm install @stdlib/lapack-base-dlacpy
44+
```
45+
46+
Alternatively,
47+
48+
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
49+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
50+
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
51+
52+
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
53+
54+
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
55+
56+
</section>
57+
58+
<section class="usage">
3959

4060
## Usage
4161

@@ -196,26 +216,6 @@ console.log( ndarray2array( B, shape, strides, 0, order ) );
196216

197217
<!-- C usage documentation. -->
198218

199-
<section class="installation">
200-
201-
## Installation
202-
203-
```bash
204-
npm install @stdlib/lapack-base-dlacpy
205-
```
206-
207-
Alternatively,
208-
209-
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
210-
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
211-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
212-
213-
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
214-
215-
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
216-
217-
</section>
218-
219219
<section class="usage">
220220

221221
### Usage
@@ -302,7 +302,7 @@ See [LICENSE][stdlib-license].
302302

303303
## Copyright
304304

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

307307
</section>
308308

dist/index.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"@stdlib/ndarray-base-assert-is-row-major": "^0.2.2",
4444
"@stdlib/ndarray-base-unary-loop-interchange-order": "^0.2.1",
4545
"@stdlib/string-format": "^0.2.2",
46-
"@stdlib/types": "^0.3.2",
46+
"@stdlib/types": "^0.4.3",
4747
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
4848
"@stdlib/utils-try-require": "^0.2.2",
4949
"@stdlib/error-tools-fmtprodmsg": "^0.2.2"

0 commit comments

Comments
 (0)