Skip to content
This repository has been archived by the owner on Feb 13, 2019. It is now read-only.

Latest commit

 

History

History
60 lines (37 loc) · 1.92 KB

README.md

File metadata and controls

60 lines (37 loc) · 1.92 KB
Raw

Videohub Player (js)

We're migrating our video players from <iframe> to <bulbs-video>.

In the transition we need to support both player types. So the javascript code that powers the video player must be available to theonion/videohub and to theonion/bulbs-elements.

This repository is that place.

Long-term, the plan is for videohub to use <bulbs-video> internally and then all the code in this project can fold directly into bulbs-elements.

Installation

This library expects a dependencies to exist globally.

  • jQuery: We're using 2.2.x

Notes on Build Artifacts

In theonion/videohub we're requiring dist/videohub-player-global. This build sets global.VideoPlayer = VideoPlayer. That works with the expectations of theonion/videohub.

In theonion/bulbs-elements we're requiring src/player. This way bulbs-elements bulids this code from source with webpack.

After the transition period the global bulid artifact should be removed.

Scripts

scripts/ci Runs a CI build. Runs through browser-stack on multiple browsers/devices.

scripts/dev-build Creates a dev build at dist/.

scripts/prod-build Creates a production build at dist/.

scripts/test Runs the test suite.

Cutting a Release

  1. Update version in package.json
  2. Run scripts/tag-and-release

Check the output, releasing will fail if you have a dirty git index or if tests fail. If the release succeeds this script will print out the version tag.

Release Candidates

The release process never commits the dist/ directory to master. The only commit that has dist/ is the tagged commit.

Before you're certain changes are production ready, release versions following this pattern: major.minor.patch-rc# (0.1.0-rc1, 0.1.0-rc2, etc.)

Only when you're ready to deploy to production finalize on the non-rc version.