This utility can be configured as a step in your client-app's CI process to auto-deploy your app for continuous delivery.

We have outlined the basic integration steps below. You can also try the examples in our GitHub repo.

Requirements

• This tool requires a NodeJS environment. Support for more platforms is coming soon.
• NodeJS v6 or above.

Installation

• You can install with npm or yarn package manager.

  npm install --save @bitpod/site-webdeploy

  yarn add @bitpod/site-webdeploy

Setup

1. Generate a unique token using the "Generate a token" button above, ignore this if you already did it.
2. Create site-webdeploy.json file in root directory of your project using following json.

{
   "schemaVersion": "0.1",
   "appId": "builder",
   "instanceId": "Sy3es-DBf",
   "siteId": "HyC-jbvSz",
   "token": "bb709b70a1ef79eb0019ca9dc5c43dc47fb9e96802f54dc393a8b77ca8362895",
   "deployPath": "/deploy",
   "routes": [
        {
             "key": "*",
             "value": "/index.html"
        }
   ]
}

site-webdeploy.json configuration params

• Site webdeploy schema details

  | | Required | Description | | -------------- | ----------- | ------------------------------------------------ | | schemaVersion | ✔ | site webdeploy schema version | | appId | ✔ | your bitpod application id | | instanceId | ✔ | tenent id | | siteId | ✔ | site unique id | | token | ✔ | your deployment token | | deployPath | ✔ | this should be path containing your built app, e.g. ./dist or ./build | | bitpodApiURL | | base url of bitpod deployment api, e.g. http://localhost:8081/api | | routes | ✔ | routes of your sites |

Usage

Remote deploy

1. Install @bitpod/site-webdeploy globally.

npm install -g @bitpod/site-webdeploy

2. Then to remotely deploy your application, run the following command from the folder containing site-webdeploy.json

site-webdeploy deploy

Integration with Travis CI (for GitHub based repos)

1. Create an entry for deploy in your package.json file under scripts node.

{
  "name": "MyApp",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "build" : "webpack -p",
    "deploy": "site-webdeploy deploy "
  }
}

2. Create .travis.yml file in root directory of your project using following yml.

  language: node_js
  node_js:
    - "6"
  install:
    - yarn install
  script:
    - npm run build
    - npm run deploy

3. Activate Travis integration with your repository

Integration with Bitbucket Pipelines

• Coming soon...

Additional configuration and usage instructions

• Check out the npm page of the site-webdeploy tool for information on more advanced configuration and usage.

Examples

• cra-site-webdeploy A create-react-app based application with build configuration.
• vue-site-webdeploy A Vue.js based application with build configuration.