Mirrors/velopack
1
0
Fork 0
mirror of https://github.com/velopack/velopack.git synced 2025-10-25 15:19:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #582 from kenbailey/docs-octopack

Browse Source 
Octopack docs added (replaces #563)
This commit is contained in:
Paul Betts
2016-02-06 00:49:13 +01:00
parent c95ae176a7 1ab3c35d75
commit 0d3c888508
4 changed files with 37 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/faq.md
View File

@@ -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. 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 ## Updating

2
docs/getting-started/5-updating.md
View File

@@ -39,7 +39,7 @@ Use the [Package Manager Console](https://docs.NuGet.org/consume/package-manager
~~~powershell ~~~powershell
PM> Squirrel --releasify MyApp.1.0.1.nupkg 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 and 2015. **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 #### Releasify Output

1
docs/readme.md
View File

@@ -37,6 +37,7 @@ The **[Getting Started Guide](getting-started/0-overview.md)** provides a step-b
* **Packaging** - documentation related to packaging app files and preparing them for release. * **Packaging** - documentation related to packaging app files and preparing them for release.
* [Naming Conventions](using/naming.md) - overview of sources used in naming (e.g., shortcut name). * [Naming Conventions](using/naming.md) - overview of sources used in naming (e.g., shortcut name).
* [NuGet Package Metadata](using/nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel. * [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` * [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. * [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. * [Application Signing](using/application-signing.md) - adding code signing to `Setup.exe` and your application.

33
docs/using/octopack.md Normal file
View File

@@ -0,0 +1,33 @@
| [docs](..) / [using](.) / octopack.md
|:---|
# 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:
~~~
<files>
<file src="bin\Release\*.*" target="lib\net45\" exclude="bin\release\*.pdb;bin\release\*.nupkg;bin\release\*.vshost.*"/>
</files>
~~~
If you're building using Visual Studio, you will also need to edit your .csproj file to include a property group.
~~~
<PropertyGroup>
<RunOctoPack>true</RunOctoPack>
</PropertyGroup>
~~~
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) |
|----|