Badges Class

Summary

A container for badges that you want to show on the readme
Assembly
Rocket.Surgery.Nuke.dll
Namespace
Rocket.Surgery.Nuke.Readme
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IReadmeSection"] click Interface0 "/api/Rocket.Surgery.Nuke.Readme/IReadmeSection" Type["Badges"] class Type type-node

Syntax

public class Badges : IReadmeSection

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
Badges()

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
Add(IBadgeSection) Badges
Adds a new Badge section
Process(IDictionary<string, object>, IMarkdownReferences, IRocketBoosterBuild) string
Returns the markdown that will produce the badge

Extension Methods

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