Skip to content

Commit ed3d7a0

Browse files
committed
Release v0.2.0
1 parent 1bb0107 commit ed3d7a0

16 files changed

+79
-68
lines changed

.github/.keepalive

-1
This file was deleted.

.github/workflows/benchmark.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646

4747
# Install Node.js:
4848
- name: 'Install Node.js'
49-
# Pin action to full length commit SHA corresponding to v3.8.1
50-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
49+
# Pin action to full length commit SHA
50+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
5151
with:
5252
node-version: 20
5353
timeout-minutes: 5

.github/workflows/cancel.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ jobs:
4444

4545
# Cancel existing workflow runs:
4646
- name: 'Cancel existing workflow runs'
47-
# Pin action to full length commit SHA corresponding to v0.11.0
48-
uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
47+
# Pin action to full length commit SHA
48+
uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
4949
with:
5050
workflow_id: >-
5151
benchmark.yml,

.github/workflows/examples.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646

4747
# Install Node.js:
4848
- name: 'Install Node.js'
49-
# Pin action to full length commit SHA corresponding to v3.8.1
50-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
49+
# Pin action to full length commit SHA
50+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
5151
with:
5252
node-version: 20
5353
timeout-minutes: 5

.github/workflows/npm_downloads.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ jobs:
5151

5252
# Install Node.js:
5353
- name: 'Install Node.js'
54-
# Pin action to full length commit SHA corresponding to v3.8.1
55-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
54+
# Pin action to full length commit SHA
55+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
5656
with:
5757
node-version: 20
5858
timeout-minutes: 5

.github/workflows/productionize.yml

+12-12
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ jobs:
6868

6969
# Install Node.js:
7070
- name: 'Install Node.js'
71-
# Pin action to full length commit SHA corresponding to v3.8.1
72-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
71+
# Pin action to full length commit SHA
72+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
7373
with:
7474
node-version: 20
7575
timeout-minutes: 5
@@ -143,8 +143,8 @@ jobs:
143143
# Install Node.js:
144144
- name: 'Install Node.js'
145145
if: ${{ github.event.inputs.require-passing-tests == 'true' }}
146-
# Pin action to full length commit SHA corresponding to v3.8.1
147-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
146+
# Pin action to full length commit SHA
147+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
148148
with:
149149
node-version: 20
150150
timeout-minutes: 5
@@ -256,8 +256,8 @@ jobs:
256256
257257
# Install Node.js:
258258
- name: 'Install Node.js'
259-
# Pin action to full length commit SHA corresponding to v3.8.1
260-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
259+
# Pin action to full length commit SHA
260+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
261261
with:
262262
node-version: 20
263263
timeout-minutes: 5
@@ -283,7 +283,7 @@ jobs:
283283
find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/";
284284
285285
# Replace reference to `@stdlib/types` with CDN link:
286-
find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ <reference types=\"@stdlib\/types\"\/>/\/\/\/ <reference types=\"https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/types@main\/index.d.ts\"\/>/g"
286+
find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ <reference types=\"@stdlib\/types\"\/>/\/\/\/ <reference types=\"https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/types@main\/index.d.ts\"\/>/g"
287287
288288
# Change wording of project description to avoid reference to JavaScript and Node.js:
289289
find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g"
@@ -424,8 +424,8 @@ jobs:
424424
425425
# Install Node.js
426426
- name: 'Install Node.js'
427-
# Pin action to full length commit SHA corresponding to v3.8.1
428-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
427+
# Pin action to full length commit SHA
428+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
429429
with:
430430
node-version: 20
431431
timeout-minutes: 5
@@ -606,8 +606,8 @@ jobs:
606606
607607
# Install Node.js:
608608
- name: 'Install Node.js'
609-
# Pin action to full length commit SHA corresponding to v3.8.1
610-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
609+
# Pin action to full length commit SHA
610+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
611611
with:
612612
node-version: 20
613613
timeout-minutes: 5
@@ -634,7 +634,7 @@ jobs:
634634
find ./esm -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/esm/";
635635
636636
# Replace reference to `@stdlib/types` with esm link:
637-
find ./esm -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ <reference types=\"@stdlib\/types\"\/>/\/\/\/ <reference types=\"https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/types@esm\/index.d.ts\"\/>/g"
637+
find ./esm -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ <reference types=\"@stdlib\/types\"\/>/\/\/\/ <reference types=\"https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/types@esm\/index.d.ts\"\/>/g"
638638
639639
# Change wording of project description to avoid reference to JavaScript and Node.js:
640640
find ./esm -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g"

.github/workflows/publish.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ jobs:
6666

6767
# Install Node.js:
6868
- name: 'Install Node.js'
69-
# Pin action to full length commit SHA corresponding to v3.8.1
70-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
69+
# Pin action to full length commit SHA
70+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
7171
with:
7272
node-version: 20
7373
timeout-minutes: 5
@@ -207,8 +207,8 @@ jobs:
207207
208208
# Publish package to npm:
209209
- name: 'Publish package to npm'
210-
# Pin action to full length commit SHA corresponding to v2.2.2
211-
uses: JS-DevTools/npm-publish@fe72237be0920f7a0cafd6a966c9b929c9466e9b
210+
# Pin action to full length commit SHA
211+
uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
212212
with:
213213
token: ${{ secrets.NPM_TOKEN }}
214214
access: public
@@ -242,8 +242,8 @@ jobs:
242242

243243
# Cancel any running or queued workflow runs:
244244
- name: 'Cancel running or queued workflow runs'
245-
# Pin action to full length commit SHA corresponding to v0.11.0
246-
uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
245+
# Pin action to full length commit SHA
246+
uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
247247
with:
248248
workflow_id: >-
249249
benchmark.yml,

.github/workflows/test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ jobs:
6363

6464
# Install Node.js:
6565
- name: 'Install Node.js'
66-
# Pin action to full length commit SHA corresponding to v3.8.1
67-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
66+
# Pin action to full length commit SHA
67+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
6868
with:
6969
node-version: 20
7070
timeout-minutes: 5

.github/workflows/test_bundles.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ jobs:
5656

5757
# Install Node.js:
5858
- name: 'Install Node.js'
59-
# Pin action to full length commit SHA corresponding to v3.8.1
60-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
59+
# Pin action to full length commit SHA
60+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
6161
with:
6262
node-version: 20
6363

@@ -123,8 +123,8 @@ jobs:
123123

124124
# Install Node.js:
125125
- name: 'Install Node.js'
126-
# Pin action to full length commit SHA corresponding to v3.8.1
127-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
126+
# Pin action to full length commit SHA
127+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
128128
with:
129129
node-version: 20
130130

.github/workflows/test_coverage.yml

+8-4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ jobs:
4141
# Define the type of virtual host machine on which to run the job:
4242
runs-on: ubuntu-latest
4343

44+
# Define environment variables:
45+
env:
46+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
47+
4448
# Define the sequence of job steps...
4549
steps:
4650

@@ -51,8 +55,8 @@ jobs:
5155

5256
# Install Node.js:
5357
- name: 'Install Node.js'
54-
# Pin action to full length commit SHA corresponding to v3.8.1
55-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
58+
# Pin action to full length commit SHA
59+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
5660
with:
5761
node-version: 20
5862
timeout-minutes: 5
@@ -79,8 +83,8 @@ jobs:
7983
# Upload coverage report to Codecov:
8084
- name: 'Upload coverage to Codecov'
8185
id: upload
82-
# Pin action to full length commit SHA corresponding to v3.1.4
83-
uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d
86+
# Pin action to full length commit SHA
87+
uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
8488
with:
8589
directory: reports/coverage
8690
flags: unittests

.github/workflows/test_install.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ jobs:
6363

6464
# Install Node.js:
6565
- name: 'Install Node.js'
66-
# Pin action to full length commit SHA corresponding to v3.8.1
67-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
66+
# Pin action to full length commit SHA
67+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
6868
with:
6969
node-version: 20
7070
timeout-minutes: 5

NOTICE

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

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ npm install @stdlib/ndarray-to-array
5555

5656
Alternatively,
5757

58-
- 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` branch][esm-url].
59-
- If you are using Deno, visit the [`deno` branch][deno-url].
60-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
58+
- 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]).
59+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
60+
- 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]).
6161

6262
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
6363

64+
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.
65+
6466
</section>
6567

6668
<section class="usage">
@@ -219,8 +221,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
219221
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-to-array.svg
220222
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-to-array
221223

222-
[test-image]: https://github.com/stdlib-js/ndarray-to-array/actions/workflows/test.yml/badge.svg?branch=main
223-
[test-url]: https://github.com/stdlib-js/ndarray-to-array/actions/workflows/test.yml?query=branch:main
224+
[test-image]: https://github.com/stdlib-js/ndarray-to-array/actions/workflows/test.yml/badge.svg?branch=v0.2.0
225+
[test-url]: https://github.com/stdlib-js/ndarray-to-array/actions/workflows/test.yml?query=branch:v0.2.0
224226

225227
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-to-array/main.svg
226228
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-to-array?branch=main
@@ -243,8 +245,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
243245
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
244246

245247
[deno-url]: https://github.com/stdlib-js/ndarray-to-array/tree/deno
248+
[deno-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/deno/README.md
246249
[umd-url]: https://github.com/stdlib-js/ndarray-to-array/tree/umd
250+
[umd-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/umd/README.md
247251
[esm-url]: https://github.com/stdlib-js/ndarray-to-array/tree/esm
252+
[esm-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/esm/README.md
248253
[branches-url]: https://github.com/stdlib-js/ndarray-to-array/blob/main/branches.md
249254

250255
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-to-array/main/LICENSE

branches.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This repository has the following branches:
2424

2525
- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
2626
- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
27-
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
28-
- **deno**: [Deno][deno-url] branch for use in Deno.
29-
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
27+
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
28+
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
29+
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
3030

3131
The following diagram illustrates the relationships among the above branches:
3232

@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
4949
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-array
5050
[production-url]: https://github.com/stdlib-js/ndarray-to-array/tree/production
5151
[deno-url]: https://github.com/stdlib-js/ndarray-to-array/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/ndarray-to-array/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/ndarray-to-array/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/ndarray-to-array/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/ndarray-to-array/blob/esm/README.md

docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { ndarray } from '@stdlib/types/ndarray';
2929
* @returns array (which may include nested arrays)
3030
*
3131
* @example
32-
* var array = require( `@stdlib/ndarray/array` );
32+
* var array = require( '@stdlib/ndarray-array' );
3333
*
3434
* var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );
3535
* var out = ndarray2array( arr );

package.json

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@stdlib/ndarray-to-array",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"description": "Convert an ndarray to a generic array.",
55
"license": "Apache-2.0",
66
"author": {
@@ -37,32 +37,32 @@
3737
"url": "https://github.com/stdlib-js/stdlib/issues"
3838
},
3939
"dependencies": {
40-
"@stdlib/assert-is-ndarray-like": "^0.1.0",
41-
"@stdlib/ndarray-base-to-array": "^0.1.0",
42-
"@stdlib/ndarray-data-buffer": "^0.1.0",
43-
"@stdlib/ndarray-offset": "^0.1.0",
44-
"@stdlib/ndarray-order": "^0.1.0",
45-
"@stdlib/ndarray-shape": "^0.1.0",
46-
"@stdlib/ndarray-strides": "^0.1.0",
47-
"@stdlib/string-format": "^0.1.1",
48-
"@stdlib/types": "^0.2.0"
40+
"@stdlib/assert-is-ndarray-like": "^0.2.0",
41+
"@stdlib/ndarray-base-to-array": "^0.2.0",
42+
"@stdlib/ndarray-data-buffer": "^0.2.0",
43+
"@stdlib/ndarray-offset": "^0.2.0",
44+
"@stdlib/ndarray-order": "^0.2.0",
45+
"@stdlib/ndarray-shape": "^0.2.0",
46+
"@stdlib/ndarray-strides": "^0.2.0",
47+
"@stdlib/string-format": "^0.2.0",
48+
"@stdlib/types": "^0.3.1"
4949
},
5050
"devDependencies": {
5151
"@stdlib/array-base-zero-to": "^0.1.0",
5252
"@stdlib/array-complex64": "^0.1.0",
53-
"@stdlib/assert-is-array": "^0.1.1",
54-
"@stdlib/assert-is-array-array": "^0.1.1",
55-
"@stdlib/complex-imagf": "^0.1.1",
56-
"@stdlib/complex-realf": "^0.1.1",
57-
"@stdlib/ndarray-base-numel": "^0.1.1",
58-
"@stdlib/ndarray-base-shape2strides": "^0.1.1",
59-
"@stdlib/ndarray-base-strides2offset": "^0.1.1",
53+
"@stdlib/assert-is-array": "^0.2.0",
54+
"@stdlib/assert-is-array-array": "^0.2.0",
55+
"@stdlib/complex-imagf": "^0.2.0",
56+
"@stdlib/complex-realf": "^0.2.0",
57+
"@stdlib/ndarray-base-numel": "^0.2.0",
58+
"@stdlib/ndarray-base-shape2strides": "^0.2.0",
59+
"@stdlib/ndarray-base-strides2offset": "^0.2.0",
6060
"@stdlib/ndarray-ctor": "^0.1.0",
6161
"@stdlib/random-base-discrete-uniform": "^0.1.0",
6262
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
6363
"istanbul": "^0.4.1",
6464
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
65-
"@stdlib/bench-harness": "^0.1.2"
65+
"@stdlib/bench-harness": "^0.2.0"
6666
},
6767
"engines": {
6868
"node": ">=0.10.0",

0 commit comments

Comments
 (0)