Skip to content

Commit 338fd48

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent e1a0434 commit 338fd48

File tree

9 files changed

+273
-35
lines changed

9 files changed

+273
-35
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:13:35.073Z
1+
2025-02-03T00:46:22.265Z

‎.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:

‎.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: '5 17 * * 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: 115 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,27 @@
22

33
> Package changelog.
44
5-
<section class="release" id="unreleased">
5+
<section class="release" id="v0.3.0">
6+
7+
## 0.3.0 (2024-07-29)
68

7-
## Unreleased (2024-08-01)
9+
<section class="features">
10+
11+
### Features
12+
13+
- [`71cf5a0`](https://github.com/stdlib-js/stdlib/commit/71cf5a05a13d12aed627d332147642adc4694ab9) - add boolean dtype support to `ndarray/empty*` and `ndarray/base/empty*` packages [(#2588)](https://github.com/stdlib-js/stdlib/pull/2588)
14+
15+
</section>
16+
17+
<!-- /.features -->
818

919
<section class="commits">
1020

1121
### Commits
1222

1323
<details>
1424

15-
- [`22c4d29`](https://github.com/stdlib-js/stdlib/commit/22c4d29898e2b5bb4cb071a6b7f62536027eaf28) - **docs:** remove blank line _(by Athan Reines)_
25+
- [`71cf5a0`](https://github.com/stdlib-js/stdlib/commit/71cf5a05a13d12aed627d332147642adc4694ab9) - **feat:** add boolean dtype support to `ndarray/empty*` and `ndarray/base/empty*` packages [(#2588)](https://github.com/stdlib-js/stdlib/pull/2588) _(by Jaysukh Makvana, Athan Reines)_
1626

1727
</details>
1828

@@ -24,9 +34,10 @@
2434

2535
### Contributors
2636

27-
A total of 1 person contributed to this release. Thank you to this contributor:
37+
A total of 2 people contributed to this release. Thank you to the following contributors:
2838

2939
- Athan Reines
40+
- Jaysukh Makvana
3041

3142
</section>
3243

@@ -36,31 +47,70 @@ A total of 1 person contributed to this release. Thank you to this contributor:
3647

3748
<!-- /.release -->
3849

39-
<section class="release" id="v0.3.0">
50+
<section class="release" id="v0.2.1">
4051

41-
## 0.3.0 (2024-07-29)
52+
## 0.2.1 (2024-02-25)
4253

4354
No changes reported for this release.
4455

4556
</section>
4657

4758
<!-- /.release -->
4859

49-
<section class="release" id="v0.2.1">
60+
<section class="release" id="v0.2.0">
5061

51-
## 0.2.1 (2024-02-25)
62+
## 0.2.0 (2024-02-15)
5263

53-
No changes reported for this release.
64+
<section class="features">
65+
66+
### Features
67+
68+
- [`cc475bc`](https://github.com/stdlib-js/stdlib/commit/cc475bc4eb69351b15b231bf42257744e25635cd) - document support for `normalize` index mode
5469

5570
</section>
5671

57-
<!-- /.release -->
72+
<!-- /.features -->
5873

59-
<section class="release" id="v0.2.0">
74+
<section class="bug-fixes">
6075

61-
## 0.2.0 (2024-02-15)
76+
### Bug Fixes
6277

63-
No changes reported for this release.
78+
- [`3aec20d`](https://github.com/stdlib-js/stdlib/commit/3aec20d84a70edd88ac294294bb733cabb544d66) - remove leftover disabled lint rule
79+
80+
</section>
81+
82+
<!-- /.bug-fixes -->
83+
84+
<section class="commits">
85+
86+
### Commits
87+
88+
<details>
89+
90+
- [`cc475bc`](https://github.com/stdlib-js/stdlib/commit/cc475bc4eb69351b15b231bf42257744e25635cd) - **feat:** document support for `normalize` index mode _(by Athan Reines)_
91+
- [`6b34523`](https://github.com/stdlib-js/stdlib/commit/6b3452322174342479d6c8b3277c3efee65d4cc0) - **docs:** update links _(by Athan Reines)_
92+
- [`3aec20d`](https://github.com/stdlib-js/stdlib/commit/3aec20d84a70edd88ac294294bb733cabb544d66) - **fix:** remove leftover disabled lint rule _(by Athan Reines)_
93+
- [`bf2cf8b`](https://github.com/stdlib-js/stdlib/commit/bf2cf8b0424e608a4e3abb6d18a8b44d790aa99c) - **build:** remove tslint directives _(by Philipp Burckhardt)_
94+
- [`5660dc8`](https://github.com/stdlib-js/stdlib/commit/5660dc86e4a4738c5a9b8f4357639d2d98460a8d) - **chore:** add keyword _(by Athan Reines)_
95+
96+
</details>
97+
98+
</section>
99+
100+
<!-- /.commits -->
101+
102+
<section class="contributors">
103+
104+
### Contributors
105+
106+
A total of 2 people contributed to this release. Thank you to the following contributors:
107+
108+
- Athan Reines
109+
- Philipp Burckhardt
110+
111+
</section>
112+
113+
<!-- /.contributors -->
64114

65115
</section>
66116

@@ -70,7 +120,58 @@ No changes reported for this release.
70120

71121
## 0.1.0 (2023-09-24)
72122

73-
No changes reported for this release.
123+
<section class="features">
124+
125+
### Features
126+
127+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - update minimum TypeScript version
128+
- [`78cb6e3`](https://github.com/stdlib-js/stdlib/commit/78cb6e35c41caff418a7dde7759a311dd35bb407) - add support for additional ndarray constructor options
129+
130+
</section>
131+
132+
<!-- /.features -->
133+
134+
<section class="breaking-changes">
135+
136+
### BREAKING CHANGES
137+
138+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0): update minimum TypeScript version to 4.1
139+
140+
- To migrate, users should upgrade their TypeScript version to at least version 4.1.
141+
142+
</section>
143+
144+
<!-- /.breaking-changes -->
145+
146+
<section class="commits">
147+
148+
### Commits
149+
150+
<details>
151+
152+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_
153+
- [`568f63f`](https://github.com/stdlib-js/stdlib/commit/568f63f8c107f330a9ee9f6754b01d97d9642c8a) - **refactor:** use ndarray defaults _(by Athan Reines)_
154+
- [`7d8e9d6`](https://github.com/stdlib-js/stdlib/commit/7d8e9d6d338ec41ec789713799cda27a0d4a9c1d) - **test:** add option validation tests and document options _(by Athan Reines)_
155+
- [`78cb6e3`](https://github.com/stdlib-js/stdlib/commit/78cb6e35c41caff418a7dde7759a311dd35bb407) - **feat:** add support for additional ndarray constructor options _(by Athan Reines)_
156+
157+
</details>
158+
159+
</section>
160+
161+
<!-- /.commits -->
162+
163+
<section class="contributors">
164+
165+
### Contributors
166+
167+
A total of 2 people contributed to this release. Thank you to the following contributors:
168+
169+
- Athan Reines
170+
- Philipp Burckhardt
171+
172+
</section>
173+
174+
<!-- /.contributors -->
74175

75176
</section>
76177

0 commit comments

Comments
 (0)