Merge lp:~bac/juju-gui/1091787 into lp:juju-gui/experimental

[Brad Crittenden]

Correct build targets for releases.

There was confusion between build, build-prod, and build-debug. A new target
called build-devel has been introduced to replace the old build target. A new
build target now depends on build-prod and build-debug.

[Gary Poster (gary)]

+1, thank you.

An idea might be to document, in comments or something, what the meaning of devel and debug are: devel is for developers, and debug is for deployments of unaggregated & uncompressed code.

Gary

review: Approve

[Benji York (benji)]

Other than one small thing, this looks good.

The small thing is that the change from "make release" to "make distfile" in the docs isn't right. To make a release (which is what those docs are talking about) you do "make release". However, your intent is correct in that we need to document "make distfile" too. A short paragraph about that would be a good addition.

review: Approve (code)

[lp:~bac/juju-gui/1091787]

289. By Brad Crittenden on 2012-12-18

Documentation changes from review.

=== modified file 'HACKING'
--- HACKING	2012-12-12 13:26:46 +0000
+++ HACKING	2012-12-18 20:33:21 +0000
@@ -142,8 +142,13 @@
 
 .. _`pertinent variable names`: `Potentially Useful Release-Oriented Makefile Variables`_
 
-You also need to have a gpg key, and the python-pytz package installed (as
-well as launchpadlib, but that is installed by default in Ubuntu).
+
+To make the release tarball use:
+    $ make distfile
+
+In order to make and upload the release ('make dist'), you also need to have a
+gpg key, and the python-pytz package installed (as well as launchpadlib, but
+that is installed by default in Ubuntu).
 
 See the Process document (docs/process.rst) for step-by-step checklists to
 make developer and stable releases.
@@ -159,7 +164,7 @@
   release target) will cause the release to be uploaded to the stable series
   rather than the trunk series. Example usage::
 
-    $ FINAL=1 make release
+    $ FINAL=1 make dist
 
 PROD
   By default, releases will be uploaded to staging.launchpad.net, which is a
@@ -176,22 +181,22 @@
 
   Example usage::
 
-    $ PROD=1 make release
+    $ PROD=1 make dist
 
-IS_TRUNK_CHECKOUT
+IS_TRUNK_BRANCH
   Set this to any non-empty value to force the Makefile to believe it is
   working with a trunk checkout. Example usage::
 
-    $ IS_TRUNK_CHECKOUT=1 make release
+    $ IS_TRUNK_BRANCH=1 make dist
 
-HAS_NO_CHANGES
+BRANCH_IS_CLEAN
   Set this to any non-empty value to force the Makefile to believe that the
   current code tree has no changes. Example usage::
 
-    $ HAS_NO_CHANGES=1 make release
+    $ BRANCH_IS_CLEAN=1 make dist
 
-IS_SAFE_RELEASE
+BRANCH_IS_GOOD
   Set this to any non-empty value to force the Makefile to bypass checks of
-  IS_TRUNK_CHECKOUT and HAS_NO_CHANGES. Example usage::
+  IS_TRUNK_BRANCH and BRANCH_IS_CLEAN. Example usage::
 
-    $ IS_SAFE_RELEASE=1 make release
+    $ BRANCH_IS_GOOD=1 make dist

=== modified file 'Makefile'
--- Makefile	2012-12-17 14:54:25 +0000
+++ Makefile	2012-12-18 20:33:21 +0000
@@ -21,11 +21,11 @@
 	-o -wholename './test/assets*' -prune \
 	-o -wholename './yuidoc*' -prune \
 	-o \( \
-    		-name '*.js' \
-    		-o -name '*.json' \
-    		-o -name 'generateTemplates' \
-  	\) -print \
-  	| sort | sed -e 's/^\.\///' \
+		-name '*.js' \
+		-o -name '*.json' \
+		-o -name 'generateTemplates' \
+	\) -print \
+	| sort | sed -e 's/^\.\///' \
 	| grep -Ev -e '^manifest\.json$$' \
 		-e '^app/assets/javascripts/d3.v2.*.js$$' \
 		-e '^app/assets/javascripts/reconnecting-websocket.js$$' \
@@ -125,7 +125,7 @@
 	PWD=$(shell pwd)
 endif
 
-all: build-debug build-prod
+all: build
 	@echo "\nDebug and production environments built."
 	@echo "Run 'make help' to list the main available targets."
 
@@ -335,17 +335,20 @@
 	@echo "to start the production or debug environments respectively."
 	@echo "Run 'make help' to list the main available targets."
 
-devel: build
+# devel is used during the development process.
+devel: build-devel
 	@echo "Running the development environment from node.js ."
 	@echo "Customize config.js to modify server settings."
 	node server.js
 
+# debug is for deployments of unaggregated and uncompressed code.
 debug: build-debug
 	@echo "Running the debug environment from a SimpleHTTPServer"
 	@echo "To run the development environment, including automatically"
 	@echo "rebuilding the generated files on changes, run 'make devel'."
 	cd build-debug && python -m SimpleHTTPServer 8888
 
+# prod is for deployment of aggregated and minimized code.
 prod: build-prod
 	@echo "Running the production environment from a SimpleHTTPServer"
 	cd build-prod && python -m SimpleHTTPServer 8888
@@ -363,12 +366,14 @@
 
 clean-all: clean clean-deps clean-docs
 
-build: $(APPCACHE) $(NODE_TARGETS) spritegen \
+build: build-prod build-debug
+
+build-devel: $(APPCACHE) $(NODE_TARGETS) spritegen \
 	  $(BUILD_FILES) build/juju-ui/version.js
 
-build-debug: build | $(LINK_DEBUG_FILES)
+build-debug: build-devel | $(LINK_DEBUG_FILES)
 
-build-prod: build | $(LINK_PROD_FILES)
+build-prod: build-devel | $(LINK_PROD_FILES)
 
 $(APPCACHE): manifest.appcache.in
 	mkdir -p build/juju-ui/assets