Skip to content

Commit

Permalink
Merge branch 'pr538' into stable
Browse files Browse the repository at this point in the history 
* pr538:
  (GH-535) Clean up the nuspec / document it all
  (GH-535) Update NuspecTemplate.cs

Fixes #535
Closes #538
  • Loading branch information
@ferventcoder
ferventcoder committed Jan 28, 2016
2 parents 4cbd7ac + 50d165a commit 7a53dac
Showing 1 changed file with 58 additions and 19 deletions.
77 changes: 58 additions & 19 deletions src/chocolatey/infrastructure.app/templates/NuspecTemplate.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,77 @@ public class NuspecTemplate
{
public static string Template =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<!-- Read this before creating packages: https://github.com/chocolatey/chocolatey/wiki/CreatePackages -->
<!-- It is especially important to read the above link to understand additional requirements when publishing packages to the community feed aka dot org (https://chocolatey.org/packages). -->
<!-- Test your packages in a test environment: https://github.com/chocolatey/chocolatey-test-environment -->
<!--
This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Reference. Chocolatey uses a special version of NuGet.Core that allows us to do more than was initially possible. As such there are certain things to be aware of:
* the package xmlns schema url may cause issues with nuget.exe
* Any of the following elements can ONLY be used by choco tools - projectSourceUrl, docsUrl, mailingListUrl, bugTrackerUrl, packageSourceUrl, provides, conflicts, replaces
* nuget.exe can still install packages with those elements but they are ignored. Any authoring tools or commands will error on those elements
-->
<!-- You can embed software files directly into packages, as long as you are not bound by distribution rights. -->
<!-- * If you are an organization making private packages, you probably have no issues here -->
<!-- * If you are releasing to the community feed, you need to consider distribution rights. -->
<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
<package xmlns=""http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd"">
<metadata>
<!-- Read this before publishing packages to chocolatey.org: https://github.com/chocolatey/chocolatey/wiki/CreatePackages -->
<!-- == PACKAGE SPECIFIC SECTION == -->
<!-- This section is about this package, although id and version have ties back to the software -->
<!-- id is lowercase and if you want a good separator for words, use '-', not '.'. Dots are only acceptable as suffixes for certain types of packages, e.g. .install, .portable, .extension, .template -->
<!-- If the software is cross-platform, attempt to use the same id as the debian/rpm package(s) if possible. -->
<id>[[PackageNameLower]]</id>
<title>[[PackageName]] (Install)</title>
<!-- version should MATCH as closely as possible with the underlying software -->
<!-- Is the version a prerelease of a version? https://docs.nuget.org/create/versioning#creating-prerelease-packages -->
<!-- Note that unstable versions like 0.0.1 can be considered a released version, but it's possible that one can release a 0.0.1-beta before you release a 0.0.1 version. If the version number is final, that is considered a released version and not a prerelease. -->
<version>[[PackageVersion]]</version>
<!-- <packageSourceUrl>Where is this Chocolatey package located (think GitHub)? packageSourceUrl is highly recommended for the community feed</packageSourceUrl>-->
<!-- owners is a poor name for maintainers of the package. It sticks around by this name for compatibility reasons. It basically means you. -->
<!--<owners>[[MaintainerName]]</owners>-->
<!-- ============================== -->
<!-- == SOFTWARE SPECIFIC SECTION == -->
<!-- This section is about the software itself -->
<title>[[PackageName]] (Install)</title>
<authors>__REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__</authors>
<owners>[[MaintainerName]]</owners>
<!-- projectUrl is required for the community feed -->
<projectUrl>https://_Software_Location_REMOVE_OR_FILL_OUT_</projectUrl>
<!--<iconUrl>http://cdn.rawgit.com/[[MaintainerRepo]]/master/icons/[[PackageNameLower]].png</iconUrl>-->
<!-- <copyright>Year Software Vendor</copyright> -->
<!-- If there is a license Url available, it is is required for the community feed -->
<!-- <licenseUrl>Software License Location __REMOVE_OR_FILL_OUT__</licenseUrl>
<requireLicenseAcceptance>true</requireLicenseAcceptance>-->
<!--<projectSourceUrl>Software Source Location - is the software FOSS somewhere? Link to it with this</projectSourceUrl>-->
<!--<docsUrl>At what url are the software docs located?</docsUrl>-->
<!--<mailingListUrl></mailingListUrl>-->
<!--<bugTrackerUrl></bugTrackerUrl>-->
<summary>__REPLACE__</summary>
<description>__REPLACE__MarkDown_Okay [[AutomaticPackageNotesNuspec]]
</description>
<projectUrl></projectUrl>
<packageSourceUrl></packageSourceUrl>
<!--<projectSourceUrl></projectSourceUrl>
<docsUrl></docsUrl>
<mailingListUrl></mailingListUrl>
<bugTrackerUrl></bugTrackerUrl>-->
<tags>[[PackageNameLower]] admin SPACE_SEPARATED</tags>
<copyright></copyright>
<licenseUrl></licenseUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<!--<iconUrl>http://cdn.rawgit.com/[[MaintainerRepo]]/master/icons/[[PackageNameLower]].png</iconUrl>-->
<description>__REPLACE__MarkDown_Okay [[AutomaticPackageNotesNuspec]]</description>
<!-- <releaseNotes>__REPLACE_OR_REMOVE__MarkDown_Okay</releaseNotes> -->
<!-- =============================== -->
<!-- Specifying dependencies and version ranges? https://docs.nuget.org/create/versioning#specifying-version-ranges-in-.nuspec-files -->
<!--<dependencies>
<dependency id="""" version=""__VERSION__"" />
<dependency id="""" version=""__MINIMUM_VERSION__"" />
<dependency id="""" version=""[__EXACT_VERSION__]"" />
<dependency id="""" version=""[_MIN_VERSION_INCLUSIVE, MAX_VERSION_INCLUSIVE]"" />
<dependency id="""" version=""[_MIN_VERSION_INCLUSIVE, MAX_VERSION_EXCLUSIVE)"" />
<dependency id="""" />
</dependencies>-->
<releaseNotes>__REPLACE_OR_REMOVE__MarkDown_Okay</releaseNotes>
<!--<provides></provides>-->
<!--<provides>NOT YET IMPLEMENTED</provides>-->
<!--<conflicts>NOT YET IMPLEMENTED</conflicts>-->
<!--<replaces>NOT YET IMPLEMENTED</replaces>-->
</metadata>
<files>
<!-- this section controls what actually gets packaged into the Chocolatey package -->
<file src=""tools\**"" target=""tools"" />
<!--Building from Linux? You may need this instead: <file src=""tools/**"" target=""tools"" />-->
</files>
</package>
";
Expand All @@ -64,4 +103,4 @@ public class NuspecTemplate
let them know the package is no longer updating correctly.
";
}
}
}

0 comments on commit 7a53dac

Please sign in to comment.