8000 Auto-generated commit · stdlib-js/complex@f47a2e6 · GitHub
[go: up one dir, main page]
Skip to content

Commit f47a2e6

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 324f984 commit f47a2e6

File tree

5 files changed

+199
-4
lines changed

5 files changed

+199
-4
lines changed

‎.github/workflows/test_published_package.yml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2024 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# Workflow name:
20+
name: test_published_package
21+
22+
# Workflow triggers:
23+
on:
24+
# Run workflow on a weekly schedule:
25+
schedule:
26+
# * is a special character in YAML so you have to quote this string
27+
- cron: '48 12 * * 1'
28+
29+
# Run workflow upon completion of `publish` workflow run:
30+
workflow_run:
31+
workflows: ["publish"]
32+
types: [completed]
33+
34+
# Allow workflow to be manually run:
35+
workflow_dispatch:
36+
37+
# Workflow jobs:
38+
jobs:
39+
test-published:
40+
# Define a display name:
41+
name: 'Test running examples of published package'
42+
43+
# Define the type of virtual host machine:
44+
runs-on: ubuntu-latest
45+
46+
# Define environment variables:
47+
env:
48+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
49+
50+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
51+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
52+
53+
# Define the job's steps:
54+
steps:
55+
# Checkout the repository:
56+
- name: 'Checkout repository'
57+
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
58+
59+
# Install Node.js:
60+
- name: 'Install Node.js'
61+
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
62+
with:
63+
node-version: 20
64+
timeout-minutes: 5
65+
66+
# Create test directory and run examples:
67+
- name: 'Create test directory and run examples'
68+
run: |
69+
cd ..
70+
mkdir test-published
71+
cd test-published
72+
73+
# Copy example file:
74+
cp $GITHUB_WORKSPACE/examples/index.js .
75+
76+
# Create a minimal package.json
77+
echo '{
78+
"name": "test-published",
79+
"version": "1.0.0",
80+
"main": "index.js",
81+
"dependencies": {}
82+
}' > package.json
83+
84+
# Get package name and modify example file:
85+
PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
86+
ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
87+
88+
sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
89+
90+
# Extract and install dependencies:
91+
DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
92+
for dep in $DEPS; do
93+
npm install $dep --save
94+
done
95+
96+
# Run the example:
97+
node index.js
98+
99+
# Send Slack notification if job fails:
100+
- name: 'Send notification to Slack in case of failure'
101+
uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
102+
with:
103+
status: ${{ job.status }}
104+
channel: '#npm-ci'
105+
if: failure()

‎CHANGELOG.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,94 @@
22

33
> Package changelog.
44
5+
<section class="release" id="unreleased">
6+
7+
## Unreleased (2024-11-20)
8+
9+
<section class="packages">
10+
11+
### Packages
12+
13+
<section class="package" id="complex-unreleased">
14+
15+
#### [@stdlib/complex](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex)
16+
17+
<details>
18+
19+
<section class="features">
20+
21+
##### Features
22+
23+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
24+
25+
</section>
26+
27+
<!-- /.features -->
28+
29+
<section class="breaking-changes">
30+
31+
##### BREAKING CHANGES
32+
33+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
34+
35+
- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.
36+
37+
</section>
38+
39+
<!-- /.breaking-changes -->
40+
41+
</details>
42+
43+
</section>
44+
45+
<!-- /.package -->
46+
47+
</section>
48+
49+
<!-- /.packages -->
50+
51+
<section class="breaking-changes">
52+
53+
### BREAKING CHANGES
54+
55+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec): update namespace declarations
56+
57+
- To migrate, users should consult the corresponding packages containing the respective implementations to determine what is breaking. The primary breakages come from the `blas/*` namespace, where we recently refactored how top-level BLAS APIs operate on input arguments.
58+
59+
</section>
60+
61+
<!-- /.breaking-changes -->
62+
63+
<section class="contributors">
64+
65+
### Contributors
66+
67+
A total of 1 person contributed to this release. Thank you to this contributor:
68+
69+
- Philipp Burckhardt
70+
71+
</section>
72+
73+
<!-- /.contributors -->
74+
75+
<section class="commits">
76+
77+
### Commits
78+
79+
<details>
80+
81+
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - **feat:** update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190) _(by stdlib-bot, Philipp Burckhardt)_
82+
83+
</details>
84+
85+
</section>
86+
87+
<!-- /.commits -->
88+
89+
</section>
90+
91+
<!-- /.release -->
92+
593
<section class="release" id="v0.3.3">
694

795
## 0.3.3 (2024-11-05)

‎CONTRIBUTORS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Mohammad Kaif <98884589+Kaif987@users.noreply.github.com>
5959
Momtchil Momtchev <momtchil@momtchev.com>
6060
Muhammad Haris <harriskhan047@outlook.com>
6161
Naresh Jagadeesan <naresh.naresh000@gmail.com>
62+
Neeraj Pathak <neerajrpathak710@gmail.com>
6263
NightKnight <Ahmedatwa866@yahoo.com>
6364
Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
6465
Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
@@ -69,6 +70,7 @@ Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
6970
Pranav Goswami <goswami.4@iitj.ac.in>
7071
Praneki <97080887+PraneGIT@users.noreply.github.com>
7172
Pratik <97464067+Pratik772846@users.noreply.github.com>
73+
Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
7274
Priyansh <88396544+itsspriyansh@users.noreply.github.com>
7375
Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
7476
RISHAV <115060907+rishav2404@users.noreply.github.com>
@@ -79,9 +81,11 @@ Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
7981
Robert Gislason <gztown2216@yahoo.com>
8082
Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
8183
Rutam <138517416+performant23@users.noreply.github.com>
84+
Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
8285
Ryan Seal <splrk@users.noreply.github.com>
8386
Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
8487
SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com>
88+
Saurabh Singh <saurabhsraghuvanshi@gmail.com>
8589
Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
8690
Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
8791
Shivam <11shivam00@gmail.com>

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
173173
[npm-image]: http://img.shields.io/npm/v/@stdlib/complex.svg
174174
[npm-url]: https://npmjs.org/package/@stdlib/complex
175175

176-
[test-image]: https://github.com/stdlib-js/complex/actions/workflows/test.yml/badge.svg?branch=v0.3.3
177-
[test-url]: https://github.com/stdlib-js/complex/actions/workflows/test.yml?query=branch:v0.3.3
176+
[test-image]: https://github.com/stdlib-js/complex/actions/workflows/test.yml/badge.svg?branch=main
177+
[test-url]: https://github.com/stdlib-js/complex/actions/workflows/test.yml?query=branch:main
178178

179179
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex/main.svg
180180
[coverage-url]: https://codecov.io/github/stdlib-js/complex?branch=main

‎docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ interface Namespace {
114114
/**
115115
* Returns a type promotion table displaying complex number data types with the smallest size and closest "kind" to which data types can be safely cast.
116116
*
117-
* @param dtype1 - data type
118-
* @param dtype2 - data type
119117
* @returns promotion rule table
120118
*
121119
* @example

0 commit comments

Comments
 (0)
0