Cake - API - GitAliases.GitRemove(ICakeContext, DirectoryPath, bool, FilePath[]) Method

GitAliases.

GitRemove(ICakeContext, DirectoryPath, bool, FilePath[]) Method

Summary

Remove file(s) from index.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Containing Type
GitAliases

Syntax

public static void GitRemove(this ICakeContext context, DirectoryPath repositoryDirectoryPath, bool removeFromWorkingDirectory, params FilePath[] filePaths)

Examples

var filePaths = new FilePath[] { ".\\test.txt" };
GitRemove("c:/temp/cake", true, filePaths);

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
repositoryDirectoryPath DirectoryPath Path to repository.
removeFromWorkingDirectory bool True to remove the files from the working directory, False otherwise.
filePaths FilePath[] Path to file(s) to remove.

Return Value

Type Description
void