Skip to content

Files

Latest commit

d84159f · Jan 19, 2022

History

History
35 lines (24 loc) · 946 Bytes

DEPLOY.md

File metadata and controls

35 lines (24 loc) · 946 Bytes

Deployment Instructions

Webpack

openhab-js can be compiled into a single JS file, which is connivent for deploying locally and also how we ship the library with the JSScripting binding in openHAB

npm run webpack

this outputs the library as a single JS file to dist/openhab.js

Docs

openhab-js uses JSDocs to produce API documentation.

npm run docs

This will output API documentation to ./docs

This also happens automatically on every push to main and is published using Github Pages, see openhab-js API Documentation for the latest version.

Publish to NPM

We have a Github action which will publish this library automatically when a version tag is pushed.

export OHJS=2.x.x #replace 2.x.x with version
git checkout main
git pull origin
npm version $OHJS 
git push origin  #push changes
git push origin v${OHJS} #push tag