Squirrel Docs Update - Visual Studio Packaging (includes PR #1120, #976, #830) #1188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the latest version that includes all suggestions from Squirrel#630 Changes: * Automatically searches for nuget.exe and squirrel.exe and doesn't require opening package console * Displays well formatted errors if executables are not found * Changed MyApp to $(TargetName) to match project name bu default * Added quotes around paths to support spaces in file path * Note about new PackageReference directive
Merged additional suggestions from discussion in Squirrel#630
Changed MyApp to $(TargetName)
This was referenced Oct 31, 2017
kenbailey
changed the title
kenbailey
changed the title
poma
reviewed
Nov 1, 2017
| Note: this will not work if your solution uses new `PackageReference` directive instead of `packages.config` file for NuGet dependencies because it will be unable to find nuget.exe and squirrel.exe. In that case change path to executables accordingly. | ||
| * It suffers from a bug when sometimes NuGet packages are not loaded properly and throws nuget/squirrel is not recogized (9009) errors. **Tip:** In this case you may simply need to restart Visual Studio so the Package Manager Console will have loaded all the package tools | ||
| * If you get a `'squirrel' is not recognized as an internal or external command` error, you need to add the full path to `Squirrel.exe` in the build target `Exec Command` call. | ||
| * You can create a separate build configuration for building a package if you wish to avoid running `--releasify` every time you build your `Release` configuration (e.g., create a new `Package` configuration based on `Release`). |
There was a problem hiding this comment.
Those 3 points no longer apply when using macros and Error tags, you should delete them
| * It suffers from a bug when sometimes NuGet packages are not loaded properly and throws nuget/squirrel is not recogized (9009) errors. **Tip:** In this case you may simply need to restart Visual Studio so the Package Manager Console will have loaded all the package tools | ||
| * If you get a `'squirrel' is not recognized as an internal or external command` error, you need to add the full path to `Squirrel.exe` in the build target `Exec Command` call. | ||
| * You can create a separate build configuration for building a package if you wish to avoid running `--releasify` every time you build your `Release` configuration (e.g., create a new `Package` configuration based on `Release`). | ||
| * This will not work if your solution uses new `PackageReference` directive instead of `packages.config` file for NuGet dependencies because it will be unable to find nuget.exe and squirrel.exe. In that case change path to executables accordingly. |
There was a problem hiding this comment.
This probably can be moved to the relevant section of Build Target Configuration
|
In my opinion this description is unnecessarily long, especially describing what every msbuild tag does. Leaving PR #1120 open so that maintainer can decide whether to merge additional text or not. |
|
@poma, fair enough. Thanks for the feedback. |
shiftkey
added
the
docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@paulcbetts, when you get a chance can you merge this in. Includes a bunch of good changes to the Visual Studio Packaging docs by @poma, @Yitzchok, @markfox1, @PHeonix25, @awbacker, and others.
It includes a little bit of formatting I've done.
Thanks!