Skip to content

Commit

Permalink
Update MinVerAliases usage examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@augustoproiete
augustoproiete committed Nov 27, 2020
1 parent 174bf20 commit 0f965c8
Showing 1 changed file with 121 additions and 50 deletions.
171 changes: 121 additions & 50 deletions src/Cake.MinVer/MinVerAliases.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,15 @@ public static class MinVerAliases
/// <example>
/// <code>
/// <![CDATA[
/// MinVer();
/// var buildVersion = MinVer();
///
/// Information($"Version: {buildVersion.Version}");
/// Information($"Major: {buildVersion.Major}");
/// Information($"Minor: {buildVersion.Minor}");
/// Information($"Patch: {buildVersion.Patch}");
/// Information($"PreRelease: {buildVersion.PreRelease}");
/// Information($"BuildMetadata: {buildVersion.BuildMetadata}");
/// // ...
/// ]]>
/// </code>
/// </example>
Expand All @@ -43,43 +51,73 @@ public static MinVerVersion MinVer(this ICakeContext context)
/// <para>Increment the major version (e.g. 'dotnet minver --auto-increment major')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithAutoIncrement(MinVerAutoIncrement.Major));
/// var buildVersion = MinVer(settings => settings.WithAutoIncrement(MinVerAutoIncrement.Major));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the build metadata (e.g. 'dotnet minver --build-metadata abcdefg')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithBuildMetadata("abcdefg"));
/// var buildVersion = MinVer(settings => settings.WithBuildMetadata("abcdefg"));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the default pre-release phase (e.g. 'dotnet minver --default-pre-release-phase preview')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithDefaultPreReleasePhase("preview"));
/// var buildVersion = MinVer(settings => settings.WithDefaultPreReleasePhase("preview"));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the minimum major and minor version (e.g. 'dotnet minver --minimum-major-minor 2.5')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithMinimumMajorMinor("2.5"));
/// var buildVersion = MinVer(settings => settings.WithMinimumMajorMinor("2.5"));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the working directory for MinVer to use (e.g. 'dotnet minver --repo C:\MyProject')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithRepo(@"C:\MyProject"));
/// var buildVersion = MinVer(settings => settings.WithRepo(@"C:\MyProject"));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the tag prefix (e.g. 'dotnet minver --tag-prefix v')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithTagPrefix("v"));
/// var buildVersion = MinVer(settings => settings.WithTagPrefix("v"));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Run MinVer as a global tool (e.g. 'minver'), instead of local tool (e.g. 'dotnet minver')</para>
/// <code>
/// <![CDATA[
/// var buildVersion = MinVer(settings => settings.WithPreferGlobalTool());
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Disable the automatic fallback to global tool (or local tool) in case of errors</para>
/// <code>
/// <![CDATA[
/// var buildVersion = MinVer(settings => settings.WithNoFallback());
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the verbosity (e.g. 'dotnet minver --verbosity trace')</para>
/// <code>
/// <![CDATA[
/// MinVer(settings => settings.WithVerbosity(MinVerVerbosity.Trace));
/// var buildVersion = MinVer(settings => settings.WithVerbosity(MinVerVerbosity.Trace));
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// </example>
Expand Down Expand Up @@ -111,85 +149,118 @@ public static MinVerVersion MinVer(this ICakeContext context, Action<MinVerSetti
/// <para>Increment the major version (e.g. 'dotnet minver --auto-increment major')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// AutoIncrement = MinVerAutoIncrement.Major,
/// };
/// var settings = new MinVerSettings
/// {
/// AutoIncrement = MinVerAutoIncrement.Major,
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the build metadata (e.g. 'dotnet minver --build-metadata abcdefg')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// BuildMetadata = "abcdefg",
/// };
/// var settings = new MinVerSettings
/// {
/// BuildMetadata = "abcdefg",
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the default pre-release phase (e.g. 'dotnet minver --default-pre-release-phase preview')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// DefaultPreReleasePhase = "preview",
/// };
/// var settings = new MinVerSettings
/// {
/// DefaultPreReleasePhase = "preview",
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the minimum major and minor version (e.g. 'dotnet minver --minimum-major-minor 2.5')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// MinimumMajorMinor = "2.5",
/// };
/// var settings = new MinVerSettings
/// {
/// MinimumMajorMinor = "2.5",
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the working directory for MinVer to use (e.g. 'dotnet minver --repo C:\MyProject')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// Repo = @"C:\MyProject",
/// };
/// var settings = new MinVerSettings
/// {
/// Repo = @"C:\MyProject",
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the tag prefix (e.g. 'dotnet minver --tag-prefix v')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// TagPrefix = "v",
/// };
/// var settings = new MinVerSettings
/// {
/// TagPrefix = "v",
/// };
///
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Run MinVer as a global tool (e.g. 'minver'), instead of local tool (e.g. 'dotnet minver')</para>
/// <code>
/// <![CDATA[
/// var settings = new MinVerSettings
/// {
/// PreferGlobalTool = true,
/// };
///
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Disable the automatic fallback to global tool (or local tool) in case of errors</para>
/// <code>
/// <![CDATA[
/// var settings = new MinVerSettings
/// {
/// NoFallback = true,
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// <para>Set the verbosity (e.g. 'dotnet minver --verbosity trace')</para>
/// <code>
/// <![CDATA[
/// var settings =
/// new MinVerSettings
/// {
/// Verbosity = MinVerVerbosity.Trace,
/// };
/// var settings = new MinVerSettings
/// {
/// Verbosity = MinVerVerbosity.Trace,
/// };
///
/// MinVer(settings);
/// var buildVersion = MinVer(settings);
/// Information($"Version: {buildVersion.Version}");
/// // ...
/// ]]>
/// </code>
/// </example>
Expand Down

0 comments on commit 0f965c8

Please sign in to comment.