Release v0.2.0

stdlib-js · Feb 15, 2024 · 88627c6 · 88627c6
1 parent 1870cd4
commit 88627c6
Show file tree

Hide file tree

Showing 17 changed files with 120 additions and 108 deletions.
diff --git a/.github/.keepalive b/.github/.keepalive
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -46,8 +46,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5

diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml
@@ -44,8 +44,8 @@ jobs:
 
       # Cancel existing workflow runs:
       - name: 'Cancel existing workflow runs'
-        # Pin action to full length commit SHA corresponding to v0.11.0
-        uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
+        # Pin action to full length commit SHA
+        uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
         with:
           workflow_id: >-
             benchmark.yml,

diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -46,8 +46,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5

diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml
@@ -51,8 +51,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5

diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -67,8 +67,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -142,8 +142,8 @@ jobs:
       # Install Node.js:
       - name: 'Install Node.js'
         if: ${{ github.event.inputs.require-passing-tests == 'true' }}
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -255,8 +255,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -423,8 +423,8 @@ jobs:
 
       # Install Node.js
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -604,8 +604,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -772,7 +772,7 @@ jobs:
         run: |
           mkdir -p cli
           mkdir -p cli/docs cli/test
-          cp README.md LICENSE CONTRIBUTORS NOTICE ./cli
+          cp README.md LICENSE CONTRIBUTORS NOTICE .npmignore ./cli
           cp -r bin etc ./cli
           if [ -e "test/test.cli.js" ]; then
             cp test/test.cli.js ./cli/test
@@ -784,8 +784,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -870,6 +870,7 @@ jobs:
       # Move cli directory to root:
       - name: 'Move cli directory to root'
         run: |
+          mv ./cli/.npmignore .
           mv ./cli/* .
           rmdir ./cli
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -66,8 +66,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -207,8 +207,8 @@ jobs:
 
       # Publish package to npm:
       - name: 'Publish package to npm'
-        # Pin action to full length commit SHA corresponding to v2.2.2
-        uses: JS-DevTools/npm-publish@fe72237be0920f7a0cafd6a966c9b929c9466e9b
+        # Pin action to full length commit SHA
+        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
@@ -242,8 +242,8 @@ jobs:
 
       # Cancel any running or queued workflow runs:
       - name: 'Cancel running or queued workflow runs'
-        # Pin action to full length commit SHA corresponding to v0.11.0
-        uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
+        # Pin action to full length commit SHA
+        uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
         with:
           workflow_id: >-
             benchmark.yml,

diff --git a/.github/workflows/publish_cli.yml b/.github/workflows/publish_cli.yml
@@ -68,8 +68,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -122,8 +122,8 @@ jobs:
 
       # Publish package to npm:
       - name: 'Publish package to npm'
-        # Pin action to full length commit SHA corresponding to v2.2.2
-        uses: JS-DevTools/npm-publish@fe72237be0920f7a0cafd6a966c9b929c9466e9b
+        # Pin action to full length commit SHA
+        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
@@ -157,8 +157,8 @@ jobs:
 
       # Cancel any running or queued workflow runs:
       - name: 'Cancel running or queued workflow runs'
-        # Pin action to full length commit SHA corresponding to v0.11.0
-        uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
+        # Pin action to full length commit SHA
+        uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1
         with:
           workflow_id: >-
             benchmark.yml,

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -63,8 +63,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5

diff --git a/.github/workflows/test_bundles.yml b/.github/workflows/test_bundles.yml
@@ -56,8 +56,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
 
@@ -123,8 +123,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
 

diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml
@@ -41,6 +41,10 @@ jobs:
     # Define the type of virtual host machine on which to run the job:
     runs-on: ubuntu-latest
 
+    # Define environment variables:
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
     # Define the sequence of job steps...
     steps:
 
@@ -51,8 +55,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5
@@ -79,8 +83,8 @@ jobs:
       # Upload coverage report to Codecov:
       - name: 'Upload coverage to Codecov'
         id: upload
-        # Pin action to full length commit SHA corresponding to v3.1.4
-        uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d
+        # Pin action to full length commit SHA
+        uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
         with:
           directory: reports/coverage
           flags: unittests

diff --git a/.github/workflows/test_install.yml b/.github/workflows/test_install.yml
@@ -63,8 +63,8 @@ jobs:
 
       # Install Node.js:
       - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
+        # Pin action to full length commit SHA
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
           node-version: 20
         timeout-minutes: 5

diff --git a/NOTICE b/NOTICE
@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.
diff --git a/README.md b/README.md
@@ -45,13 +45,15 @@ npm install @stdlib/random-streams-lognormal
 
 Alternatively,
 
--   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].
--   If you are using Deno, visit the [`deno` branch][deno-url].
--   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
+-   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]).
+-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
+-   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]).
 -   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
 
 The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
 
+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.
+
 </section>
 
 <section class="usage">
@@ -619,8 +621,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/random-streams-lognormal.svg
 [npm-url]: https://npmjs.org/package/@stdlib/random-streams-lognormal
 
-[test-image]: https://github.com/stdlib-js/random-streams-lognormal/actions/workflows/test.yml/badge.svg?branch=main
-[test-url]: https://github.com/stdlib-js/random-streams-lognormal/actions/workflows/test.yml?query=branch:main
+[test-image]: https://github.com/stdlib-js/random-streams-lognormal/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/random-streams-lognormal/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-lognormal/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/random-streams-lognormal?branch=main
@@ -647,8 +649,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/deno
+[deno-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/umd
+[umd-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/esm
+[esm-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/random-streams-lognormal/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-lognormal/main/LICENSE

diff --git a/branches.md b/branches.md
@@ -24,9 +24,9 @@ This repository has the following branches:
 
 -   **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
 -   **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).
--   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
--   **deno**: [Deno][deno-url] branch for use in Deno.
--   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
+-   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
+-   **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
+-   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
 -   **cli**: [CLI][cli-url] branch for use on the command line.
 
 The following diagram illustrates the relationships among the above branches:
@@ -52,6 +52,9 @@ C -->|extract| G[cli];
 [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/lognormal
 [production-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/production
 [deno-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/deno
+[deno-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/umd
+[umd-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/esm
+[esm-readme]: https://github.com/stdlib-js/random-streams-lognormal/blob/esm/README.md
 [cli-url]: https://github.com/stdlib-js/random-streams-lognormal/tree/cli