Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

PaketTemplateParams

Contains the different parameters to create a paket.template file

Record Fields

Record FieldDescription
Authors
Signature: string list

a list of authors for the nuget package. If omitted, paketwill use reflection to obtain the value of the AssemblyCompanyAttribute.

Copyright
Signature: string option

the copyright information

Dependencies
Signature: PaketDependency list

A list of dependencies to other packages

Description
Signature: string list

The package description If omitted, paket will use reflection to obtain the value of the AssemblyDescriptionAttribute.

DevelopmentDependency
Signature: bool option

If set to true this will tell nuget/paket that this is a development dependency

ExcludedDependencies
Signature: string list

A list of excluded dependencies

Files
Signature: PaketFileInfo list

The included or excluded files (use this if the TemplateType is File)

FrameworkAssemblies
Signature: string list

A list of referenced framework assemblies if omitted all used Framework assemblies will be used by paket

IconUrl
Signature: string option

URL to an icon

Id
Signature: string option

The NuGet Package ID If omitted, paket will use reflection to determine the assembly name.

IncludePDBs
Signature: bool option

With the IncludePDBs switch you can tell paket to pack pdbs into the package. this only works for paket.template files of type 'Project'.

Language
Signature: string option

The package language

LicenseUrl
Signature: string option

URL to the license of the package

Owners
Signature: string list

A list of package owners

ProjectUrl
Signature: string option

URL to the where the project of the package is hosted

References
Signature: string list

A list of references

ReleaseNotes
Signature: string list

the release notes (line by line)

RequireLicenseAcceptance
Signature: bool option

If set to true this will tell nuget/paket to prompt the user for the acceptance of the provided license

Summary
Signature: string list

a short summary (line by line)

Tags
Signature: string list

a list of tags

TemplateFilePath
Signature: string option

The file path to the paket.template file if omitted, a paket.template file will be created in the current directory

TemplateType
Signature: PaketTemplateType

The type of the template (File or Project)

Title
Signature: string option

The title of the package If omitted, paket will use reflection to obtain the value of the AssemblyTitleAttribute.

Version
Signature: string option

The package version. If omitted, paket will use reflection to obtain the value of the AssemblyInformationalVersionAttribute or if that is missing the AssemblyVersionAttribute.