Merge lp:~gary/juju-gui/adjustCHANGES into lp:juju-gui/experimental

[Gary Poster]

Adjust 0.11.0 change log

Also document an approach to generating the change log.

https://codereview.appspot.com/14990046/

[Gary Poster (gary)]

Reviewers: mp+191891_code.launchpad.net,

Message:
Please take a look.

Description:
Adjust 0.11.0 change log

Also document an approach to generating the change log.

https://code.launchpad.net/~gary/juju-gui/adjustCHANGES/+merge/191891

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/14990046/

Affected files (+81, -33 lines):
   M CHANGES.yaml
   A [revision details]
   M docs/process.rst

[Jeff Pihach (hatch)]

LGTM Thanks for this update!

https://codereview.appspot.com/14990046/

[lp:~gary/juju-gui/adjustCHANGES]

1147. By Gary Poster on 2013-11-06

merge trunk

[Gary Poster (gary)]

*** Submitted:

Adjust 0.11.0 change log

Also document an approach to generating the change log.

R=jeff.pihach
CC=
https://codereview.appspot.com/14990046

https://codereview.appspot.com/14990046/

[Gary Poster (gary)]

Thanks for the review of the old branch, Jeff. I apparently forgot to
land it. :-/

https://codereview.appspot.com/14990046/

=== modified file 'CHANGES.yaml'
--- CHANGES.yaml	2013-10-17 23:01:01 +0000
+++ CHANGES.yaml	2013-11-06 21:25:08 +0000
@@ -23,40 +23,57 @@
 - unreleased:
 - 0.11.0:
     - >
-      (FIX) Greatly reduced the size of the GUI release through removing
-      unnecessary bits and using more efficient compression. This will help
-      speed deployment greatly.
-    - Add onboarding beyond flag.
-    - >
-      Bundle display now includes charm icons in bundle detail page and on
-      token, the charms tab, the visualization caption with show/hide, icons,
-      and README, all visible via URLs.  Bundles integraded in charm-browser
-      search results.  All remains behind charmworldv3 feature flag.
-    - New import/export icons with hover/click.
-    - >
-      (FIX) Reported issue with export and inspector broken after a scripted
-      deploy.
-    - (FIX) Relation names now contain both endpoints.
-    - >
-      (FIX,CLEANUP) Coordinates were being stored in three places, causing
-      interesting side effects in a real environment.  This was fixed along
-      with a refactor of coordinate managing code.
-    - (FIX) Export no longer sets number of units for subordinates.
-    - (FIX) Gracefully handle bundles without x/y annotated coordinates
-    - (FIX) Scale up input was disabled after value change.
+      The inspector (and the GUI, for the first time) supports upgrading or
+      downgrading a service's charm.
+    - >
+      The masthead's UX is improved, notably giving a bit more room for the
+      rest of the application.
+    - Relations now display the names of both endpoints in the environment.
+    - >
+      The GUI distribution is now about 1/9 the size it was before, speeding
+      up deployment.
+    - >
+      Recommended charms (and bundles) are now marked with a red triangle,
+      per results from UX tests.
+    - >
+      (FIX, CLEANUP) Service coordinates were being stored in three places,
+      leading to confusion and bugs.  This code was refactored, introducing
+      many fixes to our service positioning behavior.
+    - >
+      (FIX) If the charm browser were fully open to show charm details, and
+      the browser was minimized and then reopened, the details page would be
+      blank.
+    - >
+      (FIX) The Go implementation of the sandbox always lost the first delta
+      from the AllWatcher's Next method.
+    - >
+      (FIX) Bundle export should not include the number of units for
+      subordinates.
+    - (FIX) Inspector scale up input was disabled forever after value change.
     - (FIX) Charm details link was not working correctly from inspector.
-    - >
-      (FIX) Go sandbox's AllWatcher initialization was broken, causing the
-      first change to go unnoticed.
-    - Position annotations added to export.
-    - The ability to upgrade a charm released without a feature flag.
-    - (FIX) Clarify that the charm has been processed in the source tab.
-    - (FIX) Fullscreen charm details tabs were loading above content.
-    - (FIX) Better listing of source file listing icons.
-    - (FIX) New units added to the canvas no longer overlap old ones
-    - >
-      (FIX) Minimizing the browser with the details view open; closing,
-      and then re-opening caused the browser to be blank.
+    - (FIX) Unit details did not display exposed URL links properly.
+    - (FIX) Position annotations are once again included in exports.
+    - (FIX) New units added to the canvas no longer overlap old ones.
+    - >
+      (FIX) The charm "code" tab in the charm browser now sorts filenames by
+      directory and name, to make it easier to find a particular file.  It
+      also excludes the svg files from the list, since the rendering was less
+      than valuable.
+    - >
+      (CHARM FIX) This is actually a fix in the charm, but it is an important
+      one that is worth calling out.  In some environments, the GUI would
+      break, not allowing proper inspection, export, or other basic behavior.
+      This turned out to be because the new server had an issue with non-ascii
+      values in some cases.
+    - >
+      Behind the "charmworldv3" flag, bundle support is ready for
+      demonstration, including browsing and deploying, in the sandbox and in a
+      live environment.  Tweaks, bug fixes, and some approved bundles should
+      take us the rest of the way soon.  This comprised a very large portion
+      of the work behind this release.
+    - >
+      Behind the "onboard" flag, the GUI has work to show helpful onboarding
+      for new users.
 - 0.10.1:
     - Add icon for exporting a bundle.
     - (FIX) The GUI was unusable when cookies were turned off in your browser.

=== modified file 'docs/process.rst'
--- docs/process.rst	2013-10-14 12:36:47 +0000
+++ docs/process.rst	2013-11-06 21:25:08 +0000
@@ -155,6 +155,35 @@
     ``bzr commit -m 'Set version for release.'``
   - Push the branch directly to the parent (``bzr push :parent`` should work).
 
+- Verify that the section in ``CHANGES.yaml`` for the new release has the
+  expected changelog news items, using the format described in the file.  If
+  you suspect that the changelog does not adequately describe what we
+  accomplished since the last release, do the following.
+
+  - First, relax.  This is a matter of art.  Do your best, and focus on the
+    end user.  These instructions will ask you to make tons of judgements.  Go
+    for it. :-)
+  - Identify the tag of the last release.  This should usually be a three-part
+    identifier such as the one you made in the bzr tag above.  If you are not
+    sure of the tags, try the bzr "tags" command, e.g. ``bzr tags`` or (for
+    less cruft) ``bzr tags -r date:2013-10-17..``.
+  - Look at the logs since the last release tag.  If the last release tag was
+    0.11.0, for instance, use ``bzt log -r tag:'0.11.0'..``.  You might want
+    to pipe this output through less or something similar.
+  - Review each commit from those logs.  If the commit represents a new
+    feature or fix that is interesting to end users, add a bullet for it in
+    the changelog for this release.
+  - Features should come first, working approximately from the features
+    that are most compelling to end users down to the least.
+  - Fixes should come next.  Prefix fixes with "(FIX)" so they are clearly
+    marked.  Sometimes the difference between a feature and a fix is hard to
+    gauge.  Think about it from the perspective of the end user and make your
+    best shot.  Put big fixes first.
+  - Flagged, unreleased features come last.  Mention the feature flag first
+    ('Behind the "charmworldv3" flag, ...') and then summarize progress.  Even
+    if many commits were behind a feature flag, just have a single bullet
+    describing what we accomplished and, perhaps, what remains.
+
 - Run the tests and verify they pass: ``make test-prod`` and then
   ``make test-debug``.
 - Create the tarball: ``FINAL=1 make distfile``.  The process will end by