site-webdeploy is a command line interface for running commands against bitpod site deployment
npm install @bitpod/site-webdeployThis 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.
plaintext
npm install --save @bitpod/site-webdeploy
`
`plaintext
yarn add @bitpod/site-webdeploy
`
$3
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.
`JSON download site-webdeploy.json
{
"schemaVersion": "0.1",
"appId": "builder",
"instanceId": "Sy3es-DBf",
"siteId": "HyC-jbvSz",
"token": "bb709b70a1ef79eb0019ca9dc5c43dc47fb9e96802f54dc393a8b77ca8362895",
"deployPath": "/deploy",
"routes": [
{
"key": "*",
"value": "/index.html"
}
]
}
`
$3
- 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 |
$3
#### Remote deploy
1. Install @bitpod/site-webdeploy globally.
`plaintext
npm install -g @bitpod/site-webdeploy
`
2. Then to remotely deploy your application, run the following command from the folder containing site-webdeploy.json
`sh
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.
`JSON
{
"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.
`yml download ..travis.yml
language: node_js
node_js:
- "6"
install:
- yarn install
script:
- npm run build
- npm run deploy
``