Skip to content

Commit c8856a1

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 227438a commit c8856a1

File tree

7 files changed

+259
-32
lines changed

7 files changed

+259
-32
lines changed

‎.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ indent_style = tab
121121
[*.{md,md.txt}]
122122
indent_style = space
123123
indent_size = 4
124-
trim_trailing_whitespace = false
124+
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.
125125
126126
# Set properties for `usage.txt` files:
127127
[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:40.774Z
1+
2024-12-23T01:50:34.061Z

‎.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: '16 4 * * 2'
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: 106 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,63 @@ 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+
- [`4ea3975`](https://github.com/stdlib-js/stdlib/commit/4ea39750d4b9d772deb1b4ee374275e3ee995599) - 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="commits">
6075

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

63-
No changes reported for this release.
78+
<details>
79+
80+
- [`dea49e0`](https://github.com/stdlib-js/stdlib/commit/dea49e03ab5571233e3da26835a6a6d3256d5737) - **docs:** use single quotes in require calls instead of backticks _(by Philipp Burckhardt)_
81+
- [`4ea3975`](https://github.com/stdlib-js/stdlib/commit/4ea39750d4b9d772deb1b4ee374275e3ee995599) - **feat:** document support for `normalize` index mode _(by Athan Reines)_
82+
- [`5497c40`](https://github.com/stdlib-js/stdlib/commit/5497c40ce46dfa7c4de64d15526ba794446487e2) - **build:** replace tslint directive with eslint equivalent _(by Philipp Burckhardt)_
83+
- [`6b34523`](https://github.com/stdlib-js/stdlib/commit/6b3452322174342479d6c8b3277c3efee65d4cc0) - **docs:** update links _(by Athan Reines)_
84+
- [`bf2cf8b`](https://github.com/stdlib-js/stdlib/commit/bf2cf8b0424e608a4e3abb6d18a8b44d790aa99c) - **build:** remove tslint directives _(by Philipp Burckhardt)_
85+
- [`b8f8c28`](https://github.com/stdlib-js/stdlib/commit/b8f8c28db9816e6fb5b0cee0ad61f377f6815d65) - **chore:** add keyword _(by Athan Reines)_
86+
- [`f59a264`](https://github.com/stdlib-js/stdlib/commit/f59a26499caa43e748d6cf1aec868508585f4262) - **refactor:** remove obsolete branch _(by Athan Reines)_
87+
- [`71d561c`](https://github.com/stdlib-js/stdlib/commit/71d561cc2b942a92983a38c8bde009d35255c5d1) - **refactor:** use accessor utilities _(by Athan Reines)_
88+
89+
</details>
90+
91+
</section>
92+
93+
<!-- /.commits -->
94+
95+
<section class="contributors">
96+
97+
### Contributors
98+
99+
A total of 2 people contributed to this release. Thank you to the following contributors:
100+
101+
- Athan Reines
102+
- Philipp Burckhardt
103+
104+
</section>
105+
106+
<!-- /.contributors -->
64107

65108
</section>
66109

@@ -70,7 +113,56 @@ No changes reported for this release.
70113

71114
## 0.1.0 (2023-09-24)
72115

73-
No changes reported for this release.
116+
<section class="features">
117+
118+
### Features
119+
120+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - update minimum TypeScript version
121+
- [`e618407`](https://github.com/stdlib-js/stdlib/commit/e618407f673288e8aa303b5db6bd316c6f130762) - add support for additional ndarray constructor options
122+
123+
</section>
124+
125+
<!-- /.features -->
126+
127+
<section class="breaking-changes">
128+
129+
### BREAKING CHANGES
130+
131+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0): update minimum TypeScript version to 4.1
132+
133+
- To migrate, users should upgrade their TypeScript version to at least version 4.1.
134+
135+
</section>
136+
137+
<!-- /.breaking-changes -->
138+
139+
<section class="commits">
140+
141+
### Commits
142+
143+
<details>
144+
145+
- [`7ae5741`](https://github.com/stdlib-js/stdlib/commit/7ae574143c9716c82cea6cbf839a20b70a9cdfe0) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_
146+
- [`e618407`](https://github.com/stdlib-js/stdlib/commit/e618407f673288e8aa303b5db6bd316c6f130762) - **feat:** add support for additional ndarray constructor options _(by Athan Reines)_
147+
148+
</details>
149+
150+
</section>
151+
152+
<!-- /.commits -->
153+
154+
<section class="contributors">
155+
156+
### Contributors
157+
158+
A total of 2 people contributed to this release. Thank you to the following contributors:
159+
160+
- Athan Reines
161+
- Philipp Burckhardt
162+
163+
</section>
164+
165+
<!-- /.contributors -->
74166

75167
</section>
76168

0 commit comments

Comments
 (0)