Skip to content

Commit 8763fb9

Browse files
authored
chore: bump minimum node version (#23)
Node 16 has reached end of life a while ago so we update to `>= 18` BREAKING CHANGE: bump min node version to `>= 18`
1 parent f26b136 commit 8763fb9

File tree

4 files changed

+24
-25
lines changed

4 files changed

+24
-25
lines changed

cli/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"license": "MIT",
88
"packageManager": "[email protected]",
99
"engines": {
10-
"node": ">=16.0.0"
10+
"node": ">=18.0.0"
1111
},
1212
"repository": {
1313
"type": "git",
@@ -34,7 +34,7 @@
3434
"preinstall": "npx only-allow pnpm"
3535
},
3636
"dependencies": {
37-
"commander": "^11.1.0",
37+
"commander": "^12.0.0",
3838
"shelljs": "~0.8.5"
3939
},
4040
"devDependencies": {

cli/pnpm-lock.yaml

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/cli/github-actions.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ In order to login to your linux server, you need to add your user credentials as
2222

2323
Inside your git repository, create a `.github/workflows/deploy.yml` file and add the following content:
2424

25+
:::tip CLI version
26+
We recommend to specify the major version of the CLI to use (e.g. `npx nginx-proxy-cli@3`).
27+
Otherwise, breaking changes we make to the CLI might break your existing GitHub actions.
28+
:::
29+
2530
```yaml
2631
name: Deploy
2732
on:
@@ -35,15 +40,16 @@ jobs:
3540
runs-on: ubuntu-latest
3641
steps:
3742
- name: Checkout Git repository
38-
uses: actions/checkout@v2
43+
uses: actions/checkout@v4
44+
3945
- name: Deploy
40-
uses: appleboy/ssh-action@master
46+
uses: appleboy/ssh-action@1.0.3
4147
with:
4248
host: ${{ secrets.SSH_HOST }}
4349
username: ${{ secrets.SSH_USERNAME }}
4450
password: ${{ secrets.SSH_PASSWORD }}
4551
envs: GITHUB_SERVER_URL,GITHUB_REPOSITORY
46-
script: npx nginx-proxy-cli deploy $GITHUB_SERVER_URL/$GITHUB_REPOSITORY --dir=~/nginx-proxy/applications
52+
script: npx nginx-proxy-cli@3 deploy $GITHUB_SERVER_URL/$GITHUB_REPOSITORY --dir=~/nginx-proxy/applications
4753
```
4854
4955
**Notes**:

docs/cli/installation.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,22 @@ The `nginx-proxy` offers a Node CLI that can be used to e.g. simplify or automat
44

55
## Prerequisites
66

7-
You need to have node installed on your system when you want to use the CLI.
7+
You need to have [Node.js](https://nodejs.org) `>= 18` installed on your system when you want to use the CLI.
88

99
### Install node
1010

11-
- **Step 1:** Get installation script with (replacing `16.x` with the version that you want to install):
11+
We recommend to install node using [fnm](https://github.com/Schniz/fnm).
1212

13-
```bash
14-
curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
15-
```
16-
17-
- **Step 2:** Execute the script with:
18-
19-
```bash
20-
bash nodesource_setup.sh
21-
```
13+
- **Step 1:** Follow the [fnm installation instructions](https://github.com/Schniz/fnm?tab=readme-ov-file#installation)
2214

23-
- **Step 3:** Install node
15+
- **Step 2:** Install your desired node version
2416

2517
```bash
26-
apt install nodejs
18+
fnm install 20
19+
fnm default 20
2720
```
2821

29-
- **Step 4 (optional):** Check node version
22+
- **Step 3 (optional):** Verify installation
3023

3124
```bash
3225
node -v

0 commit comments

Comments
 (0)