IReadmeSection Interface

Summary

Interface is used to add a custom section that will be replaced in the readme with markdown content
Assembly
Rocket.Surgery.Nuke.dll
Namespace
Rocket.Surgery.Nuke.Readme
Implementing Types
graph BT Type["IReadmeSection"] class Type type-node Implementing0["Histories"]-.->Type click Implementing0 "/api/Rocket.Surgery.Nuke.Readme/Histories" Implementing1["Badges"]-.->Type click Implementing1 "/api/Rocket.Surgery.Nuke.Readme/Badges" Implementing2["References"]-.->Type click Implementing2 "/api/Rocket.Surgery.Nuke.Readme/References"

Syntax

public interface IReadmeSection

Attributes

Type Description
NullableContextAttribute

Properties

Name Value Summary
ConfigKey string
The configuration key, if you expect to get configuration from the yaml block.
Name string
The name of the section

Methods

Name Value Summary
Process(IDictionary<string, object>, IMarkdownReferences, IRocketBoosterBuild) string
Returns the markdown that will produce the badge

Extension Methods

Name Value Summary
SetBackingValue<IReadmeSection, TV>(Expression<Func<IReadmeSection, TV>>, TV) T
Sets the backing value.
With<IReadmeSection, TKey, TField>(Dictionary<TKey, TField>, IDictionary<TKey, TField>) TBuilder
Adds the specified dictionary to the provided dictionary.