Add extra explanatory description to the test

OctopusDeploy · Aug 30, 2019 · ace5e29 · ace5e29
1 parent 8a04332
commit ace5e29
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/source/Octopus.Client.E2ETests/InlinedDependenciesFixture.cs b/source/Octopus.Client.E2ETests/InlinedDependenciesFixture.cs
@@ -7,6 +7,13 @@
 
 namespace Octopus.Client.E2ETests
 {
+    /// <summary>
+    /// These tests are designed to ensure that we keep our published artifact working in the way we expect it to
+    ///  * is a single dll that can be referenced from powershell
+    ///  * actually works
+    /// If you find yourself changing these tests, it's very likely you'll need to change
+    /// https://github.com/OctopusDeploy/docs/blob/master/docs/octopus-rest-api/octopus.client.md 
+    /// </summary>
     [TestFixture]
     public class InlinedDependenciesFixture
     {

diff --git a/source/Octopus.Client.E2ETests/NuSpecDependenciesFixture.cs b/source/Octopus.Client.E2ETests/NuSpecDependenciesFixture.cs
@@ -9,6 +9,10 @@
 namespace Octopus.Client.E2ETests
 {
     /// <summary>
+    /// These tests are designed to ensure that we keep our published artifact working in the way we expect it to
+    ///  * is a single dll that can be referenced from powershell
+    ///  * inlines dependencies properly
+    ///  * doesn't pull down unnecessary dependencies
     /// If you find yourself changing these tests, it's very likely you'll need to change
     /// https://github.com/OctopusDeploy/docs/blob/master/docs/octopus-rest-api/octopus.client.md 
     /// </summary>

diff --git a/source/Octopus.Client.E2ETests/PowerShellExecutionFixture.cs b/source/Octopus.Client.E2ETests/PowerShellExecutionFixture.cs
@@ -7,6 +7,14 @@
 
 namespace Octopus.Client.E2ETests
 {
+    /// <summary>
+    /// These tests are designed to ensure that we keep our published artifact working in the way we expect it to
+    ///  * is a single dll that can be referenced from powershell
+    ///  * inlines dependencies properly
+    ///  * doesn't pull down unnecessary dependencies
+    /// If you find yourself changing these tests, it's very likely you'll need to change
+    /// https://github.com/OctopusDeploy/docs/blob/master/docs/octopus-rest-api/octopus.client.md 
+    /// </summary>
     [TestFixture]
     public class PowerShellExecutionFixture
     {