Support running Octo from .net core tool-manifest

[jeremyabbott]

Description

Adds support for running octo.exe as a .NET Core tool installed via a tool-manifest.

Local verification (macOS):

dotnet new fake
dotnet tool install Octopus.DotNet.Cli

#r "paket:
source https://api.nuget.org/v3/index.json
source /Users/jeremy/code/FAKE/src/app/Fake.Tools.Octo/bin/Debug
nuget Fake.DotNet.Cli
nuget Fake.IO.FileSystem
nuget Fake.Core.Target
nuget Fake.Tools.Octo 1.0.0 //"
#load ".fake/build.fsx/intellisense.fsx"
open Fake.Core
open Fake.DotNet
open Fake.Core.TargetOperators

Target.initEnvironment ()

Target.create "Octo" (fun _ ->
    
    Fake.Tools.Octo.listEnvironments
      (fun opts ->
        { opts with 
            ToolType = ToolType.CreateLocalTool()
            Server = { opts.Server with ServerUrl = "https://octopus.server"; ApiKey="API-ABCDEFG123"}
        })
)

Target.runOrDefault "Octo"

TODO

There are two obsolete calls in this module, but I'm not sure how to use the suggested replacement method.

• New (API-)documentation for new features exist (Note: API-docs are enough, additional docs are in help/markdown)

• unit or integration test exists (or short reasoning why it doesn't make sense)

• boy scout rule: "leave the code behind in a better state than you found it" (fix warnings, obsolete members or code-style in the places you worked in)

• (if new module) the module has been linked from the "Modules" menu, edit help/templates/template.cshtml, linking to the API-reference is fine.

• (if new module) the module is in the correct namespace

• (if new module) the module is added to Fake.sln (dotnet sln Fake.sln add src/app/Fake.*/Fake.*.fsproj)

• Fake 5 API guideline is honored

[matthid]

Shouldn't we use a similar API as existing modules are using (https://fake.build/dotnet-cli.html#SDK-tools-local-global-clireference) for example ReportGenerator?

[jeremyabbott]

@matthid I'll take a look! Thank you for the suggestion.

[jeremyabbott]

@matthid I'm sorry for taking so long to come back to this! I made the recommended changes and tested them locally. I'm on macOS:

dotnet new fake
dotnet tool install Octopus.DotNet.Cli

#r "paket:
source https://api.nuget.org/v3/index.json
source /Users/jeremy/code/FAKE/src/app/Fake.Tools.Octo/bin/Debug
nuget Fake.DotNet.Cli
nuget Fake.IO.FileSystem
nuget Fake.Core.Target
nuget Fake.Tools.Octo 1.0.0 //"
#load ".fake/build.fsx/intellisense.fsx"
open Fake.Core
open Fake.DotNet
open Fake.Core.TargetOperators

Target.initEnvironment ()

Target.create "Octo" (fun _ ->
    
    Fake.Tools.Octo.listEnvironments
      (fun opts ->
        { opts with 
            ToolType = ToolType.CreateLocalTool()
            Server = { opts.Server with ServerUrl = "https://octopus.server"; ApiKey="API-ABCDEFG123"}
        })
)

Target.runOrDefault "Octo"

[matthid]

Shouldn't we add here that you need to set the ToolPath and maybe link to https://fake.build/dotnet-cli.html#SDK-tools-local-global-clireference?

[matthid]

No need to be sorry, good things take time :)
Looks good to me in general, we could improve the docs and add some tests but that is nitpicking...

[jeremyabbott]

@matthid I'll follow up with those suggestions in a separate PR. Thank you again!