How do you get documentation on the packages that you install/uninstall? Every site I find that has any information regarding NuGet or the Package Manager Console is SUPER EXCITED to show you how to install/uninstall a package.
This seems trivial but you would think there'd be some console command that said something like Describe-Package or something or maybe the author could leave a link in the description on the NuGet website but no. Nothing, nada, zip.
Can someone please put me out of my misery and either tell me there's no official documentation structure for the packages or is there a command where I can view the available commands?
This will get you the list of available commands in NuGet:
Get-Command -Module nuget.visualstudio
This is a Powershell command returning a list of type CommandInfo.
You can then get help about a specific command by doing:
Get-Help Install-Package
For a summary of all commands, try:
Get-Command -Module nuget.visualstudio |% { Get-Help $_.Name | select Name, Synopsis } | Format-Table -Auto
You could create an alias for this is you were to use it often.
If you wanted to get the description of a package from a repository:
Find-Package -Remote elmah | Select Description
Related
I have been trying to find a way to configure the IIS 'outputcaching' setting. I have been looking around and having really had anything that works. I am basically trying to set output caching for an extension .pdf and the setting "until changed". I've tried this code:
Set-WebConfigurationProperty -pspath 'MACHINE/WEBROOT/APPHOST/Default Web
Site' -Filter "system.webServer/caching/profiles/add[#extension='.pdf']" -
Name "kernelCachePolicy" -Value "CacheUntilChange"
but that gave me the following error:
WARNING: Target configuration object 'system.webServer/caching/profiles/add[#extension='.pdf'] is not found at path 'MACHINE/WEBROOT/APPHOST/Default Web Site'.
Try using Add-WebConfigurationProperty
Add-WebConfigurationProperty Will add a property that isn't there.
Set-WebConfigurationProperty Changes the value of a property that already exists
Is there any way to get an automatically updated list of all used nuget packages in my solution, including a link to the corresponding license, which I can display within my app?
Running the following from Package Manager Console within Visual Studio gives me the required information:
Get-Project | Get-Package | select Id, Version, LicenseUrl
How to get this list a) automatically updated on each change and b) get it into my app?
Target is to have an Info/About dialog showing all this data.
I found one way, pretty sure it has some limitations...
I'm calling this in the pre-build event:
powershell.exe -ExecutionPolicy Bypass -File $(ProjectDir)\Resources\tools\PreBuildScript.ps1 $(ProjectDir) $(SolutionDir) $(TargetDir)
And here is how resources\tools\PreBuildScript.ps1 looks like:
param (
[Parameter(Mandatory=$True)]
[string]$ProjectDir,
[Parameter(Mandatory=$True)]
[string]$SolutionDir,
[Parameter(Mandatory=$True)]
[string]$TargetDir
)
[Reflection.Assembly]::LoadWithPartialName('System.IO.Compression.FileSystem')
$nupkgs = Get-ChildItem -Recurse -Filter *.nupkg -Path "$SolutionDir\packages"
$nuspecs = $nupkgs | %{ [IO.Compression.ZipFile]::OpenRead($_.FullName).Entries | where {$_.Fullname.EndsWith('.nuspec')} }
$metadata = $nuspecs | %{
([xml]([System.IO.StreamReader]$_.Open()).ReadToEnd()) | %{New-Object PSObject -Property #{
Version = $_.package.metadata.version
Authors = $_.package.metadata.authors
Title = IF ([string]::IsNullOrWhitespace($_.package.metadata.title)){$_.package.metadata.id} else {$_.package.metadata.title}
LicenseUrl = $_.package.metadata.licenseUrl
}}
}
$metadata | %{ '{0} {1}{4}Autor(en): {2}{4}Lizenz: {3}{4}{4}' -f $_.Title, $_.Version, $_.Authors, $_.LicenseUrl, [Environment]::NewLine } | Out-File "$ProjectDir\Resources\ThirdPartyLicenseOverview.txt"
This gives me an (ugly) textfile Resources\ThirdPartyLicenseOverview.txt that I can include as embedded resource to use it within my app.
Not the final solution but one step on the way...
Is there any way to get an automatically updated list of all used nuget packages in my solution, including a link to the corresponding license.
As far as I am aware there is nothing currently available to get the list automatically updated on each change and get it into app.
We could not get the license information directly from the command line as part of a CI build, need to create an application to open the .nupkg zip file, extract the license url from the .nuspec file and download the license from this url.
Alternatively, you could use the package manager console window inside Visual Studio and with a bit of PowerShell download the license files. But if you want get it into your app, you could not use the package manager console, in this case you could not get the licenses.
Besides, we could use PowerShell script to get the package Id Version and download the license files, but we still need require someone to run the script to get the Id, version and download the licenses. If you still want to automatically updated on each change, you need use PowerShell to monitor the package.config. The PowerShell script should be invoked and executed automatically after any change in the package, but it will be difficult to achieve.
In Visual Studio everything works and a Components directory is created with the appropriate dlls. However, TeamCity is not able to retrieve the Android Support Library dlls because the trigger for the restore is a Xamarin VS plugin that runs when loading the solution. The equivalent of nuget package restore for Xamarin is xamarin-component. I have placed the xamarin-component.exe in my C:\Windows directory. To configure TeamCity, I prepended a Command Line build step with
Command executable: xamarin-component
Command parameters: restore mysolution.sln
TeamCity runs as NT Authority\System. So using PsExec,
psexec -i -s %SystemRoot%\system32\cmd.exe
If I then run 'xamarin-component login'
INFO (login): Computed cookie jar path: C:\Windows\system32\config\systemprofile\.xamarin-credentials
INFO (login): Computed cookie jar path: C:\Windows\system32\config\systemprofile\.xamarin-credentials
INFO (login): Credentials successfully stored.
When I go to my solution in cmd and attempt the restore, I get an attempt to download the componet, and then a Json parsing error. This is the same error I get in TeamCity.
I get the error if I use 'Administrator' (which stores the credential in C:\Users\Administrator. Earlier when I was using my personal account, it did work. However, once I deleted the C:\Users\tim\AppData\Local\Xamarin\Cache\Components, the same issue emerged. Fiddler shows that rather than getting Json back (as we do when we enter an invalid token) we are getting a 302 redirect that says Object moved here. And here is the xamarin
login page - obviously not Json.
Tried.
1. Set COOKIE_JAR_PATH to C:\Users\tim.xamarin-credentials - xpkg picks up but same error
2. Copy .xamarin-credentials from Config\system32 to D:\, set COOKIE_JAR_PATH to D:.xamarin-credentials - xpkg picks up but same error
3. Move .xamarin-credentials to C:\, set COOKIE_JAR_PATH - same error
4. Re-login in NT Authority with COOKIE_JAR_PATH to C:.xamarin-credentials - same error
My temporary idea now is to figure out where the NT Authority xamarin-component looks for Cache and put the files there.
C:\Windows\system32\config\systemprofile\AppData\Local\Xamarin\Cache\Components\xamandroidsupportv4-18-4.18.1.xam
The version of my xamarin-component is 0.99 - for 100, we try harder...
I’ve had trouble actually getting the cookie jar to load correctly from the system32 path. I think this is a path virtualization issue that I just don't understand well enough to make heads or tails of.
I ended up adding an environment variable that the tool will read from (I'm its principal author at Xamarin :-) that specifies the cookie jar path to read from, and this solved the problem for others using TeamCity. The environment variable is COOKIE_JAR_PATH.
You can set it from TeamCity's environment settings to point to a cookie jar path outside of the system32 profile directory (I think in my original testing, I put it in the root of the C: drive, but it can be anywhere, really).
As a hack, I copied the Cache folder from
C:\Users\tim\AppData\Local\Xamarin
to
C:\Windows\system32\config\systemprofile\AppData\Local\Xamarin\
That bypassed communication with the Xamarin server.
Update. I suspect it might be a bad link or setup on their server side. When xamarin-component restore is called, a call is made to
GET /api/available_versions?alias=xamandroidsupportv4-18 HTTP/1.1
which returns "Object moved to here" where "here" is nowhere.
If you start Visual Studio after deleting the Cache and Components folder (next to the solution), Xamarin makes a call to
GET /api/download/xamandroidsupportv4-18/4.18.1 HTTP/1.0
which has a similar looking Object moved to, but this time it directs you to xamarin-components.s3.amazonaws.com/
GET /fdca922d2b77799fe208a08c9f3444fe/xamandroidsupportv4-18-4.18.1.xam HTTP/1.0
Perhaps something changed, or the available_versions API has changed.
Thanks very much for this question and your answers to it. I didn't really like the idea of storing an auth cookie on the build node or having to copy a cache there manually, so I came up with my own solution so I hacked around this problem with a quick Powershell script that mimics the behaviour of the xamarin-component.exe restore action:
param
(
[Parameter(Mandatory=$true)]
$authCookie,
[Parameter(Mandatory=$true)]
$componentDirectory,
[Parameter(Mandatory=$true)]
$project
)
[void]([System.Reflection.Assembly]::LoadWithPartialName('System.IO.Compression.FileSystem'))
$xml = [xml] $(cat $project);
$components = $xml.Project.ItemGroup.XamarinComponentReference | ? { $_.Include.Length -gt 0 } | % { $_.Include };
if (!(test-path $componentDirectory))
{
echo "$componentDirectory didn't exist, so it was created.";
[void](mkdir $componentDirectory);
}
foreach ($component in $components)
{
$source = "http://components.xamarin.com/download/$component";
$destination = "$componentDirectory\$component.zip";
if (test-path $destination)
{
echo "$destination already exists, skipping...";
continue;
}
echo "Downloading $component from $source to $destination...";
$client = New-Object System.Net.WebClient
$client.Headers.Add([System.Net.HttpRequestHeader]::Cookie, "XAM_AUTH=$authCookie");
try
{
$client.DownloadFile($source, $destination);
}
catch
{
# The error message will be on one of these lines hopefully:
write-error "Failed to download! Errors are below:";
write-error $_
write-error $_.Exception
write-error $_.Exception.InnerException
write-error $_.Exception.InnerException.InnerException
exit 1;
}
if (!(test-path $destination))
{
write-error "$destination doesn't exist - the download must have failed!";
exit 1;
}
echo "Decompressing $source to $componentDirectory"
[System.IO.Compression.ZipFile]::ExtractToDirectory($destination, $componentDirectory)
echo ""
}
echo "Done!";
The -authCookie parameter can be extracted from either the XAM_AUTH cookie in your browser or from the .xamarin-credentials "cookiejar" in your home directory. It's nice to have it parameterised like this so you can store it as a secret variable in TeamCity.
The componentDirectory parameter must be the full path to the component directory - it will be created if it doesn't exist.
The project parameter should be the path to your project that you want to restore packages for - if you have multiple projects that need this then you'll have to execute the script for each one. Don't specify your solution as it won't work.
Unfortunately, this isn't very resilient to Xamarin's whims - a simple API change could render this useless, so obviously the best solution is to wait for Xamarin to fix this. I e-mailed Xamarin support to complain about this problem but I don't imagine I'll get a timely response (they seem very very busy these days). I hope this is useful!
Create directory and put that directory path in environment variable XAMARIN_CACHEPATH
I have an assortment of PowerShell modules written in PowerShell (as opposed to C#) and I include documentation-comments in the code so that users get a full API description from Get-Help.
As I was writing a new module the help text seemed to get stuck at some point in time; any subsequent updates I have done to the help text in that file have not shown up after I saved the file, re-imported the module, or even restarted PowerShell then re-imported the module.
I next created a test module to see if I could replicate the issue. I set up psm1 and psd1 files, imported the module, and ran get-help, seeing the help from the psm1 file. I then added one line of text to the psm1 file, saved it, re-imported it... and the new line appeared in get-help!
I vaguely recall reading some time ago that you must bump the version in the psd1 file for new help to be recognized but my test case showed that is not necessarily needed (and I really don't want to have to bump the version).
I also vaguely recall reading that imported modules are cached somewhere and one could just delete the cached files to get it to recognize the new text--but I cannot recall where to find these.
So my goal is to be able to see the revised help text saved in the psm1 file in my real module without incrementing the module version. Ideas?
I was having similar issues when renaming and updating functions in some of my modules. A bit of searching turned up http://www.powertheshell.com/how-module-command-discovery-works-in-psv3/. In particular, the last bit about outdated caches mentions
PS> Get-Module -ListAvailable -Refresh
Running that solved my caching woes
PS> Get-Help Get-Module -Parameter Refresh
-Refresh [<SwitchParameter>]
Refreshes the cache of installed commands. The command cache is created when the session starts. It enables
the Get-Command cmdlet to get commands from modules that are not imported into the session.
This parameter is designed for development and testing scenarios in which the contents of modules have
changed since the session started.
When the Refresh parameter is used in a command, the ListAvailable parameter is required.
If you import a module that was already imported, it won't replace the functions that were previously imported. You need to remove the module first with Remove-Module, then import it again. I find it convenient to have this function in my profile:
function reload {
param(
[parameter(Mandatory=$true)]$Module
)
Write-Host;
try {
Remove-Module $Module -ea Stop;
} catch {
Write-Warning $error[0].Exception.Message;
Write-Host;
} finally {
Import-Module $Module -Verbose;
}
Write-Host;
}
Is there a command line switch to forcebuild cruisecontrol.net remotely. I am trying to avoid going to cctray and forcebuilding it manually every morning. It seems I have to create custom hook on the CruiseControl server by creating my own custom web service.
What about writing a Powershell Wrapper around ThoughtWorks.CruiseControl.Remote.dll? We do something very similar in a project we call CruiseHydra which emulates the ability to split multiple tasks across several build servers. I have attempted to extract the portions that should be relevant to you here. Please note that I have not tested this exact code, our library wraps this deep in its own abstraction, but the jist of it is here:
using ThoughtWorks.CruiseControl.Remote;
public ForceBuild(String ServerAddress, String projectToExecute)
{
RemoteCruiseManagerFactory rcmf = new RemoteCruiseManagerFactory();
ICruiseManager ccnetServer = rcmf.GetCruiseManager(ServerAddress);
ccnetServer.ForceBuild(projectToExecute,"Forced By Programatic Wrapper");
}
You can obviously change the second argument to ForceBuild to be the name of your task. It's whats shown under the 'Integration Request' section on the dashboard.
If you're building every morning, why not set up a schedule trigger instead?
UPDATE BASED ON NEW INFORMATION:
If your Power Shell script can be modified to modify an internally accessible web page (update a time stamp text in the HTML), then you can use the urlTrigger
There is a tool called CCCmd which is included in the CC.NET installer. This is a command-line interface that allows forcing a build remotely.
Run this in the same directory of the ccnet.config file
"C:\Program Files (x86)\CruiseControl.NET\server\ccnet.exe" -r off -p [Project Name]
I had a similar requirement - to trigger a project from Nant/C# code. With the help of fiddler found out what was happening when we click on 'Force Build' on the Project's web dashboard.
You can send this URL to the build server. Do note the parameters in URL"ForceBuild=Force".
http://your-build-server/ccnet/server/local/project/your-project-name/ViewProjectReport.aspx?ForceBuild=Force
The "local" in the URL could vary depending on your configuration. For that, first try to fetch project report from CCTray and see what is the URL of your Cruise Control.NET project. Based on the URL modify it to trigger the project.
Good luck!
What about splitting the problem? Set up a new CCNET project that has a PowerShell task and a ForceBuild publisher which triggers the original project:
<cruisecontrol>
<project name="OriginalProject">
<!-- ... -->
</project name="NewProject">
<project>
<tasks>
<powershell>
<script>CreateDatabase.ps</script>
<!-- ... -->
</powershell>
</tasks>
<publishers>
<forcebuild>
<project>OriginalProject</project>
</forcebuild>
</publishers>
</project>
</cruisecontrol>
In case you want to run the original project only if powershell task went through without any errors just move the forcebuild block from the publishers to the tasks section.
You can trigger directly by submitting a HTTP post. No need to create a separate URL or URL trigger. If Powershell is an option, this works for us (note that our builds have parameters which ccnet prefixes with "param_" in the post variable names, you can omit or tailor the parameters with this prefix for your needs):
function Build-CCNetProject {
param(
[string] $hostname,
[string] $server,
[string] $username,
[string] $password,
[string] $project,
[string] $param_environment,
[string] $param_build_version,
[string] $param_request_id
)
$securePassword = ConvertTo-SecureString "$password" -AsPlainText -Force
$credential = New-Object System.Management.Automation.PSCredential ($username, $securePassword)
$postParams = #{projectName="$project";serverName="$server";ForceBuild='Force';param_environment="$param_environment";param_build_version="$param_build_version";param_request_id="param_request_id";submit='Build'}
$postUrl = "http://{0}/ccnet/server/{1}/project/{2}/ViewProjectReport.aspx" -f $hostname, $server, $project
Invoke-WebRequest -Uri $postUrl -Method POST -Body $postParams -Credential $credential
}
# Usage:
Build-CCNetProject -hostname "teamcity" -server "somehost" -username "foo\bar" -password "baz" -project "awesome-app" -param_environment "uat" -param_build_version "1.0.1.123" -param_request_id "1"