diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 765d945..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:34:00.035Z diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml index 30656c4..e4f10fe 100644 --- 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 index 3acd3a9..b5291db 100644 --- 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 index c92f5c4..2984901 100644 --- 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 index a49b4c7..680aea0 100644 --- 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 index e1e3539..9106b5d 100644 --- a/.github/workflows/productionize.yml +++ b/.github/workflows/productionize.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 @@ -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 @@ -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 @@ -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/\/\/\/ /\/\/\/ /g" + find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /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" @@ -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 @@ -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 @@ -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/\/\/\/ /\/\/\/ /g" + find ./esm -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /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" diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 1345024..477ca6d 100644 --- 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/test.yml b/.github/workflows/test.yml index 62df42d..8a91394 100644 --- 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 index 4c30492..0c4e061 100644 --- 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 index 1b9adfa..912e7fe 100644 --- 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 index 9565ab2..12117e5 100644 --- 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 index f7aca1b..e6e7482 100644 --- 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 index 0ecec73..95d21af 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,14 @@ npm install @stdlib/utils-circular-buffer 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. +
@@ -417,8 +419,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/utils-circular-buffer.svg [npm-url]: https://npmjs.org/package/@stdlib/utils-circular-buffer -[test-image]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml/badge.svg?branch=v0.2.0 +[test-url]: https://github.com/stdlib-js/utils-circular-buffer/actions/workflows/test.yml?query=branch:v0.2.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-circular-buffer/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/utils-circular-buffer?branch=main @@ -441,8 +443,11 @@ Copyright © 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/utils-circular-buffer/tree/deno +[deno-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/umd +[umd-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/esm +[esm-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/utils-circular-buffer/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-circular-buffer/main/LICENSE diff --git a/branches.md b/branches.md index d02ca52..10b1994 100644 --- 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]). The following diagram illustrates the relationships among the above branches: @@ -49,5 +49,8 @@ C -->|bundle| F[umd]; [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/circular-buffer [production-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/production [deno-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/deno +[deno-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/umd -[esm-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/esm \ No newline at end of file +[umd-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/umd/README.md +[esm-url]: https://github.com/stdlib-js/utils-circular-buffer/tree/esm +[esm-readme]: https://github.com/stdlib-js/utils-circular-buffer/blob/esm/README.md \ No newline at end of file diff --git a/package.json b/package.json index 5483c0a..e95fa47 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/utils-circular-buffer", - "version": "0.1.0", + "version": "0.2.0", "description": "Circular buffer.", "license": "Apache-2.0", "author": { @@ -37,29 +37,29 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.1.0", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-positive-integer": "^0.1.0", - "@stdlib/constants-float64-max": "^0.1.1", - "@stdlib/string-format": "^0.1.1", - "@stdlib/symbol-iterator": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/array-base-arraylike2object": "^0.2.0", + "@stdlib/assert-is-collection": "^0.2.0", + "@stdlib/assert-is-nonnegative-integer": "^0.2.0", + "@stdlib/assert-is-positive-integer": "^0.2.0", + "@stdlib/constants-float64-max": "^0.2.0", + "@stdlib/string-format": "^0.2.0", + "@stdlib/symbol-iterator": "^0.2.0", + "@stdlib/types": "^0.3.1", + "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.2.0", + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" }, "devDependencies": { "@stdlib/array-complex128": "^0.1.0", - "@stdlib/assert-instance-of": "^0.1.1", - "@stdlib/complex-float64": "^0.1.1", - "@stdlib/complex-imag": "^0.1.1", - "@stdlib/complex-real": "^0.1.1", + "@stdlib/assert-instance-of": "^0.2.0", + "@stdlib/complex-float64": "^0.2.0", + "@stdlib/complex-imag": "^0.2.0", + "@stdlib/complex-real": "^0.2.0", "@stdlib/random-base-randu": "^0.1.0", "proxyquire": "^2.0.0", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" + "@stdlib/bench-harness": "^0.2.0" }, "engines": { "node": ">=0.10.0",