Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ jobs:
- run: npm test
- name: Build package
run: npm pack
- name: Smoke-test packed artifact
run: |
PACKAGE_TGZ="$(ls ./*.tgz)"
PREFIX="$(mktemp -d)"
npm install --global --prefix "$PREFIX" "$PACKAGE_TGZ"
"$PREFIX/bin/npm-ssl-updater" --help
- name: Create GitHub release
env:
GH_TOKEN: ${{ github.token }}
Expand Down
29 changes: 24 additions & 5 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,38 @@ The package and executable retain the historical name `npm-ssl-updater`.

## Installation

Run a tagged version directly from GitHub without cloning the repository:

```bash
git clone https://github.com/alsd4git/nginx-proxy-manager-ssl-cli.git
cd nginx-proxy-manager-ssl-cli
npm ci
npx -y github:alsd4git/nginx-proxy-manager-ssl-cli#v1.0.0 --help
```

Run from the checkout with `npm start --`, or install the command globally:
Or install that tagged version globally:

```bash
npm install -g .
npm install -g github:alsd4git/nginx-proxy-manager-ssl-cli#v1.0.0
npm-ssl-updater --help
```

GitHub Releases also contain the exact `npm pack` tarball for each version. This
is useful when you want to install the published release artifact itself:

```bash
npm install -g https://github.com/alsd4git/nginx-proxy-manager-ssl-cli/releases/download/v1.0.0/npm-ssl-updater-1.0.0.tgz
```

The examples are intentionally pinned to a tag. Replace `v1.0.0` with the
version you want instead of relying on the current default branch.

For development from a checkout:

```bash
git clone https://github.com/alsd4git/nginx-proxy-manager-ssl-cli.git
cd nginx-proxy-manager-ssl-cli
npm ci
npm start -- --help
```

## Credentials

Create `.env` in the directory where you run the command:
Expand Down
30 changes: 24 additions & 6 deletions README.it.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,38 @@ Il pacchetto e il comando mantengono il nome storico `npm-ssl-updater`.

## Installazione

Esegui direttamente una versione taggata da GitHub, senza clonare la repository:

```bash
git clone https://github.com/alsd4git/nginx-proxy-manager-ssl-cli.git
cd nginx-proxy-manager-ssl-cli
npm ci
npx -y github:alsd4git/nginx-proxy-manager-ssl-cli#v1.0.0 --help
```

Esegui il tool dal checkout con `npm start --`, oppure installa il comando
globalmente:
Oppure installa globalmente la stessa versione:

```bash
npm install -g .
npm install -g github:alsd4git/nginx-proxy-manager-ssl-cli#v1.0.0
npm-ssl-updater --help
```

Le GitHub Release contengono anche il tarball esatto prodotto da `npm pack`,
utile se vuoi installare direttamente l'artefatto pubblicato:

```bash
npm install -g https://github.com/alsd4git/nginx-proxy-manager-ssl-cli/releases/download/v1.0.0/npm-ssl-updater-1.0.0.tgz
```

Gli esempi sono intenzionalmente bloccati a un tag. Sostituisci `v1.0.0` con la
versione desiderata invece di affidarti al branch di default corrente.

Per lo sviluppo da checkout:

```bash
git clone https://github.com/alsd4git/nginx-proxy-manager-ssl-cli.git
cd nginx-proxy-manager-ssl-cli
npm ci
npm start -- --help
```

## Credenziali

Crea `.env` nella directory da cui esegui il comando:
Expand Down