YamlAliases Class

Summary

YAML related cake aliases.

In order to use aliases from this addin, you will need to also reference YamlDotNet as an addin. Here is what including Cake.Yaml in your script should look like:

#addin nuget:?package=Cake.Yaml&version=x.y.z
#addin nuget:?package=YamlDotNet&version=11.2.1

Assembly
Cake.Yaml.dll
Namespace
Cake.Yaml
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["YamlAliases"] class Type type-node

Syntax

public static class YamlAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DeserializeYaml<T>(ICakeContext, string, DeserializeYamlSettings) T
Deserializes the YAML from a string.
static
DeserializeYaml<T>(ICakeContext, string) T
Deserializes the YAML from a string.
static
DeserializeYamlFromFile<T>(ICakeContext, FilePath, DeserializeYamlSettings) T
Deserializes the YAML from a file.
static
DeserializeYamlFromFile<T>(ICakeContext, FilePath) T
Deserializes the YAML from a file.
static
SerializeYaml<T>(ICakeContext, T, SerializeYamlSettings) string
Serializes an object to a YAML string.
static
SerializeYaml<T>(ICakeContext, T) string
Serializes an object to a YAML string.
static
SerializeYamlToFile<T>(ICakeContext, FilePath, T, SerializeYamlSettings) void
Serializes an object to a YAML file.
static
SerializeYamlToFile<T>(ICakeContext, FilePath, T) void
Serializes an object to a YAML file.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin