Sensible defaults for CommandLine (#57)

N-lson · web-flow · commit bb0ba6dea72b · 2022-06-15T15:38:32.000+10:00
* Update nuke

* Minor changes

* Use latest LangVersion

* Add templates

* Small changes
diff --git a/.github/ISSUE_TEMPLATE/new_issue.yml b/.github/ISSUE_TEMPLATE/new_issue.yml
@@ -0,0 +1,51 @@
+name: New Issue
+description: File a new issue
+labels: [state/triage, team/fire-and-motion]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **_Are you a customer of Octopus Deploy? Don't raise the issue here. Please contact [our support team](https://octopus.com/support) so we can triage your issue, so that we can make sure it's handled appropriately._**
+  - type: checkboxes
+    id: team
+    attributes:
+      label: Team
+      description: Assign a `team/<team>` label to this issue so it can be dispatched to them. Use the [ownership map](https://whimsical.com/ownership-map-NzbiD4HJyvhC9jNJNfS6TG) to find the most appropriate team to assign this issue to. If you are not sure, or they are not listed, choose `team/fire-and-motion`
+      options:
+        - label: I've assigned a team label to this issue
+          required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear and concise description of what the issue is. Also tell us, what did you expect to happen?
+      placeholder: Tell us what is wrong
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Reproduction
+      description: Enter either a link to an octopus instance exhibiting the error or the steps required to reproduce the error
+      placeholder: Steps to reproduce or link to it occuring
+    validations:
+      required: true
+  - type: textarea
+    id: stacktrace
+    attributes:
+      label: Error and Stacktrace
+      description: If you have an error message and/or stacktrace, add it here. No need to use backticks. Prefer text over a screenshot so it can be searched for.
+      render: shell
+  - type: textarea
+    id: further-information
+    attributes:
+      label: More Information
+      description: Anything else that can help us solve the problem, logs, links, screenshots, suspicions, add them here. Remember this is public so link off to internal systems if there is anything that may be confidential.
+      placeholder: Tell us more
+    validations:
+      required: false
+  - type: textarea
+    id: workaround
+    attributes:
+      label: Workaround
+      description: If you know of any workarounds, add them here
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,44 @@
+**_Are you a customer of Octopus Deploy? Please contact [our support team](https://octopus.com/support) so we can triage your PR, so that we can make sure it's handled appropriately._**
+
+# Background
+
+<!-- Why does this PR exist? -->
+
+# Results
+
+<!-- Describe the result of the change -->
+
+Fixes https://github.com/OctopusDeploy/Issues/issues/... _(optional public issue)_
+
+Fixes https://github.com/OctopusDeploy/ResearchAndDevelopment/issues/... _(optional private issue)_
+
+See [How we use GitHub Issues](https://github.com/OctopusDeploy/Issues/blob/master/docs/CONTRIBUTING.internal.md) (including [this flowchart](https://whimsical.com/r-d-incoming-work-workflow-aug-21-NsDnGQXcwBLwU66a88Zhue) 
+
+## Before
+
+<!-- Consider adding a log excerpt or screen capture. -->
+
+![Before](https://user-images.githubusercontent.com/5088479/120727281-72762180-c51d-11eb-9776-85363dc084e2.png)
+
+## After
+
+<!-- Consider adding a log excerpt or screen capture. -->
+
+![After](https://user-images.githubusercontent.com/5088479/120727258-67bb8c80-c51d-11eb-8d2a-e047095b2d01.png)
+
+# How to review this PR
+
+<!--
+Describe how you want people to review the pull request.
+Perhaps you just want an "in principal" review to prove an idea.
+Perhaps you want specific people to test the resulting changes.
+-->
+
+Quality :heavy_check_mark:
+<!-- Describe focus areas (if any): Review tests/ Exploratory testing/ Smoke testing? -->
+
+# Pre-requisites
+
+- [ ] I have read [How we use GitHub Issues](https://github.com/OctopusDeploy/Issues/blob/master/docs/CONTRIBUTING.internal.md) for help deciding when and where it's appropriate to make an issue.
+- [ ] I have considered informing or consulting the right people, according to the [ownership map](https://whimsical.com/ownership-map-NzbiD4HJyvhC9jNJNfS6TG).
+- [ ] I have considered appropriate testing for my change.
diff --git a/.nuke/build.schema.json b/.nuke/build.schema.json
@@ -79,10 +79,10 @@
           "items": {
             "type": "string",
             "enum": [
-              "CalculateVersion",
               "Clean",
               "Compile",
               "CopyToLocalPackages",
+              "Default",
               "Merge",
               "Pack",
               "Restore",
@@ -100,10 +100,10 @@
           "items": {
             "type": "string",
             "enum": [
-              "CalculateVersion",
               "Clean",
               "Compile",
               "CopyToLocalPackages",
+              "Default",
               "Merge",
               "Pack",
               "Restore",
diff --git a/build/Build.cs b/build/Build.cs
@@ -21,7 +21,14 @@
 [UnsetVisualStudioEnvironmentVariables]
 class Build : NukeBuild
 {
-    [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")] readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
+    /// Support plugins are available for:
+    /// - JetBrains ReSharper        https://nuke.build/resharper
+    /// - JetBrains Rider            https://nuke.build/rider
+    /// - Microsoft VisualStudio     https://nuke.build/visualstudio
+    /// - Microsoft VSCode           https://nuke.build/vscode
+
+    [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")]
+    readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
 
     [Solution(GenerateProjects = true)] readonly Solution Solution;
 
@@ -44,20 +51,12 @@ class Build : NukeBuild
     AbsolutePath OctopusCommandLineFolder => SourceDirectory / "CommandLine";
 
     Target Clean => _ => _
-        .Before(Restore)
         .Executes(() =>
         {
-            SourceDirectory.GlobDirectories("**/bin", "**/obj", "**/TestResults").ForEach(DeleteDirectory);
+            SourceDirectory.GlobDirectories("**/bin", "**/obj").ForEach(DeleteDirectory);
             EnsureCleanDirectory(ArtifactsDirectory);
         });
 
-    [PublicAPI]
-    Target CalculateVersion => _ => _
-        .Executes(() =>
-        {
-            //all the magic happens inside `[OctoVersion]` above. we just need a target for TeamCity to call
-        });
-
     Target Restore => _ => _
         .DependsOn(Clean)
         .Executes(() =>
@@ -67,19 +66,18 @@ class Build : NukeBuild
         });
 
     Target Compile => _ => _
-        .DependsOn(Clean)
         .DependsOn(Restore)
         .Executes(() =>
         {
-            Log.Information("Building {0} v{1}", Solution.Name, OctoVersionInfo.FullSemVer);
-
             DotNetBuild(_ => _
                 .SetProjectFile(Solution)
                 .SetConfiguration(Configuration)
                 .SetVersion(OctoVersionInfo.FullSemVer)
+                .SetInformationalVersion(OctoVersionInfo.InformationalVersion)
                 .EnableNoRestore());
         });
 
+    [PublicAPI]
     Target Test => _ => _
         .DependsOn(Compile)
         .Executes(() =>
@@ -92,7 +90,7 @@ class Build : NukeBuild
         });
 
     Target Merge => _ => _
-        .DependsOn(Test)
+        .DependsOn(Compile)
         .Executes(() =>
         {
             var targets = Solution.CommandLine.GetTargetFrameworks();
@@ -103,7 +101,7 @@ class Build : NukeBuild
                 var outputFolder = OctopusCommandLineFolder / "bin" / Configuration / $"{target}-Merged";
                 EnsureExistingDirectory(outputFolder);
 
-                // The call to ILRepack with .EnableInternalize() requires the Octopus.Server.Client.dll assembly to be first in the list.
+                // The call to ILRepack with .EnableInternalize() requires the Octopus.CommandLine.dll assembly to be first in the list.
                 var inputAssemblies = inputFolder.GlobFiles("NewtonSoft.Json.dll", "Octopus.*.dll")
                     .Select(x => x.ToString())
                     .OrderByDescending(x => x.Contains("Octopus.CommandLine.dll"))
@@ -126,8 +124,6 @@ class Build : NukeBuild
         });
 
     Target Pack => _ => _
-        .DependsOn(Compile)
-        .DependsOn(Test)
         .DependsOn(Merge)
         .Executes(() =>
         {
@@ -148,36 +144,38 @@ class Build : NukeBuild
                     .SetVersion(OctoVersionInfo.FullSemVer)
                     .SetConfiguration(Configuration)
                     .SetOutputDirectory(ArtifactsDirectory)
-                    .EnableNoBuild());
+                    .EnableNoBuild()
+                    .DisableIncludeSymbols()
+                    .SetVerbosity(DotNetVerbosity.Normal)
+                );
             }
             finally
             {
                 ReplaceTextInFiles(nuspecPath, $"<version>{OctoVersionInfo.FullSemVer}</version>", "<version>$version$</version>");
                 ReplaceTextInFiles(nuspecPath, $"\\{Configuration.ToString()}\\", "\\$configuration$\\");
             }
+
+            static void ReplaceTextInFiles(AbsolutePath path, string oldValue, string newValue)
+            {
+                var fileText = File.ReadAllText(path);
+                fileText = fileText.Replace(oldValue, newValue);
+                File.WriteAllText(path, fileText);
+            }
         });
 
-    [UsedImplicitly]
     Target CopyToLocalPackages => _ => _
         .OnlyWhenStatic(() => IsLocalBuild)
         .TriggeredBy(Pack)
         .Executes(() =>
         {
             EnsureExistingDirectory(LocalPackagesDirectory);
-            CopyFileToDirectory(ArtifactsDirectory / $"{Solution.Name}.{OctoVersionInfo.FullSemVer}.nupkg", LocalPackagesDirectory, FileExistsPolicy.Overwrite);
+            ArtifactsDirectory.GlobFiles("*.nupkg")
+                .ForEach(package => CopyFileToDirectory(package, LocalPackagesDirectory, FileExistsPolicy.Overwrite));
         });
 
-    void ReplaceTextInFiles(AbsolutePath path, string oldValue, string newValue)
-    {
-        var fileText = File.ReadAllText(path);
-        fileText = fileText.Replace(oldValue, newValue);
-        File.WriteAllText(path, fileText);
-    }
+    Target Default => _ => _
+        .DependsOn(Pack)
+        .DependsOn(CopyToLocalPackages);
 
-    /// Support plugins are available for:
-    /// - JetBrains ReSharper        https://nuke.build/resharper
-    /// - JetBrains Rider            https://nuke.build/rider
-    /// - Microsoft VisualStudio     https://nuke.build/visualstudio
-    /// - Microsoft VSCode           https://nuke.build/vscode
-    public static int Main() => Execute<Build>(x => x.Pack);
+    public static int Main() => Execute<Build>(x => x.Default);
 }
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "6.0.102",
+    "version": "6.0.300",
     "rollForward": "latestFeature"
   }
 }
diff --git a/source/CommandLine/CommandLine.csproj b/source/CommandLine/CommandLine.csproj
@@ -18,13 +18,14 @@
 
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
         <Authors>Octopus Deploy Pty. Ltd.</Authors>
-        <Copyright>Copyright © Octopus Deploy 2021</Copyright>
+        <Copyright>Copyright © Octopus Deploy 2022</Copyright>
         <PackageProjectUrl>https://github.com/OctopusDeploy/CommandLine</PackageProjectUrl>
         <RepositoryUrl>https://github.com/OctopusDeploy/CommandLine</RepositoryUrl>
         <Description>The command line parsing library used by many of Octopus apps. Supports global and command specific help, json output, auto-complete and more.</Description>
         <!-- copy dependencies to the output folder (for netstandard) so we can ilmerge them together -->
         <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
         <RuntimeIdentifiers>win-x64;linux-x64;osx-x64</RuntimeIdentifiers>
+        <LangVersion>latest</LangVersion>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/source/CommandLine/Octopus.CommandLine.nuspec b/source/CommandLine/Octopus.CommandLine.nuspec
@@ -11,7 +11,7 @@
         <icon>images\icon.png</icon>
         <projectUrl>https://github.com/OctopusDeploy/CommandLine</projectUrl>
         <description>The command line parsing library used by many of Octopus apps. Supports global and command specific help, json output, auto-complete and more.</description>
-        <copyright>Copyright © Octopus Deploy 2021</copyright>
+        <copyright>Copyright © Octopus Deploy 2022</copyright>
         <repository url="https://github.com/OctopusDeploy/CommandLine" />
         <dependencies>
             <group targetFramework=".NETFramework4.6.2">
diff --git a/source/Tests/Tests.csproj b/source/Tests/Tests.csproj
@@ -3,6 +3,7 @@
     <PropertyGroup>
         <TargetFrameworks Condition="!$([MSBuild]::IsOSUnixLike())">net462;netstandard2.0;netcoreapp3.1;net6.0</TargetFrameworks>
         <TargetFrameworks Condition="$([MSBuild]::IsOSUnixLike())">netstandard2.0;netcoreapp3.1;net6.0</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
     </PropertyGroup>
 
     <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "6.0.102",`
	`3`	`+ "version": "6.0.300",`
`4`	`4`	`"rollForward": "latestFeature"`
`5`	`5`	`}`
`6`	`6`	`}`