Skip to content

Commit d24df2c

Browse files
authored
[MOB-11507] Upgrade webpack-dev-server and node (#502)
* [MOB-11507] Upgrade webpack-dev-server * [MOB-11507] Upgrade webpack-dev-server in /react-example * [MOB-11507] Upgrade webpack-dev-server in /example * [MOB-11507] Update env comments * [MOB-11507] Update node engine requirement * [MOB-11507] Upgrade webpack-cli * [MOB-11507] Upgrade webpack-cli in /example * [MOB-11507] Remove iterable from dependencies in /react-example * [MOB-11507] Upgrade webpack-cli in /react-example * [MOB-11507] Update node in ci config * [MOB-11507] Update lint config * [MOB-11507] Update README
1 parent 2c66989 commit d24df2c

13 files changed

Lines changed: 1039 additions & 937 deletions

File tree

.eslintrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,5 +67,5 @@
6767
]
6868
}
6969
}
70-
},
70+
}
7171
}

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ jobs:
1717

1818
steps:
1919
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
20-
- name: Use Node.js 16.3.0
20+
- name: Use Node.js 18.12.0
2121
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
2222
with:
23-
node-version: '16.3.0'
23+
node-version: '18.12.0'
2424
cache: 'yarn'
2525
- run: yarn install --frozen-lockfile
2626
- run: yarn prepublishOnly

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
13-
- name: Use Node.js 16.3.0
13+
- name: Use Node.js 18.12.0
1414
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
1515
with:
16-
node-version: '16.3.0'
16+
node-version: '18.12.0'
1717
cache: 'yarn'
1818
- run: yarn install --frozen-lockfile
1919
- run: yarn test

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Requirements
22

3-
This project (along with the sample app) both require a minimum Node version of 16.3.0 or greater. [Download NodeJS here.](https://nodejs.org/en/) Alternatively, you can use a tool such as [nvm](https://github.com/nvm-sh/nvm) to install another version of node and switch to that.
3+
This project (along with the sample app) both require a minimum Node version of 18.12.0 or greater. [Download NodeJS here.](https://nodejs.org/en/) Alternatively, you can use a tool such as [nvm](https://github.com/nvm-sh/nvm) to install another version of node and switch to that.
44

55
This project also uses [yarn package manager.](https://yarnpkg.com/getting-started/install) You'll need to install that as well to run the commands within this project.
66

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,19 @@ To install the SDK, use Yarn, npm, or a `script` tag:
8484
<script src="https://unpkg.com/@iterable/web-sdk/index.js"></script>
8585
```
8686

87+
⚠️ Node.js Version Requirement
88+
Important: This SDK requires Node.js as defined in `package.json`.
89+
90+
Please ensure your development environment meets the minimum required Node.js version. Depending on your current setup, you may already be using a compatible version. If not, you will need to upgrade Node.js to proceed with installation and use of the SDK.
91+
92+
You can check your current Node version by running:
93+
94+
```bash
95+
node -v
96+
```
97+
98+
If an upgrade is needed, we recommend using nvm or your preferred version manager for easy installation.
99+
87100
# Functions
88101

89102
Iterable's Web SDK exposes the following functions, which you can use in your

example/.env.example

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# To make requests from this example app make sure you first create an .env file
2-
# and add the API key and JWT Secret to it like so (and uncomment the keys):
1+
# Optional environment variables for local development. Start by creating a
2+
# called .env and add these values to it and change them appropriately.
3+
# Remember to uncomment the variables!
34

5+
# Set your API key and JWT Secret here to make requests from this example app.
46
# API_KEY=1234
57
# JWT_SECRET=1234
68

example/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"directory": "https://github.com/Iterable/iterable-web-sdk/example"
99
},
1010
"engines": {
11-
"node": ">= 16.3.0"
11+
"node": ">= 18.12.0"
1212
},
1313
"author": "Iterable",
1414
"license": "MIT",
@@ -51,8 +51,8 @@
5151
"ts-jest": "^27.0.7",
5252
"typescript": "^4.6.4",
5353
"webpack": "^5.99.9",
54-
"webpack-cli": "^4.9.1",
55-
"webpack-dev-server": "^4.7.3"
54+
"webpack-cli": "^6.0.1",
55+
"webpack-dev-server": "^5.2.1"
5656
},
5757
"dependencies": {
5858
"axios": "^1.9.0"

0 commit comments

Comments
 (0)