Cake - API - GitAliases.GitDescribe(ICakeContext, DirectoryPath, GitDescribeStrategy) Method

GitAliases.

GitDescribe(ICakeContext, DirectoryPath, GitDescribeStrategy) Method

Summary

Describe current branch.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Containing Type
GitAliases

Syntax

public static string GitDescribe(this ICakeContext context, DirectoryPath repositoryDirectoryPath, GitDescribeStrategy strategy)

Examples

var result = GitDescribe(".", GitDescribeStrategy.Tags);

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
repositoryDirectoryPath DirectoryPath Path to repository.
strategy GitDescribeStrategy Describing strategy.

Return Value

Type Description
string Described commit using the most recent tag reachable from it.