Skip to content

nuspec.html

Tunisiano18 edited this page Sep 13, 2020 · 8 revisions

The full idea is to create a template with everything in it, and remove what's stil empty, in an automated way.

here are the template explainations : https://github.com/chocolatey/choco/wiki/How-To-Create-Custom-Package-Templates#example

The template generator : https://github.com/chocolatey/choco/tree/master/src/chocolatey/infrastructure.app/templates

Here is the default template : https://github.com/ferventcoder/chocolatey-packages/blob/master/manual/default.template/templates/default.nuspec.template

and this package can be used to check nuspec : https://chocolatey.org/packages/choco-nuspec-checker

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
  <metadata>
    <id>Automatic</id>
    <title>MANUAL</title>
    <version>Automatic</version>
    <authors>STATIC</authors>
    <owners>Automatic</owners>
    <summary>MANUAL</summary>
    <description>Automatically generated from README.md</description>
    <packageSourceUrl>Automatic</packageSourceUrl>

    <projectUrl>MANUAL</projectUrl>
    <projectSourceUrl>MANUAL</projectSourceUrl>
    <bugTrackerUrl>MANUAL</bugTrackerUrl>
    <docsUrl>MANUAL</docsUrl>
    <mailingListUrl>MANUAL</mailingListUrl>
<!-- if freeware and no other URL available should be https://wikipedia.org/wiki/Freeware -->
    <licenseUrl>MANUAL</licenseUrl>
    <tags>Manual</tags>
<!-- when should this be true? -->
    <requireLicenseAcceptance>false</requireLicenseAcceptance>

<!-- some way to automate this value? 
       URL must include commit or icon cannot change 
       could consolidate all current package icons -->
    <iconUrl>Automatc, the png needs to be in the icons folder</iconUrl>

<!-- typically just append <authors> element after © symbol -->
    <copyright>© </copyright>
    <releaseNotes>
#### Program
* [News]()
* [Release log]()
* [Roadmap]()
* [Changelog]()

#### System requirements
* Download file name: **{url:basefile}.{url:ext}**
* Download file size: **{filesize:formatfilesize}**
* Default install name: **{???}**
* Default Install size: **{???}**

#### Package
* __Automatically built__: if this package's version is out of date by more than a day of the program's version, please [notify the maintainer](https://chocolatey.org/packages/{{PackageName}}/ContactOwners)
* Uploaded by [{{MaintainerName}}](https://chocolatey.org/profiles/{{MaintainerName}})
* Program release date: {f:yyyy}{f:MM}{f:dd}-{f:HH}{f:mm}
* Package release date: {f:yyyy}{f:MM}{f:dd}-{f:HH}{f:mm}
* Package lag time: 
    </releaseNotes>

<!-- no defined syntax yet -->
    <!--<provides>{{PackageName}}</provides>-->
    <!--<replaces></replaces>-->
    <!--<conflicts></conflicts>-->

<!-- metapackage -->
    <dependencies>
      <dependency id="{{PackageName}}.install" version="[{{PackageVersion}}]" />
    </dependencies>

<!-- other program dependency: 3.0 > keepass ≥ 2.09 -->
    <dependencies>
      <dependency id="keepass" version="[2.09, 3.0)" />
    </dependencies>
  </metadata>
  <files>
    <file src="tools\**" target="tools" />
  </files>
</package>

README.md Tags

A blog post refering : https://chocolatey.org/blog/extending-chocolatey-packaging-at-walmart

Clone this wiki locally