From a70b4368394a02f59d4190dc52ec488ba95d82ff Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Fri, 12 Oct 2018 20:20:02 +0100 Subject: [PATCH 01/10] (doc) Added some basic documentation --- docs/input/assets/css/override.css | 20 +++ docs/input/assets/images/clippy.svg | 3 + docs/input/assets/js/anchor.min.js | 6 + docs/input/assets/js/clipboard.min.js | 7 ++ docs/input/docs/index.cshtml | 19 +++ docs/input/docs/installation/Setup.md | 15 +++ docs/input/docs/installation/index.cshtml | 7 ++ docs/input/docs/usage/examples.md | 11 ++ docs/input/docs/usage/index.cshtml | 7 ++ docs/input/docs/usage/parameters.md | 69 ++++++++++ docs/input/index.cshtml | 13 ++ docs/packages.xml | 147 ++++++++++++++++++++++ 12 files changed, 324 insertions(+) create mode 100644 docs/input/assets/css/override.css create mode 100644 docs/input/assets/images/clippy.svg create mode 100644 docs/input/assets/js/anchor.min.js create mode 100644 docs/input/assets/js/clipboard.min.js create mode 100644 docs/input/docs/index.cshtml create mode 100644 docs/input/docs/installation/Setup.md create mode 100644 docs/input/docs/installation/index.cshtml create mode 100644 docs/input/docs/usage/examples.md create mode 100644 docs/input/docs/usage/index.cshtml create mode 100644 docs/input/docs/usage/parameters.md create mode 100644 docs/input/index.cshtml create mode 100644 docs/packages.xml diff --git a/docs/input/assets/css/override.css b/docs/input/assets/css/override.css new file mode 100644 index 0000000..87bbf37 --- /dev/null +++ b/docs/input/assets/css/override.css @@ -0,0 +1,20 @@ +/* Control the margin for bootstrap alert boxes */ +.alert > p { + margin-top: 0px; +} + +/* Control the look and feel of the copy box applied to code sections */ +.btn-copy[disabled] .clippy { + opacity: .3; +} +pre .btn-copy { + -webkit-transition: opacity 0.3s ease-in-out; + -o-transition: opacity 0.3s ease-in-out; + transition: opacity 0.3s ease-in-out; + opacity: 0; + padding: 2px 6px; + float: right; +} +pre:hover .btn-copy { + opacity: 1; +} \ No newline at end of file diff --git a/docs/input/assets/images/clippy.svg b/docs/input/assets/images/clippy.svg new file mode 100644 index 0000000..a72e2dd --- /dev/null +++ b/docs/input/assets/images/clippy.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/input/assets/js/anchor.min.js b/docs/input/assets/js/anchor.min.js new file mode 100644 index 0000000..16faf91 --- /dev/null +++ b/docs/input/assets/js/anchor.min.js @@ -0,0 +1,6 @@ +/** + * AnchorJS - v3.2.2 - 2016-10-05 + * https://github.com/bryanbraun/anchorjs + * Copyright (c) 2016 Bryan Braun; Licensed MIT + */ +!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";function A(A){function e(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.class=A.hasOwnProperty("class")?A.class:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64}function t(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}function n(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style"),t=" .anchorjs-link { opacity: 0; text-decoration: none; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; }",n=" *:hover > .anchorjs-link, .anchorjs-link:focus { opacity: 1; }",i=' @font-face { font-family: "anchorjs-icons"; src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',o=" [data-anchorjs-icon]::after { content: attr(data-anchorjs-icon); }";e.className="anchorjs",e.appendChild(document.createTextNode("")),A=document.head.querySelector('[rel="stylesheet"], style'),void 0===A?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(t,e.sheet.cssRules.length),e.sheet.insertRule(n,e.sheet.cssRules.length),e.sheet.insertRule(o,e.sheet.cssRules.length),e.sheet.insertRule(i,e.sheet.cssRules.length)}}this.options=A||{},this.elements=[],e(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var i,o,s,c,r,a,h,l,u,d,f,p,w=[];if(e(this.options),p=this.options.visible,"touch"===p&&(p=this.isTouchDevice()?"always":"hover"),A||(A="h1, h2, h3, h4, h5, h6"),i=t(A),0===i.length)return!1;for(n(),o=document.querySelectorAll("[id]"),s=[].map.call(o,function(A){return A.id}),r=0;r-1,t=A.lastChild&&(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ")>-1;return e||t||!1}}return A}); \ No newline at end of file diff --git a/docs/input/assets/js/clipboard.min.js b/docs/input/assets/js/clipboard.min.js new file mode 100644 index 0000000..2446ba6 --- /dev/null +++ b/docs/input/assets/js/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v1.5.16 + * https://zenorocha.github.io/clipboard.js + * + * Licensed MIT © Zeno Rocha + */ +!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var t;t="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,t.Clipboard=e()}}(function(){var e,t,n;return function e(t,n,i){function o(a,c){if(!n[a]){if(!t[a]){var l="function"==typeof require&&require;if(!c&&l)return l(a,!0);if(r)return r(a,!0);var s=new Error("Cannot find module '"+a+"'");throw s.code="MODULE_NOT_FOUND",s}var u=n[a]={exports:{}};t[a][0].call(u.exports,function(e){var n=t[a][1][e];return o(n?n:e)},u,u.exports,e,t,n,i)}return n[a].exports}for(var r="function"==typeof require&&require,a=0;a0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function e(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function e(){var t=this,n="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=document.body.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[n?"right":"left"]="-9999px";var i=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.addEventListener("focus",window.scrollTo(0,i)),this.fakeElem.style.top=i+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,document.body.appendChild(this.fakeElem),this.selectedText=(0,o.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function e(){this.fakeHandler&&(document.body.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(document.body.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function e(){this.selectedText=(0,o.default)(this.target),this.copyText()}},{key:"copyText",value:function e(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function e(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function e(){this.target&&this.target.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function e(){this.removeFake()}},{key:"action",set:function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function e(){return this._action}},{key:"target",set:function e(t){if(void 0!==t){if(!t||"object"!==("undefined"==typeof t?"undefined":r(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function e(){return this._target}}]),e}();e.exports=c})},{select:5}],8:[function(t,n,i){!function(o,r){if("function"==typeof e&&e.amd)e(["module","./clipboard-action","tiny-emitter","good-listener"],r);else if("undefined"!=typeof i)r(n,t("./clipboard-action"),t("tiny-emitter"),t("good-listener"));else{var a={exports:{}};r(a,o.clipboardAction,o.tinyEmitter,o.goodListener),o.clipboard=a.exports}}(this,function(e,t,n,i){"use strict";function o(e){return e&&e.__esModule?e:{default:e}}function r(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function a(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}function c(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}function l(e,t){var n="data-clipboard-"+e;if(t.hasAttribute(n))return t.getAttribute(n)}var s=o(t),u=o(n),f=o(i),d=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText}},{key:"listenClick",value:function e(t){var n=this;this.listener=(0,f.default)(t,"click",function(e){return n.onClick(e)})}},{key:"onClick",value:function e(t){var n=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new s.default({action:this.action(n),target:this.target(n),text:this.text(n),trigger:n,emitter:this})}},{key:"defaultAction",value:function e(t){return l("action",t)}},{key:"defaultTarget",value:function e(t){var n=l("target",t);if(n)return document.querySelector(n)}},{key:"defaultText",value:function e(t){return l("text",t)}},{key:"destroy",value:function e(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}]),t}(u.default);e.exports=h})},{"./clipboard-action":7,"good-listener":4,"tiny-emitter":6}]},{},[8])(8)}); \ No newline at end of file diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml new file mode 100644 index 0000000..280e3e4 --- /dev/null +++ b/docs/input/docs/index.cshtml @@ -0,0 +1,19 @@ +--- +Title: Documentation +--- +

This user guide, like Cake.DotNetTool.Module itself, is under very active development. Some parts of it aren't +documented as completely as they need to be, but we gladly accept your contributions.

+ +

We need your help to improve the documentation for Cake.DotNetTool.Module, so if there is something that you +would like to add then you can edit the content directly on GitHub.

+ +@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get(DocsKeys.Order, 1000))) +{ +

@(child.String(Keys.Title))

+ if(child.ContainsKey(DocsKeys.Description)) + { +

@Html.Raw(child.String(DocsKeys.Description))

+ } + + @Html.Partial("_ChildPages", child) +} diff --git a/docs/input/docs/installation/Setup.md b/docs/input/docs/installation/Setup.md new file mode 100644 index 0000000..39dc9cb --- /dev/null +++ b/docs/input/docs/installation/Setup.md @@ -0,0 +1,15 @@ +Due to the fact that Cake Modules are extending and altering the internals of the Cake, the Module Assembly needs to be loaded prior to the main Cake execution. As documented in the Module section of this page, you simply have to do the following: + +``` +./build.sh --bootstrap +./build.sh +``` + +This means that the first execution of Cake will inspect your Cake script for any module inclusions in your script, and if there are any, download and install them. And the second execution will then be able to use those modules, and complete the usage of the module. + +An example of a Cake script which both includes the module definition for the DotNet Tool Module, and which also uses it, is shown below: + +``` +#module nuget:?package=Cake.DotNetTool.Module&version=0.1.0 +#tool "dotnet:?package=Octopus.DotNet.Cli&version=4.41.0" +``` diff --git a/docs/input/docs/installation/index.cshtml b/docs/input/docs/installation/index.cshtml new file mode 100644 index 0000000..3afb475 --- /dev/null +++ b/docs/input/docs/installation/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 2 +Description: How to obtain Cake.DotNetTool.Module. +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +@Html.Partial("_ChildPages") diff --git a/docs/input/docs/usage/examples.md b/docs/input/docs/usage/examples.md new file mode 100644 index 0000000..fb445cc --- /dev/null +++ b/docs/input/docs/usage/examples.md @@ -0,0 +1,11 @@ +Installing a tool using the DotNetTool Cake Module is as simple as: + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0 +``` + +If the tool in question comes from a different source, you can change that as follows: + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0 +``` diff --git a/docs/input/docs/usage/index.cshtml b/docs/input/docs/usage/index.cshtml new file mode 100644 index 0000000..fc709da --- /dev/null +++ b/docs/input/docs/usage/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 2 +Description: How to configure, and execute Cake.DotNetTool.Module. +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +@Html.Partial("_ChildPages") diff --git a/docs/input/docs/usage/parameters.md b/docs/input/docs/usage/parameters.md new file mode 100644 index 0000000..692cea2 --- /dev/null +++ b/docs/input/docs/usage/parameters.md @@ -0,0 +1,69 @@ +The folllowing URI parameters are supported by the Cake.DotNetTool.Module. + +# Source + +This is not a named parameter, but it is permitted as per the URI definition. By default, the dotnet CLI will attempt to install applications from NuGet.org. If your package is actually hosted on another feed, for example, on a MyGet feed, the installation source can be overridden. + +## Example + +``` +#tool dotnet:https://www.myget.org/F/gep13/api/v2?package=Octopus.DotNet.Cli +``` + +# Package + +This is the name of the Global Tool that you would like to install. + +## Example + +``` +#tool dotnet:?package=Octopus.DotNet.Cli +``` + +# Version + +The specific version of the Global Tool that is being installed. If not provided, the dotnet CLI will install the latest package version that is available. + +## Example + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0 +``` + +# Global + +By default, a tool will be installed to the configured Cake Tools folder. If you want to install the tool globally on your machine, you can pass the global parameter. + +## Example + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0&global +``` + +# Config File + +If you need to specify a NuGet config file, for example you need to authenticate to a particular feed, you can specify the location of this file using the configfile parameter. + +## Example + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0&configfile="../../NuGet.config" +``` + +# Framework + +Specifies the [target framework](https://docs.microsoft.com/en-us/dotnet/standard/frameworks) to install the tool for. By default, the .NET Core SDK tries to choose the most appropriate target framework. + +## Example + +``` +#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0&framework="net472" +``` + +# Verbosity + +While not a named parameter, you can control the logging verbosity of the underlying dotnet tool command by altering the overall verbosity of the Cake Script execution. i.e. running: + +``` +./build.sh --verbosity=diagnostic +``` diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml new file mode 100644 index 0000000..3429725 --- /dev/null +++ b/docs/input/index.cshtml @@ -0,0 +1,13 @@ +--- +Title: Cake.DotNetTool.Module +NoSidebar: true +NoContainer: false +NoGutter: true +--- + +
+

What is it?

+

+ Cake.DotNetTool.Module is a Module for Cake, which extends it with a new IPackageInstaller for installing tools using the dotnet CLI. +

+
diff --git a/docs/packages.xml b/docs/packages.xml new file mode 100644 index 0000000..2f3c3aa --- /dev/null +++ b/docs/packages.xml @@ -0,0 +1,147 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 06ba39a090e4b6886874f35b7c8c989bbd148175 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Fri, 12 Oct 2018 21:14:50 +0100 Subject: [PATCH 02/10] (build) Switching to 0.29.0 to test something --- tools/packages.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/packages.config b/tools/packages.config index 0501888..227ecd9 100644 --- a/tools/packages.config +++ b/tools/packages.config @@ -1,4 +1,4 @@ - + From 370b4935341584b1f286b6dd5d864f9689ee37ab Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Fri, 12 Oct 2018 21:39:30 +0100 Subject: [PATCH 03/10] (build) Testing with specific Cake.Recipe --- recipe.cake | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/recipe.cake b/recipe.cake index 1d39d3a..e18cd1f 100644 --- a/recipe.cake +++ b/recipe.cake @@ -1,4 +1,4 @@ -#load nuget:https://www.myget.org/F/cake-contrib/api/v2?package=Cake.Recipe&prerelease +#load nuget:https://www.myget.org/F/cake-contrib/api/v2?package=Cake.Recipe&version=0.3.0-unstable0398 Environment.SetVariableNames(); From 99b7eda76073fc6e99879256fbee9d584d5f54e2 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Fri, 12 Oct 2018 21:46:21 +0100 Subject: [PATCH 04/10] (doc) Minor change to docs. --- docs/input/docs/index.cshtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml index 280e3e4..17fc787 100644 --- a/docs/input/docs/index.cshtml +++ b/docs/input/docs/index.cshtml @@ -5,7 +5,7 @@ Title: Documentation documented as completely as they need to be, but we gladly accept your contributions.

We need your help to improve the documentation for Cake.DotNetTool.Module, so if there is something that you -would like to add then you can edit the content directly on GitHub.

+would like to add then feel free to raise a Pull Request to the Repository.

@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get(DocsKeys.Order, 1000))) { From d997ec096c2da604f8edc89b8aad43673cdbda69 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Sun, 14 Oct 2018 20:35:50 +0100 Subject: [PATCH 05/10] (build) Reset changes made for testing - Issue identified and corrected upstream in Cake.Recipe --- recipe.cake | 2 +- tools/packages.config | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/recipe.cake b/recipe.cake index e18cd1f..1d39d3a 100644 --- a/recipe.cake +++ b/recipe.cake @@ -1,4 +1,4 @@ -#load nuget:https://www.myget.org/F/cake-contrib/api/v2?package=Cake.Recipe&version=0.3.0-unstable0398 +#load nuget:https://www.myget.org/F/cake-contrib/api/v2?package=Cake.Recipe&prerelease Environment.SetVariableNames(); diff --git a/tools/packages.config b/tools/packages.config index 227ecd9..0501888 100644 --- a/tools/packages.config +++ b/tools/packages.config @@ -1,4 +1,4 @@ - + From aad694f38ff7da08d34081609cdb905608ac8b0d Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Sun, 14 Oct 2018 20:39:00 +0100 Subject: [PATCH 06/10] (doc) Minor change to docs --- docs/input/index.cshtml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml index 3429725..e16c2bb 100644 --- a/docs/input/index.cshtml +++ b/docs/input/index.cshtml @@ -10,4 +10,7 @@ NoGutter: true

Cake.DotNetTool.Module is a Module for Cake, which extends it with a new IPackageInstaller for installing tools using the dotnet CLI.

+

+ You can find an introductory blog post about it here. +

From 1bbd2aaf5cbe9d682c35ff98ae89832e712a9f60 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Sun, 14 Oct 2018 20:49:30 +0100 Subject: [PATCH 07/10] (doc) Added information to readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 5d05d16..6342203 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,46 @@ Cake.DotNetTool.Module is a Module for Cake, which extends it with a new IPackageInstaller for installing tools using the dotnet cli. [![License](http://img.shields.io/:license-mit-blue.svg)](http://cake-contrib.mit-license.org) + +## Information + +| | Stable | Pre-release | +|---|---|---| +|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.DotNetTool.Module.svg)](https://github.com/cake-contrib/Cake.DotNetTool.Module/releases/latest)| +|NuGet|[![NuGet](https://img.shields.io/nuget/v/Cake.DotNetTool.Module.svg)](https://www.nuget.org/packages/Cake.DotNetTool.Module)|[![NuGet](https://img.shields.io/nuget/vpre/Cake.DotNetTool.Module.svg)](https://www.nuget.org/packages/Cake.Module)| + +## Build Status + +|Develop|Master| +|:--:|:--:| +|[![Build status](https://ci.appveyor.com/api/projects/status/5h3exd4u8p2k2wpn/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-dotnettool-module/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/5h3exd4u8p2k2wpn/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-dotnettool-module/branch/master)| + +## Code Coverage + +[![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.DotNetTool.Module/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.DotNetTool.Module?branch=develop) + +## Quick Links + +- [Documentation](https://cake-contrib.github.io/Cake.DotNetTool.Module) + +## Chat Room + +Come join in the conversation about Cake.DotNetTool.Module in our Gitter Chat Room + +[![Join the chat at https://gitter.im/cake-contrib/Lobby](https://badges.gitter.im/cake-contrib/Lobby.svg)](https://gitter.im/cake-contrib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +## Build + +To build this package we are using Cake. + +On Windows PowerShell run: + +```powershell +.\build.ps1 +``` + +On Linux/Mac run: + +```shell +./build.sh +``` From 4ba71cc847b71cc723dc96668c668c55ee2adbc8 Mon Sep 17 00:00:00 2001 From: Sean Fausett Date: Mon, 8 Apr 2019 12:46:02 +1200 Subject: [PATCH 08/10] Bump Cake to 0.33.0 --- .../Cake.DotNetTool.Module.Tests.csproj | 8 ++------ .../Cake.DotNetTool.Module/Cake.DotNetTool.Module.csproj | 2 +- tools/packages.config | 2 +- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj b/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj index b7a6b0f..2144551 100644 --- a/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj +++ b/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj @@ -5,12 +5,8 @@ - - all - - - all - + + diff --git a/Source/Cake.DotNetTool.Module/Cake.DotNetTool.Module.csproj b/Source/Cake.DotNetTool.Module/Cake.DotNetTool.Module.csproj index 4393bd1..f4cedc3 100644 --- a/Source/Cake.DotNetTool.Module/Cake.DotNetTool.Module.csproj +++ b/Source/Cake.DotNetTool.Module/Cake.DotNetTool.Module.csproj @@ -11,7 +11,7 @@ - + diff --git a/tools/packages.config b/tools/packages.config index 0501888..f27ab48 100644 --- a/tools/packages.config +++ b/tools/packages.config @@ -1,4 +1,4 @@ - + From c1c9433d7918014d50052ed2cd9bf67f7136851f Mon Sep 17 00:00:00 2001 From: Sean Fausett Date: Mon, 8 Apr 2019 12:47:56 +1200 Subject: [PATCH 09/10] Bump test dependencies --- .../Cake.DotNetTool.Module.Tests.csproj | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj b/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj index 2144551..3cd243f 100644 --- a/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj +++ b/Source/Cake.DotNetTool.Module.Tests/Cake.DotNetTool.Module.Tests.csproj @@ -7,10 +7,10 @@ - - - - + + + + From 0570ca258f2cdf78a16b4ec4c6aea4c50f07d499 Mon Sep 17 00:00:00 2001 From: Sean Fausett Date: Mon, 8 Apr 2019 12:51:59 +1200 Subject: [PATCH 10/10] Add fact attribute --- .../DotNetToolPackageInstallerTests.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/Source/Cake.DotNetTool.Module.Tests/DotNetToolPackageInstallerTests.cs b/Source/Cake.DotNetTool.Module.Tests/DotNetToolPackageInstallerTests.cs index f486565..de0d92b 100644 --- a/Source/Cake.DotNetTool.Module.Tests/DotNetToolPackageInstallerTests.cs +++ b/Source/Cake.DotNetTool.Module.Tests/DotNetToolPackageInstallerTests.cs @@ -78,6 +78,7 @@ public void Should_Throw_If_Log_Is_Null() public sealed class TheCanInstallMethod { + [Fact] public void Should_Throw_If_URI_Is_Null() { // Given