treeherder/docs/deployment.rst

Deployment
==========

Testing the UI build locally
----------------------------

During local development the UI is served in its original, unprocessed form. In
production, a minified/built version of the UI (generated using webpack) is used instead.

To build the UI locally:

* Install local dependencies by running ``yarn install --no-bin-links`` from the project root.
* Run ``yarn build`` to create the ``dist`` directory.

Then start gunicorn/runserver as usual.
add some docuentation for deployment and fix a few bugs in the vagrant setup 2014-01-07 19:36:55 +04:00			`Deployment`
			`==========`

Bug 1205758 - Run `grunt build` as part of the stage/prod deploy In update.py, the line outputting revision.txt has to be moved later, since the `dist/` directory won't exist until grunt build has run. In addition, since `grunt build` removes the entire `dist/` directory, we no longer need to manually remove *.gz. We use the `--production` options for both `npm install` and `grunt build`, so that the `devDependencies` in package.json are ignored, and we only install/load the ones listed under `dependencies` in package.json - since that's all that is required for the build. We have to use `./node_modules/.bin/grunt` rather than `grunt`, since grunt-cli is not installed globally on the treeherder admin machine for greater isolation between stage and production. 2015-10-02 15:11:47 +03:00			`Testing the UI build locally`
			`----------------------------`
Bug 1170172 - RTD Grunt build updates 2015-06-01 18:32:14 +03:00
Bug 1151803 - Docs: Clarify the UI build/dist explanation & steps Explains the reasoning behind the dist directory, and separates out the "updating the dist directory" and "testing the dist directory" steps. 2015-06-17 19:22:40 +03:00			`During local development the UI is served in its original, unprocessed form. In`
Bug 1336556 - Replace grunt build system with neutrino/webpack 2017-03-01 16:06:15 +03:00			`production, a minified/built version of the UI (generated using webpack) is used instead.`
updated docs 2014-04-25 05:34:08 +04:00
Bug 1205758 - Run `grunt build` as part of the stage/prod deploy In update.py, the line outputting revision.txt has to be moved later, since the `dist/` directory won't exist until grunt build has run. In addition, since `grunt build` removes the entire `dist/` directory, we no longer need to manually remove *.gz. We use the `--production` options for both `npm install` and `grunt build`, so that the `devDependencies` in package.json are ignored, and we only install/load the ones listed under `dependencies` in package.json - since that's all that is required for the build. We have to use `./node_modules/.bin/grunt` rather than `grunt`, since grunt-cli is not installed globally on the treeherder admin machine for greater isolation between stage and production. 2015-10-02 15:11:47 +03:00			`To build the UI locally:`
Bug 1151803 - Docs: Clarify the UI build/dist explanation & steps Explains the reasoning behind the dist directory, and separates out the "updating the dist directory" and "testing the dist directory" steps. 2015-06-17 19:22:40 +03:00
Bug 1343928 - Switch from npm to yarn Since it's faster, deterministic and doesn't given obscure errors when using `--no-bin-links` (which is required for both npm and yarn on Windows hosts), and as such unblocks the work in bug 1343624. Many of the commands are the same as with npm. See: https://yarnpkg.com/en/docs/usage 2017-03-11 02:12:14 +03:00			* Install local dependencies by running ``yarn install --no-bin-links`` from the project root.
`yarn run foo` -> `yarn foo` (#2597) The run is redundant. 2017-06-29 21:32:54 +03:00			* Run ``yarn build`` to create the ``dist`` directory.
Bug 1205758 - Run `grunt build` as part of the stage/prod deploy In update.py, the line outputting revision.txt has to be moved later, since the `dist/` directory won't exist until grunt build has run. In addition, since `grunt build` removes the entire `dist/` directory, we no longer need to manually remove *.gz. We use the `--production` options for both `npm install` and `grunt build`, so that the `devDependencies` in package.json are ignored, and we only install/load the ones listed under `dependencies` in package.json - since that's all that is required for the build. We have to use `./node_modules/.bin/grunt` rather than `grunt`, since grunt-cli is not installed globally on the treeherder admin machine for greater isolation between stage and production. 2015-10-02 15:11:47 +03:00
Bug 1336556 - Replace grunt build system with neutrino/webpack 2017-03-01 16:06:15 +03:00			`Then start gunicorn/runserver as usual.`