Skip to content

Commit

Permalink
Release v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 15, 2024
1 parent 3a8ec86 commit 11c5773
Show file tree
Hide file tree
Showing 17 changed files with 203 additions and 192 deletions.
1 change: 0 additions & 1 deletion .github/.keepalive

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/benchmark.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cancel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/npm_downloads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 12 additions & 12 deletions .github/workflows/productionize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -143,8 +143,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
Expand Down Expand Up @@ -256,8 +256,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
Expand All @@ -283,7 +283,7 @@ jobs:
find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/";
# Replace reference to `@stdlib/types` with CDN link:
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"
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"
# Change wording of project description to avoid reference to JavaScript and Node.js:
find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g"
Expand Down Expand Up @@ -424,8 +424,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
Expand Down Expand Up @@ -606,8 +606,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
Expand All @@ -634,7 +634,7 @@ jobs:
find ./esm -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/esm/";
# Replace reference to `@stdlib/types` with esm link:
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"
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"
# Change wording of project description to avoid reference to JavaScript and Node.js:
find ./esm -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g"
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test_bundles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
12 changes: 8 additions & 4 deletions .github/workflows/test_coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test_install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
52 changes: 26 additions & 26 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -181,32 +181,6 @@ The library links against the following external libraries or contains
implementations from the following external libraries, which have their own
licenses:

* Boost <http://www.boost.org/LICENSE_1_0.txt>

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
mt19937ar.c>

Expand Down Expand Up @@ -240,3 +214,29 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

* Boost <http://www.boost.org/LICENSE_1_0.txt>

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright (c) 2016-2023 The Stdlib Authors.
Copyright (c) 2016-2024 The Stdlib Authors.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ npm install @stdlib/random-base

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]).

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">
Expand Down Expand Up @@ -244,8 +246,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/random-base.svg
[npm-url]: https://npmjs.org/package/@stdlib/random-base

[test-image]: https://github.com/stdlib-js/random-base/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/random-base/actions/workflows/test.yml?query=branch:main
[test-image]: https://github.com/stdlib-js/random-base/actions/workflows/test.yml/badge.svg?branch=v0.2.0
[test-url]: https://github.com/stdlib-js/random-base/actions/workflows/test.yml?query=branch:v0.2.0

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-base/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/random-base?branch=main
Expand All @@ -268,8 +270,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-base/tree/deno
[deno-readme]: https://github.com/stdlib-js/random-base/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random-base/tree/umd
[umd-readme]: https://github.com/stdlib-js/random-base/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random-base/tree/esm
[esm-readme]: https://github.com/stdlib-js/random-base/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/random-base/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-base/main/LICENSE
Expand Down
11 changes: 7 additions & 4 deletions branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]).

The following diagram illustrates the relationships among the above branches:

Expand All @@ -49,5 +49,8 @@ C -->|bundle| F[umd];
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base
[production-url]: https://github.com/stdlib-js/random-base/tree/production
[deno-url]: https://github.com/stdlib-js/random-base/tree/deno
[deno-readme]: https://github.com/stdlib-js/random-base/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random-base/tree/umd
[esm-url]: https://github.com/stdlib-js/random-base/tree/esm
[umd-readme]: https://github.com/stdlib-js/random-base/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random-base/tree/esm
[esm-readme]: https://github.com/stdlib-js/random-base/blob/esm/README.md
4 changes: 2 additions & 2 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -927,8 +927,8 @@ interface Namespace {
* @returns value or PRNG
*
* @example
* var parseJSON = require( `@stdlib/utils/parse-json` );
* var mt19937 = require( `@stdlib/random/base/mt19937` );
* var parseJSON = require( '@stdlib/utils-parse-json' );
* var mt19937 = require( '@stdlib/random-base-mt19937' );
*
* var str = JSON.stringify( mt19937 );
* var rand = parseJSON( str, ns.reviveBasePRNG );
Expand Down
Loading

0 comments on commit 11c5773

Please sign in to comment.