From 7fdb64eeac1d8a77e6da106a4b103ae96bb82959 Mon Sep 17 00:00:00 2001 From: DenisPitcher Date: Sat, 16 Jan 2016 16:08:34 +0100 Subject: [PATCH 1/5] Adding missing More Packaging documentation Adding example of how to use OctoPack in absence of other guidance. --- docs/getting-started/2.2-More-Packaging.md | 25 ++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/getting-started/2.2-More-Packaging.md diff --git a/docs/getting-started/2.2-More-Packaging.md b/docs/getting-started/2.2-More-Packaging.md new file mode 100644 index 00000000..206d26d9 --- /dev/null +++ b/docs/getting-started/2.2-More-Packaging.md @@ -0,0 +1,25 @@ + +# More Packaging + +# Using OctoPack + +In order to automatically construct your nuget packages you can use [OctoPack](https://github.com/OctopusDeploy/OctoPack). Octopack allows you to specify a .nuspec file which will be used to specify how your .nupkg should be created. + +Follow the core instructions for creating your .nuspec file on the [OctoPack](https://github.com/OctopusDeploy/OctoPack) page. + +You'll then need to add a files specification to match Squirrel's expected .nupkg structure: + +~~~ + + + +~~~ + +If you're building using Visual Studio, you will also need to edit your .csproj file to include a property group. +~~~ + + true + +~~~ + +If you're using a build server, see OctoPack's guides on how to trigger it to be run. From 65c1a748dd757f1c00baa20d0d7d8f6ac9f078ff Mon Sep 17 00:00:00 2001 From: Ken Bailey Date: Fri, 29 Jan 2016 21:26:19 -0700 Subject: [PATCH 2/5] move to using docs directory --- docs/{getting-started/2.2-More-Packaging.md => using/octopack.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{getting-started/2.2-More-Packaging.md => using/octopack.md} (100%) diff --git a/docs/getting-started/2.2-More-Packaging.md b/docs/using/octopack.md similarity index 100% rename from docs/getting-started/2.2-More-Packaging.md rename to docs/using/octopack.md From 1ff609ff36ffa8cd9c1757a16d79076a57de386b Mon Sep 17 00:00:00 2001 From: Ken Bailey Date: Fri, 29 Jan 2016 00:39:32 -0700 Subject: [PATCH 3/5] Add link in TOC and formatting for octopack doc --- docs/readme.md | 1 + docs/using/octopack.md | 12 ++++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index 330a79e6..7e105ed5 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -36,6 +36,7 @@ The **[Getting Started Guide](getting-started/0-overview.md)** provides a step-b * [Debugging Installs](using/debugging-installs.md) - tips for debugging Squirrel.Windows initial installs. * **Packaging** - documentation related to packaging app files and preparing them for release. * [NuGet Package Metadata](using/nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel. + * [Using OctoPack](using/octopack.md) - steps to use OctoPack to build the source NuGet package to provide to `squirrel --releasify`. * [Squirrel Command Line](using/squirrel-command-line.md) - command line options for `Squirrel --releasify` * [Delta Packages](using/delta-packages.md) - an overview of how `Squirrel.exe` creates delta packages. * [Application Signing](using/application-signing.md) - adding code signing to `Setup.exe` and your application. diff --git a/docs/using/octopack.md b/docs/using/octopack.md index 206d26d9..bf98a02c 100644 --- a/docs/using/octopack.md +++ b/docs/using/octopack.md @@ -1,5 +1,5 @@ - -# More Packaging +| [docs](..) / [using](.) / octopack.md +|:---| # Using OctoPack @@ -16,6 +16,7 @@ You'll then need to add a files specification to match Squirrel's expected .nupk ~~~ If you're building using Visual Studio, you will also need to edit your .csproj file to include a property group. + ~~~ true @@ -23,3 +24,10 @@ If you're building using Visual Studio, you will also need to edit your .csproj ~~~ If you're using a build server, see OctoPack's guides on how to trigger it to be run. + +--- +| Return: [Table of Contents](../readme.md) | +|----| + + + From 7b4e937439dd0f4b897a0a5dd7972970969f6f12 Mon Sep 17 00:00:00 2001 From: Ken Bailey Date: Fri, 29 Jan 2016 21:33:41 -0700 Subject: [PATCH 4/5] Add FAQ about install issue from [dot] in NuGet Package Id. --- docs/faq.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index e25f8127..8fcc8635 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -41,6 +41,8 @@ This program is blocked by group policy. For more information, contact your syst ``` The best course of action is to request that executables for Squirrel and your application be whitelisted by your corporate overlords. +4. **No Shortcuts are Created for my Application** + Verify that the NuGet Package Metadata `id` property doesn't have a [space or \[dot\]](https://github.com/Squirrel/Squirrel.Windows/issues/530) in it. ## Updating From 1ab3c35d7581340c2afaec2669678aa9fc824bde Mon Sep 17 00:00:00 2001 From: Ken Bailey Date: Fri, 29 Jan 2016 21:38:09 -0700 Subject: [PATCH 5/5] Add comment from PR #564. --- docs/getting-started/5-updating.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/5-updating.md b/docs/getting-started/5-updating.md index 9ec9264b..732a9b97 100644 --- a/docs/getting-started/5-updating.md +++ b/docs/getting-started/5-updating.md @@ -39,7 +39,7 @@ Use the [Package Manager Console](https://docs.NuGet.org/consume/package-manager PM> Squirrel --releasify MyApp.1.0.1.nupkg ~~~ -**Tip:** If you get an error stating that `...'Squirrel' is not recognized...` then you may simply need to restart Visual Studio so the `Package Manager Console` will have loaded all the package tools. This behavior has been seen on the Community Edition of VS 2013. +**Tip:** If you get an error stating that `...'Squirrel' is not recognized...` then you may simply need to restart Visual Studio so the `Package Manager Console` will have loaded all the package tools. This behavior has been seen on the Community Edition of VS 2013 and 2015. #### Releasify Output