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

AssemblyInfoFile

Nested types and modules

TypeDescription
Attribute

Functions and values

Function or valueDescription
AssemblyInfoFile.create(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig option -> unit

Creates an AssemblyInfo file based in the correct langugage based on the file name with the given attributes and configuration. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createCppCli(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> unit

Creates a C++/CLI AssemblyInfo file with the given attributes.

AssemblyInfoFile.createCppCliWithConfig(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit

Creates a C++/CLI AssemblyInfo file with the given attributes and configuration. Does not generate an AssemblyVersionInformation class.

AssemblyInfoFile.createCSharp(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> unit

Creates a C# AssemblyInfo file with the given attributes. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createCSharpWithConfig(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit

Creates a C# AssemblyInfo file with the given attributes and configuration. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createFSharp(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> unit

Creates a F# AssemblyInfo file with the given attributes. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createFSharpWithConfig(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit

Creates a F# AssemblyInfo file with the given attributes and configuration. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createVisualBasic(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> unit

Creates a VB AssemblyInfo file with the given attributes. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.createVisualBasicWithConfig(...)
Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit

Creates a VB AssemblyInfo file with the given attributes and configuration. The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

AssemblyInfoFile.getAttribute(...)
Signature: attrName:string -> assemblyInfoFile:string -> Attribute option

Read a single attribute from an AssemblyInfo file.

Parameters

  • attrName - Name of the attribute without "Attribute" at the end.
  • assemblyInfoFile - The file to read from. Language C#, F#, VB or C++ is determined from the extension.
AssemblyInfoFile.getAttributes(...)
Signature: assemblyInfoFile:string -> seq<Attribute>

Read attributes from an AssemblyInfo file and return as a sequence of Attribute.

Parameters

  • assemblyInfoFile - The file to read attributes from. Language C#, F#, VB or C++ is determined from the extension.
AssemblyInfoFile.getAttributeValue(...)
Signature: attrName:string -> assemblyInfoFile:string -> string option

Read the value of a single attribute from an AssemblyInfo file. Note that string values are returned with surrounding "".

Parameters

  • attrName - Name of the attribute without "Attribute" at the end.
  • assemblyInfoFile - The file to read from. Language C#, F#, VB or C++ is determined from the extension.
AssemblyInfoFile.updateAttributes(...)
Signature: assemblyInfoFile:string -> attributes:seq<Attribute> -> unit

Update a set of attributes in an AssemblyInfo file. Fails if any attribute is not found.

Parameters

  • assemblyInfoFile - The file to update. Language C#, F#, VB or C++ is determined from the extension.
  • attributes - The Attributes that should be updated matched on Name (Namespace is not used).