mango-web-clients v2.0.0

Get it running / Setup

• Clone the repo: git clone https://github.com/digitalegarage/mango-web-clients.git
• After checkout, run npm run bootstrap to setup a working local dev environment
  • NOTE This project uses lerna, which takes care of symlinking dependencies and automatically versioning releases and other things
• Go to a package you wish to work on and check out the individual setup guide there

Deployment / Workflow

CI / CD

• the main line (dev -> staging -> master) should always be stable and deployable
• run experimental/unstable features on feature branches that you branch off from dev
  • to deploy a feature branch, add it to the branch list in ./deployment.yaml
  • don't remove dev/staging/master or other branches you don't own
• dev is the prerelease environment; new features/fixes are tested against this environment
• staging is a collection point for a number of commits from dev that can be grouped into release units if desired
• master reflects the current production deployment
• hot fixes should be branched directly from master, tested on their deployed feature branch and then integrated in all mainline branches (i.e. merged back into dev and staging)

Workflow (feature)

1. create a new branch from dev with a ticket reference: git checkout -b BRM-123-live-player
2. add any number of commits to the branch until you're ready for QA and code review
3. push your changes; the deployment script will ask you if you need to trigger a release
4. once you're ready, open a PR and write release notes in the format prescribed in conventional commits
5. merge the PR, and open a PR from dev -> staging

Workflow (fix)

1. create a new branch from master with a ticket reference: git checkout -b BRM-42-fix-ie-again
2. add any number of commits to the branch until you're ready for QA and code review
3. push your changes; the deployment script will ask you if you need to trigger a release
4. once you're ready, open a PR and write release notes in the format prescribed in conventional commits
5. after a positive code review and passing QA, prepare the release by running npm run shipit
6. merge the PR, and update dev and staging to include the fixes from master

Architecture

TODO

Packages

Current

• components
• schema

Planned

• webpack
• server
• HbbTV