Skip to content

Commit 7306e7e

Browse files
author
Chris Crutchfield
committed
more docs
1 parent 59797df commit 7306e7e

File tree

4 files changed

+64
-1
lines changed

4 files changed

+64
-1
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# GitVersioningAliases Class
2+
> Contains functionality for using Nerdbank.GitVersioning.
3+
4+
**Namespace:** Cake.GitVersioning
5+
6+
**Assembly:** Cake.GitVersioning (in Cake.GitVersioning.dll)
7+
## Inheritance Hierarchy
8+
        System.Object
9+
10+
                Cake.GitVersioning.GitVersioningAliases
11+
12+
## Syntax
13+
~~~~csharp
14+
[Cake.Core.Annotations.CakeAliasCategory("Git Versioning")]
15+
public static class GitVersioningAliases
16+
~~~~
17+
## Methods
18+
|Name|Description|
19+
|---|---|
20+
|[GitVersioningGetVersion(ICakeContext, String)](/doc/Cake/GitVersioning/GitVersioningAliases/Methods/GitVersioningGetVersion_ICakeContext%2c%20String_.md)|Gets the Git Versioning version from the current repo.|
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GitVersioningAliases.GitVersioningGetVersion(ICakeContext, String) Method
2+
> Gets the Git Versioning version from the current repo.
3+
4+
**Namespace:** Cake.GitVersioning
5+
6+
**Assembly:** Cake.GitVersioning (in Cake.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
[Cake.Core.Annotations.CakeMethodAlias]
10+
public static Nerdbank.GitVersioning.VersionOracle GitVersioningGetVersion(this Cake.Core.ICakeContext context, string projectDirectory = ".");
11+
~~~~
12+
##### Parameters
13+
*context*
14+
15+
            Type: ICakeContext
16+
17+
            The context.
18+
19+
20+
*projectDirectory*
21+
22+
            Type: String
23+
24+
            Directory to start the search for version.json.
25+
26+
27+
##### Return Value
28+
Type: VersionOracle
29+
30+
The version information from Git Versioning.
31+

readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ You can install Nerdbank.GitVersioning into your projects via NuGet or NPM.
2828
* Use the [nbgv .NET Core CLI tool](doc/nbgv-cli.md) (recommended)
2929
* [NuGet installation instructions](doc/nuget-acquisition.md)
3030
* [NPM installation instructions](doc/npm-acquisition.md)
31+
* [Cake Build installation instructions](doc/cake.md)
3132

3233
You must also create [a version.json file](doc/versionJson.md) in your repo. See [migration notes](doc/migrating.md) if your repo already has a version.txt or version.json file from using another system.
3334

@@ -49,6 +50,7 @@ for these build systems:
4950
* [gulp](doc/gulp.md)
5051
* [DNX](doc/dotnet-cli.md)
5152
* [dotnet CLI](doc/dotnet-cli.md)
53+
* [Cake Build](doc/cake.md)
5254

5355
Also some special [cloud build considerations](doc/cloudbuild.md).
5456

src/Cake.GitVersioning/Cake.GitVersioning.csproj

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
44
<TargetFramework>net461</TargetFramework>
@@ -12,10 +12,20 @@
1212
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
1313
<PackageProjectUrl>http://github.com/aarnott/Nerdbank.GitVersioning</PackageProjectUrl>
1414
<SignAssembly>false</SignAssembly>
15+
<DocumentationRootFolder>..\..\doc</DocumentationRootFolder>
16+
</PropertyGroup>
17+
18+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
19+
<DocumentationFile>C:\git\Nerdbank.GitVersioning\src\..\bin\Cake.GitVersioning\Debug\net461\Cake.GitVersioning.xml</DocumentationFile>
20+
</PropertyGroup>
21+
22+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
23+
<DocumentationFile>C:\git\Nerdbank.GitVersioning\src\..\bin\Cake.GitVersioning\Release\net461\Cake.GitVersioning.xml</DocumentationFile>
1524
</PropertyGroup>
1625

1726
<ItemGroup>
1827
<PackageReference Include="Cake.Core" Version="0.26.0" />
28+
<PackageReference Include="DotNetMDDocs" Version="0.5.0" />
1929
<PackageReference Include="Nerdbank.GitVersioning.LKG" Version="1.6.20-beta-gfea83a8c9e" />
2030
</ItemGroup>
2131

0 commit comments

Comments
 (0)