com.unity.test-framework.performance@3.0.1

## [3.0.1] - 2023-06-23
### Changed
- Removed false "unityRelease" field from package.json

## [3.0.0] - 2023-06-05
### Added
- "Open Source Code" menu item to test results
- Test Filter to filter results by test name
### Changed
- Items in test results are grouped by classname
- Make Sample Groups to be shown only when clicking on items with them
- "New Data available" label re-located
- Replaced CamelCase headers with regular text headers in csv report
- Replaced TRUE/FALSE with Yes/No in the "Increase Is Better" column in csv report
- Renamed the default report name to PerformanceTestResults
- Documentation updates to reflect API changes
### Fixed
- Median calculation in case of even number of samples
- Deviation division by zero
- Exception thrown after clicking Cancel button (during Test Result export)
- The issue where the last column was always empty in csv report

Author: Unity Technologies

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [3.0.1] - 2023-06-23
+### Changed
+- Removed false "unityRelease" field from package.json
+
+## [3.0.0] - 2023-06-05
+### Added
+- "Open Source Code" menu item to test results
+- Test Filter to filter results by test name
+### Changed
+- Items in test results are grouped by classname
+- Make Sample Groups to be shown only when clicking on items with them 
+- "New Data available" label re-located 
+- Replaced CamelCase headers with regular text headers in csv report
+- Replaced TRUE/FALSE with Yes/No in the "Increase Is Better" column in csv report
+- Renamed the default report name to PerformanceTestResults
+- Documentation updates to reflect API changes
+### Fixed
+- Median calculation in case of even number of samples 
+- Deviation division by zero
+- Exception thrown after clicking Cancel button (during Test Result export)
+- The issue where the last column was always empty in csv report
+
 ## [3.0.0-pre.2] - 2023-04-06
 ### Added
 - Help button, which redirects the user to documentation website

Documentation~/images/example04.png

@@ -15,24 +15,27 @@ Install the Performance Testing Extension package using one of the following met
 
 Example:
 1. Open the `manifest.json` file for your Unity project (located in the YourProject/Packages directory) in a text editor.
-2. Add `"com.unity.test-framework.performance": "3.0.0-pre.2",` to the dependencies.
+2. Add `"com.unity.test-framework.performance": "3.0.0-pre.3",` to the dependencies.
 3. Save the manifest.json file.
 4. Verify the Performance Testing Extension is now installed by opening the Unity Package Manager window.
 
 When the package is installed, add a reference to `Unity.PerformanceTesting` in your assembly definition to access the performance testing APIs.
 
+![Performance test example01](images/example04.png)
+
+
 ## Unity version compatibility
 
 Unity releases can often include changes that break compatibility with the Performance Testing Extension, so we cannot currently guarantee latest package version compatability with every Unity version. The table below shows which version of the package is compatible with which Unity release streams. 
 
 | Unity stream             | Package version |
 | ------------------------- |-----------------|
-| 2023.2                    | 3.0.0-pre.2     |
-| 2023.1                    | 3.0.0-pre.2     |
-| 2022.2                    | 3.0.0-pre.2     |
-| 2022.1                    | 3.0.0-pre.2     |
-| 2021.3                    | 3.0.0-pre.2     |
-| 2020.3                    | 3.0.0-pre.2     |
+| 2023.2                    | 3.0.1           |
+| 2023.1                    | 3.0.1           |
+| 2022.2                    | 3.0.1           |
+| 2022.1                    | 3.0.1           |
+| 2021.3                    | 3.0.1           |
+| 2020.3                    | 3.0.1           |
 | 2019.4                    | 2.8.1-preview   |
 
 ## Tips

Documentation~/images/graphtool.png

@@ -8,9 +8,8 @@ When you want to record samples outside of frame time, method time, or profiler
 [Test, Performance]
 public void Test()
 {
-	SampleGroup samplegroup = new SampleGroup("TotalAllocatedMemory", SampleUnit.Megabyte, false);
-    var allocatedMemory = Profiler.GetTotalAllocatedMemoryLong() / 1048576f
-    Measure.Custom(samplegroup, allocatedMemory);
-
+    SampleGroup sampleGroup = new SampleGroup("TotalAllocatedMemory", SampleUnit.Megabyte, false);
+    var allocatedMemory = UnityEngine.Profiling.Profiler.GetTotalAllocatedMemoryLong() / 1048576f;
+    Measure.Custom(sampleGroup, allocatedMemory);
 }
 ```

Documentation~/images/graphtool2.png

@@ -11,11 +11,11 @@ Time Microsecond Median:2018.60 Min:1903.00 Max:2819.80 Avg:2186.35 Std:368.42 S
 
 ## The Performance Test Report
 
-The Performance Test Report (**Window > Analysis > Performance Test Report**) shows a detailed breakdown of individual test runs. This can be used to assess the stability of each test. It provides a visualization of each individual sample recorded within a sample group along with summary statistics for the selected test.
+The Performance Test Report (**Window > General > Performance Test Report**) shows a detailed breakdown of individual test runs. This can be used to assess the stability of each test. It provides a visualization of each individual sample recorded within a sample group along with summary statistics for the selected test.
 
 The Performance Test Report is split into two views: the *test view* and the *sample group view*.
 
-**Test View:** Provides a list of all tests. Each of the columns can be clicked to sort the view. Column values show the sample group with highest deviation.
+**Test View:** Provides a list of all tests. Tests are separated by class names. Each of the columns can be clicked to sort the view. Column values show the sample group with highest deviation.
 
 * *Name* - Name of the test.
 * *Deviation* - The deviation is calculated by dividing the standard deviation by the median for a sample group. It shows the sample group with the highest 'deviation' value. Useful for defining stability of the test.

Documentation~/index.md

@@ -117,8 +117,8 @@ public void Empty()
 
     using (Measure.Scope())
     {
-        Measure.Custom(allocated, Profiler.GetTotalAllocatedMemoryLong() / 1048576f);
-        Measure.Custom(reserved, Profiler.GetTotalReservedMemoryLong() / 1048576f);
+        Measure.Custom(allocated, UnityEngine.Profiling.Profiler.GetTotalAllocatedMemoryLong() / 1048576f);
+        Measure.Custom(reserved, UnityEngine.Profiling.Profiler.GetTotalReservedMemoryLong() / 1048576f);
     }
 }
 ```
@@ -208,9 +208,10 @@ For comparing performance data between runs, use the [Unity Performance Benchmar
     [UnityTest, Performance]
     public IEnumerator Rendering_SampleScene()
     {
-        using(Measure.Scope("Setup.LoadScene"))
+        using(Measure.Scope("LoadScene"))
         {
-            SceneManager.LoadScene("SampleScene");
+            // Add scene to Build Settings before running test 
+            SceneManager.LoadScene("SampleScene"); 
         }
         yield return null;
 
@@ -226,7 +227,7 @@ For comparing performance data between runs, use the [Unity Performance Benchmar
     {
         var allocated = new SampleGroup("TotalAllocatedMemory", SampleUnit.Megabyte);
         var reserved = new SampleGroup("TotalReservedMemory", SampleUnit.Megabyte);
-        Measure.Custom(allocated, Profiler.GetTotalAllocatedMemoryLong() / 1048576f);
-        Measure.Custom(reserved, Profiler.GetTotalReservedMemoryLong() / 1048576f);
+        Measure.Custom(allocated, UnityEngine.Profiling.Profiler.GetTotalAllocatedMemoryLong() / 1048576f);
+        Measure.Custom(reserved, UnityEngine.Profiling.Profiler.GetTotalReservedMemoryLong() / 1048576f);
     }
 ```