Document and CHANGELOG deterministic UUIDs

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Xcodeproj Changelog
 
+## Master
+
+##### Enhancements
+
+* Allow transforming a project's UUIDs into predictable replacements.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [#175](https://github.com/CocoaPods/Xcodeproj/issues/175)
+
+
 ## 0.25.1
 
 ##### Bug Fixes

lib/xcodeproj/project.rb

@@ -322,6 +322,21 @@ def save(save_path = nil)
       Xcodeproj.write_plist(to_hash, file)
     end
 
+    # Replaces all the UUIDs in the project with deterministic MD5 checksums.
+    #
+    # @note The current sorting of the project is taken into account when
+    #       generating the new UUIDs.
+    #
+    # @note This method should only be used for entirely machine-generated
+    #       projects, as true UUIDs are useful for tracking changes in the
+    #       project.
+    #
+    # @return [void]
+    #
+    def predictabilize_uuids
+      UUIDGenerator.new(self).generate!
+    end
+
     public
 
     # @!group Creating objects
@@ -410,12 +425,6 @@ def uuids
       objects_by_uuid.keys
     end
 
-    # @note this should only be used for entirely machine-generated projects
-    #
-    def predictabilize_uuids
-      UUIDGenerator.new(self).generate!
-    end
-
     # @return [Array<AbstractObject>] all the objects of the project with a
     #         given ISA.
     #