Auto-generated commit

Author: stdlib-bot

.github/workflows/test_published_package.yml

@@ -0,0 +1,105 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 The Stdlib Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#/
+
+# Workflow name:
+name: test_published_package
+
+# Workflow triggers:
+on:
+  # Run workflow on a weekly schedule:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '37 13 * * 2'
+
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
+  # Allow workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+  test-published:
+    # Define a display name:
+    name: 'Test running examples of published package'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define environment variables:
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+
+    # Define the job's steps:
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        with:
+          node-version: 20
+        timeout-minutes: 5
+
+      # Create test directory and run examples:
+      - name: 'Create test directory and run examples'
+        run: |
+          cd ..
+          mkdir test-published
+          cd test-published
+
+          # Copy example file:
+          cp $GITHUB_WORKSPACE/examples/index.js .
+
+          # Create a minimal package.json
+          echo '{
+            "name": "test-published",
+            "version": "1.0.0",
+            "main": "index.js",
+            "dependencies": {}
+          }' > package.json
+
+          # Get package name and modify example file:
+          PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
+          ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
+
+          sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
+
+          # Extract and install dependencies:
+          DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
+          for dep in $DEPS; do
+            npm install $dep --save
+          done
+
+          # Run the example:
+          node index.js
+
+      # Send Slack notification if job fails:
+      - name: 'Send notification to Slack in case of failure'
+        uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
+        with:
+          status: ${{ job.status }}
+          channel: '#npm-ci'
+        if: failure()

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2024-12-09)
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`1c56b73`](https://github.com/stdlib-js/stdlib/commit/1c56b737ec018cc818cebf19e5c7947fa684e126) - **docs:** update related packages sections [(#3380)](https://github.com/stdlib-js/stdlib/pull/3380) _(by stdlib-bot)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.1.0">
 
 ## 0.1.0 (2024-07-29)

CONTRIBUTORS

@@ -2,9 +2,12 @@
 #
 # Contributors listed in alphabetical order.
 
+Aayush Khanna <[email protected]>
+Abhijit Raut <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
-AgPriyanshu18 <[email protected]>
+Ahmed Atwa <[email protected]>
+Ahmed Kashkoush <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
@@ -20,17 +23,22 @@ Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
+Debashis Maharana <[email protected]>
+Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 EuniceSim142 <[email protected]>
 Frank Kovacs <[email protected]>
 Golden Kumar <[email protected]>
 Gunj Joshi <[email protected]>
+Gururaj Gurram <[email protected]>
+HarshaNP <[email protected]>
 Harshita Kalani <[email protected]>
 Hridyanshu <[email protected]>
 Jaimin Godhani <[email protected]>
 James Gelok <[email protected]>
 Jaysukh Makvana <[email protected]>
+Jenish Thapa <[email protected]>
 Jithin KS <[email protected]>
 Joel Mathew Koshy <[email protected]>
 Joey Reed <[email protected]>
@@ -39,37 +47,50 @@ Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
 Karthik Prakash <[email protected]>
 Khaldon <[email protected]>
+Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
+Kshitij-Dale <[email protected]>
 Lovelin <[email protected]>
 Manik Sharma <[email protected]>
+Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
 Matt Cochrane <[email protected]>
 Mihir Pandit <[email protected]>
 Milan Raj <[email protected]>
+Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
-NightKnight <[email protected]>
+Neeraj Pathak <[email protected]>
+Nishant Shinde <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
+Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
 Praneki <[email protected]>
 Pratik <[email protected]>
+Pratyush Kumar Chouhan <[email protected]>
 Priyansh <[email protected]>
+Priyanshu Agarwal <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
 Ridam Garg <[email protected]>
+Rishav <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
-Rutam <[email protected]>
+Rutam Kathale <[email protected]>
+Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
+Rylan Yang <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
+Sarthak Paandey <[email protected]>
+Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
 Shivam <[email protected]>
@@ -81,16 +102,20 @@ Snehil Shah <[email protected]>
 Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
-Suraj kumar <[email protected]>
+Suraj Kumar <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
+Tufailahmed Bargir <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
+UtkershBasnet <[email protected]>
+Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
+Vinit Pandit <[email protected]>
 Xiaochuan Ye <[email protected]>
+Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
 naveen <[email protected]>
-nishant-s7 <[email protected]>
-orimiles5 <[email protected]>
+olenkabilonizhka <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>

README.md

@@ -179,6 +179,14 @@ console.log( out );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array-place`][@stdlib/array/place]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
+-   <span class="package-name">[`@stdlib/array-put`][@stdlib/array/put]</span><span class="delimiter">: </span><span class="description">replace specified elements of an array with provided values.</span>
+-   <span class="package-name">[`@stdlib/array-take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>
+
 </section>
 
 <!-- /.related -->
@@ -222,8 +230,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-mskput.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-mskput
 
-[test-image]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml/badge.svg?branch=main
+[test-url]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml?query=branch:main
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-mskput/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-mskput?branch=main
@@ -261,6 +269,16 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/array-same-kind-casts
 
+<!-- <related-links> -->
+
+[@stdlib/array/place]: https://github.com/stdlib-js/array-place
+
+[@stdlib/array/put]: https://github.com/stdlib-js/array-put
+
+[@stdlib/array/take]: https://github.com/stdlib-js/array-take
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package.json

@@ -41,20 +41,20 @@
     "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1",
     "@stdlib/array-base-assert-is-mostly-safe-data-type-cast": "^0.2.2",
     "@stdlib/array-base-assert-is-real-data-type": "^0.2.1",
-    "@stdlib/array-base-mskput": "^0.1.0",
+    "@stdlib/array-base-mskput": "^0.1.1",
     "@stdlib/array-convert": "^0.2.1",
     "@stdlib/array-dtype": "^0.3.0",
     "@stdlib/assert-has-own-property": "^0.2.2",
     "@stdlib/assert-is-collection": "^0.2.2",
     "@stdlib/assert-is-plain-object": "^0.2.2",
     "@stdlib/string-format": "^0.2.2",
-    "@stdlib/types": "^0.3.2",
+    "@stdlib/types": "^0.4.3",
     "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
   },
   "devDependencies": {
     "@stdlib/array-base-filled-by": "^0.2.2",
     "@stdlib/array-base-linspace": "^0.2.2",
-    "@stdlib/array-base-to-accessor-array": "^0.2.1",
+    "@stdlib/array-base-to-accessor-array": "^0.2.2",
     "@stdlib/array-base-zero-to": "^0.2.1",
     "@stdlib/array-base-zeros": "^0.2.2",
     "@stdlib/array-bool": "^0.1.0",