More-On-Rules.md

More On Rules

Every Rule must have a name attribute which specifies its name in the source. For example, having

<Import>System.Reflection</Import>
<Rule name="AssemblyVersion">5.30</Rule>

In your WriterRules will generate

using System.Reflection;

[assembly: AssemblyVersion(@"5.30")]

in RelaxVersioner.cs, assuming you're building a C# project. Don't worry about the @ sign; it's specific to C# / F# and just tells the compiler to ignore any otherwise special characters in a string.

A Rule element may also have a key attribute, but that's just for making your own custom meta-data:

<Import>System.Reflection</Import>
<Rule name="AssemblyMetadata" key="Branch">Nacho Libre</Rule>
<Rule name="AssemblyMetadata" key="Committer">Jack Black</Rule>
<Rule name="AssemblyMetadata" key="Message">Change song to Encarnación</Rule>

using System.Reflection;

[assembly: AssemblyMetadata(@"Branch",@"Nacho Libre")]
[assembly: AssemblyMetadata(@"Committer",@"Jack Black")]
[assembly: AssemblyMetadata(@"Message",@"Change song to Encarnación")]

There is no such thing as AssemblyMetadata in the .NET Framework 3.5 or above, so RelaxVersioner will generate the necessary code in the source file.

Key Values

On top of all of this, Rules can also have certain key values as part of their value. For example, in <Rule name="AssemblyMetadata">{committer}</Rule>, the value {committer} will be replaced with the author of the last commit. This kind of magic is the result of Naming Formatter and libgit2sharp.

Documentation on all of the different key values is currently a work in progress.