Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.27 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.27 KB
Raw

@cubing/deploy

Dreamhost-compatible deploys using bun and rsync.

  1. Install:
bun add --development @cubing/deploy
# or
npm install --save-dev @cubing/deploy
  1. Add URLs to package.json:
{
  "@cubing/deploy": {
    "https://experiments.cubing.net/test/deploy": {}
  }
}
  1. Run:
bun x @cubing/deploy

More options

Usage: bun x @cubing/deploy

Deploy to a shared host like Dreamhost with minimal configuration.

Options:

    --help
    --dry-run
    --create-folder-on-server

Requires `bun` and `rsync` to be installed. Reads target URLs from a field in `package.json` in the current folder:

{
  "@cubing/deploy": {
    "https://experiments.cubing.net/test/deploy": {}
  },
}

This example will be deployed from the following folder:

    ./dist/web/experiments.cubing.net/test/deploy/

The following ignored patterns are always included:

- `.git`
- `.DS_Store` (impossible to prevent macOS from creating)

Target URLs may include any of the following options:

{
  "@cubing/deploy": {
    "$schema": "./node_modules/@cubing/deploy/config-schema.json",
    "https://experiments.cubing.net/test/deploy": {
      "fromLocalDir": "./dist/custom-path/",
      "additionalExcludes": [".cache"]
    }
  }
}