Skip to content

Commit c6d82dc

Browse files
committed
Release v0.2.0
1 parent fd401f7 commit c6d82dc

17 files changed

+119
-107
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

+14-13
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ jobs:
6767

6868
# Install Node.js:
6969
- name: 'Install Node.js'
70-
# Pin action to full length commit SHA corresponding to v3.8.1
71-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
70+
# Pin action to full length commit SHA
71+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
7272
with:
7373
node-version: 20
7474
timeout-minutes: 5
@@ -142,8 +142,8 @@ jobs:
142142
# Install Node.js:
143143
- name: 'Install Node.js'
144144
if: ${{ github.event.inputs.require-passing-tests == 'true' }}
145-
# Pin action to full length commit SHA corresponding to v3.8.1
146-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
145+
# Pin action to full length commit SHA
146+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
147147
with:
148148
node-version: 20
149149
timeout-minutes: 5
@@ -255,8 +255,8 @@ jobs:
255255
256256
# Install Node.js:
257257
- name: 'Install Node.js'
258-
# Pin action to full length commit SHA corresponding to v3.8.1
259-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
258+
# Pin action to full length commit SHA
259+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
260260
with:
261261
node-version: 20
262262
timeout-minutes: 5
@@ -423,8 +423,8 @@ jobs:
423423
424424
# Install Node.js
425425
- name: 'Install Node.js'
426-
# Pin action to full length commit SHA corresponding to v3.8.1
427-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
426+
# Pin action to full length commit SHA
427+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
428428
with:
429429
node-version: 20
430430
timeout-minutes: 5
@@ -604,8 +604,8 @@ jobs:
604604
605605
# Install Node.js:
606606
- name: 'Install Node.js'
607-
# Pin action to full length commit SHA corresponding to v3.8.1
608-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
607+
# Pin action to full length commit SHA
608+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
609609
with:
610610
node-version: 20
611611
timeout-minutes: 5
@@ -772,7 +772,7 @@ jobs:
772772
run: |
773773
mkdir -p cli
774774
mkdir -p cli/docs cli/test
775-
cp README.md LICENSE CONTRIBUTORS NOTICE ./cli
775+
cp README.md LICENSE CONTRIBUTORS NOTICE .npmignore ./cli
776776
cp -r bin etc ./cli
777777
if [ -e "test/test.cli.js" ]; then
778778
cp test/test.cli.js ./cli/test
@@ -784,8 +784,8 @@ jobs:
784784
785785
# Install Node.js:
786786
- name: 'Install Node.js'
787-
# Pin action to full length commit SHA corresponding to v3.8.1
788-
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
787+
# Pin action to full length commit SHA
788+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
789789
with:
790790
node-version: 20
791791
timeout-minutes: 5
@@ -870,6 +870,7 @@ jobs:
870870
# Move cli directory to root:
871871
- name: 'Move cli directory to root'
872872
run: |
873+
mv ./cli/.npmignore .
873874
mv ./cli/* .
874875
rmdir ./cli
875876

.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/publish_cli.yml

+6-6
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
@@ -122,8 +122,8 @@ jobs:
122122
123123
# Publish package to npm:
124124
- name: 'Publish package to npm'
125-
# Pin action to full length commit SHA corresponding to v2.2.2
126-
uses: JS-DevTools/npm-publish@fe72237be0920f7a0cafd6a966c9b929c9466e9b
125+
# Pin action to full length commit SHA
126+
uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
127127
with:
128128
token: ${{ secrets.NPM_TOKEN }}
129129
access: public
@@ -157,8 +157,8 @@ jobs:
157157

158158
# Cancel any running or queued workflow runs:
159159
- name: 'Cancel running or queued workflow runs'
160-
# Pin action to full length commit SHA corresponding to v0.11.0
161-
uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
160+
# Pin action to full length commit SHA
161+
uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
162162
with:
163163
workflow_id: >-
164164
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
@@ -45,13 +45,15 @@ npm install @stdlib/random-streams-minstd
4545

4646
Alternatively,
4747

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` branch][esm-url].
49-
- If you are using Deno, visit the [`deno` branch][deno-url].
50-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
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]).
5151
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
5252

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

55+
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.
56+
5557
</section>
5658

5759
<section class="usage">
@@ -563,8 +565,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
563565
[npm-image]: http://img.shields.io/npm/v/@stdlib/random-streams-minstd.svg
564566
[npm-url]: https://npmjs.org/package/@stdlib/random-streams-minstd
565567

566-
[test-image]: https://github.com/stdlib-js/random-streams-minstd/actions/workflows/test.yml/badge.svg?branch=main
567-
[test-url]: https://github.com/stdlib-js/random-streams-minstd/actions/workflows/test.yml?query=branch:main
568+
[test-image]: https://github.com/stdlib-js/random-streams-minstd/actions/workflows/test.yml/badge.svg?branch=v0.2.0
569+
[test-url]: https://github.com/stdlib-js/random-streams-minstd/actions/workflows/test.yml?query=branch:v0.2.0
568570

569571
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-minstd/main.svg
570572
[coverage-url]: https://codecov.io/github/stdlib-js/random-streams-minstd?branch=main
@@ -591,8 +593,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
591593
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
592594

593595
[deno-url]: https://github.com/stdlib-js/random-streams-minstd/tree/deno
596+
[deno-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/deno/README.md
594597
[umd-url]: https://github.com/stdlib-js/random-streams-minstd/tree/umd
598+
[umd-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/umd/README.md
595599
[esm-url]: https://github.com/stdlib-js/random-streams-minstd/tree/esm
600+
[esm-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/esm/README.md
596601
[branches-url]: https://github.com/stdlib-js/random-streams-minstd/blob/main/branches.md
597602

598603
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-minstd/main/LICENSE

branches.md

+6-3
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
- **cli**: [CLI][cli-url] branch for use on the command line.
3131

3232
The following diagram illustrates the relationships among the above branches:
@@ -52,6 +52,9 @@ C -->|extract| G[cli];
5252
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/minstd
5353
[production-url]: https://github.com/stdlib-js/random-streams-minstd/tree/production
5454
[deno-url]: https://github.com/stdlib-js/random-streams-minstd/tree/deno
55+
[deno-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/deno/README.md
5556
[umd-url]: https://github.com/stdlib-js/random-streams-minstd/tree/umd
57+
[umd-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/umd/README.md
5658
[esm-url]: https://github.com/stdlib-js/random-streams-minstd/tree/esm
59+
[esm-readme]: https://github.com/stdlib-js/random-streams-minstd/blob/esm/README.md
5760
[cli-url]: https://github.com/stdlib-js/random-streams-minstd/tree/cli

0 commit comments

Comments
 (0)