Skip to content

Commit f877e65

Browse files
committed
Auto-generated commit
1 parent 8818c42 commit f877e65

File tree

8 files changed

+233
-49
lines changed

8 files changed

+233
-49
lines changed

.editorconfig

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ indent_style = tab
8686
[*.{f,f.txt}]
8787
indent_style = space
8888
indent_size = 2
89-
insert_final_newline = false
9089

9190
# Set properties for shell files:
9291
[*.{sh,sh.txt}]
@@ -121,7 +120,7 @@ indent_style = tab
121120
[*.{md,md.txt}]
122121
indent_style = space
123122
indent_size = 4
124-
trim_trailing_whitespace = false
123+
trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
125124
126125
# Set properties for `usage.txt` files:
127126
[usage.txt]

.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-08-01T06:14:31.892Z
1+
2025-02-03T01:02:22.559Z

.github/workflows/test_install.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ jobs:
5050
env:
5151
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
5252

53-
# Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
54-
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
53+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
54+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
5555

5656
# Define the sequence of job steps...
5757
steps:
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: '44 8 * * 0'
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 triggered or on a schedule:
51+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
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: 76 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,69 @@
22

33
> Package changelog.
44
5-
<section class="release" id="unreleased">
5+
<section class="release" id="v0.2.2">
6+
7+
## 0.2.2 (2024-07-29)
8+
9+
No changes reported for this release.
10+
11+
</section>
12+
13+
<!-- /.release -->
14+
15+
<section class="release" id="v0.2.1">
616

7-
## Unreleased (2024-08-01)
17+
## 0.2.1 (2024-02-25)
18+
19+
No changes reported for this release.
20+
21+
</section>
22+
23+
<!-- /.release -->
24+
25+
<section class="release" id="v0.2.0">
26+
27+
## 0.2.0 (2024-02-15)
28+
29+
No changes reported for this release.
30+
31+
</section>
32+
33+
<!-- /.release -->
34+
35+
<section class="release" id="v0.1.0">
36+
37+
## 0.1.0 (2023-09-24)
38+
39+
<section class="features">
40+
41+
### Features
42+
43+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - update minimum TypeScript version
44+
45+
</section>
46+
47+
<!-- /.features -->
48+
49+
<section class="breaking-changes">
50+
51+
### BREAKING CHANGES
52+
53+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0): update minimum TypeScript version to 4.1
54+
55+
- To migrate, users should upgrade their TypeScript version to at least version 4.1.
56+
57+
</section>
58+
59+
<!-- /.breaking-changes -->
860

961
<section class="commits">
1062

1163
### Commits
1264

1365
<details>
1466

15-
- [`22c4d29`](https://github.com/stdlib-js/stdlib/commit/22c4d29898e2b5bb4cb071a6b7f62536027eaf28) - **docs:** remove blank line _(by Athan Reines)_
67+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_
1668

1769
</details>
1870

@@ -26,7 +78,7 @@
2678

2779
A total of 1 person contributed to this release. Thank you to this contributor:
2880

29-
- Athan Reines
81+
- Philipp Burckhardt
3082

3183
</section>
3284

@@ -36,51 +88,46 @@ A total of 1 person contributed to this release. Thank you to this contributor:
3688

3789
<!-- /.release -->
3890

39-
<section class="release" id="v0.2.2">
40-
41-
## 0.2.2 (2024-07-29)
42-
43-
No changes reported for this release.
44-
45-
</section>
91+
<section class="release" id="v0.0.1">
4692

47-
<!-- /.release -->
93+
## 0.0.1 (2023-07-31)
4894

49-
<section class="release" id="v0.2.1">
95+
<section class="features">
5096

51-
## 0.2.1 (2024-02-25)
97+
### Features
5298

53-
No changes reported for this release.
99+
- [`7b0d1b0`](https://github.com/stdlib-js/stdlib/commit/7b0d1b09616c4d92e0733564ef3c8b420a9ddb4f) - add `ndarray/base/assert/is-complex-floating-point-data-type`
54100

55101
</section>
56102

57-
<!-- /.release -->
103+
<!-- /.features -->
58104

59-
<section class="release" id="v0.2.0">
105+
<section class="commits">
60106

61-
## 0.2.0 (2024-02-15)
107+
### Commits
62108

63-
No changes reported for this release.
109+
<details>
64110

65-
</section>
111+
- [`86d02e2`](https://github.com/stdlib-js/stdlib/commit/86d02e26cd8dd87d061ec308a03fb21a54065a0e) - **test:** add comments to explain test value distinction _(by Athan Reines)_
112+
- [`7b0d1b0`](https://github.com/stdlib-js/stdlib/commit/7b0d1b09616c4d92e0733564ef3c8b420a9ddb4f) - **feat:** add `ndarray/base/assert/is-complex-floating-point-data-type` _(by Athan Reines)_
66113

67-
<!-- /.release -->
114+
</details>
68115

69-
<section class="release" id="v0.1.0">
116+
</section>
70117

71-
## 0.1.0 (2023-09-24)
118+
<!-- /.commits -->
72119

73-
No changes reported for this release.
120+
<section class="contributors">
74121

75-
</section>
122+
### Contributors
76123

77-
<!-- /.release -->
124+
A total of 1 person contributed to this release. Thank you to this contributor:
78125

79-
<section class="release" id="v0.0.1">
126+
- Athan Reines
80127

81-
## 0.0.1 (2023-07-31)
128+
</section>
82129

83-
No changes reported for this release.
130+
<!-- /.contributors -->
84131

85132
</section>
86133

0 commit comments

Comments
 (0)