GitAliases Class

Summary

Contains functionality for working with GIT using LibGit2 & LibGit2Sharp. NOTE: The addin currently only runs on x64 processors. ARM processors are not supported.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitAliases"] class Type type-node

Syntax

public static class GitAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
GitAdd(ICakeContext, DirectoryPath, FilePath[]) void
Add file to index.
static
GitAddAll(ICakeContext, DirectoryPath) void
Add all file changes to index.
static
GitBranchCurrent(ICakeContext, DirectoryPath) GitBranch
Gets the current branch.
static
GitBranches(ICakeContext, DirectoryPath) ICollection<GitBranch>
Gets a list of all branches from the repository.
static
GitCheckout(ICakeContext, DirectoryPath, FilePath[]) void
Checkout file.
static
GitCheckout(ICakeContext, DirectoryPath, string, FilePath[]) void
Checkout file(s) using supplied commit or branch spec.
static
GitClean(ICakeContext, DirectoryPath) void
Remove untracked file(s) workspace.
static
GitClone(ICakeContext, string, DirectoryPath, GitCloneSettings) DirectoryPath
Clone unauthenticated using specific settings.
static
GitClone(ICakeContext, string, DirectoryPath, string, string, GitCloneSettings) DirectoryPath
Clone authenticated using specific settings.
static
GitClone(ICakeContext, string, DirectoryPath, string, string) DirectoryPath
Clone authenticated using default options.
static
GitClone(ICakeContext, string, DirectoryPath) DirectoryPath
Clone unauthenticated using default options.
static
GitCommit(ICakeContext, DirectoryPath, string, string, string) GitCommit
Commit using default options.
static
GitConfigExists<T>(ICakeContext, DirectoryPath, string) bool
Returns whether a configuration value exists with the specifed key.
static
GitConfigGet<T>(ICakeContext, DirectoryPath, string, T) T
Gets the specified configuration value. If the specified value is not found it will return the specified default value.
static
GitConfigGet<T>(ICakeContext, DirectoryPath, string) T
Gets the specified configuration value.
static
GitConfigSetLocal<T>(ICakeContext, DirectoryPath, string, T) void
Gets the specified configuration value. If the specified value is not found it will return the specified default value.
static
GitConfigUnsetLocal(ICakeContext, DirectoryPath, string) void
Unsets the specified local configuration key.
static
GitCreateBranch(ICakeContext, DirectoryPath, string, bool) GitBranch
Creates a local Branch.
static
GitDescribe(ICakeContext, DirectoryPath, bool, GitDescribeStrategy, Nullable<int>) string
Describe current branch.
static
GitDescribe(ICakeContext, DirectoryPath, bool, GitDescribeStrategy) string
Describe current branch.
static
GitDescribe(ICakeContext, DirectoryPath, GitDescribeStrategy) string
Describe current branch.
static
GitDescribe(ICakeContext, DirectoryPath, string, bool, GitDescribeStrategy, Nullable<int>) string
Describe specified commit-ish.
static
GitDescribe(ICakeContext, DirectoryPath) string
Describe current branch.
static
GitDiff(ICakeContext, DirectoryPath, string, string) ICollection<GitDiffFile>
Get changed files from certain commit id up to current.
static
GitDiff(ICakeContext, DirectoryPath, string) ICollection<GitDiffFile>
Get changed files from certain commit id up to current.
static
GitDiff(ICakeContext, DirectoryPath) ICollection<GitDiffFile>
Get changed files from inital commit id up to current.
static
GitFetch(ICakeContext, DirectoryPath, GitFetchSettings) void
Download from another repository.
static
GitFetch(ICakeContext, DirectoryPath, string) void
Download objects and refs from another repository.
static
GitFetchTags(ICakeContext, DirectoryPath, string) void
Download tags from another repository.
static
GitFindRootFromPath(ICakeContext, DirectoryPath) DirectoryPath
Finding git root path from subtree.
static
GitHasStagedChanges(ICakeContext, DirectoryPath) bool
Checks if a repository contains staged changes.
static
GitHasUncommitedChanges(ICakeContext, DirectoryPath) bool
Checks if a repository contains uncommited changes.
static
GitHasUntrackedFiles(ICakeContext, DirectoryPath) bool
Checks if a repository contains untracked files.
static
GitInit(ICakeContext, DirectoryPath) DirectoryPath
Init using default options.
static
GitIsValidRepository(ICakeContext, DirectoryPath) bool
Checks if a specific directory is a valid Git repository.
static
GitLog(ICakeContext, DirectoryPath, int) ICollection<GitCommit>
Get commit log.
static
GitLog(ICakeContext, DirectoryPath, string) ICollection<GitCommit>
Get commit from certain commit id up to current.
static
GitLogLookup(ICakeContext, DirectoryPath, string) GitCommit
Get specific commit.
static
GitLogTag(ICakeContext, DirectoryPath, string) ICollection<GitCommit>
Get commits after a certain tag
static
GitLogTip(ICakeContext, DirectoryPath) GitCommit
Get last commit
static
GitPull(ICakeContext, DirectoryPath, string, string, string, string, string) GitMergeResult
Pull authenticating using default options.
static
GitPull(ICakeContext, DirectoryPath, string, string) GitMergeResult
Pull unauthenticated using default options.
static
GitPush(ICakeContext, DirectoryPath, string, string, string) void
Push specific branch authenticated.
static
GitPush(ICakeContext, DirectoryPath, string, string) void
Push all branches authenticated.
static
GitPush(ICakeContext, DirectoryPath) void
Push all branches unauthenticated.
static
GitPushRef(ICakeContext, DirectoryPath, string, string, string, string) void
Push a tag to a remote authenticated.
static
GitPushRef(ICakeContext, DirectoryPath, string, string) void
Push a tag to a remote unauthenticated.
static
GitRemote(ICakeContext, DirectoryPath, string) GitRemote
Gets the specified remote from a Git repository.
static
GitRemotes(ICakeContext, DirectoryPath) IReadOnlyList<GitRemote>
Gets a Git repository's remotes.
static
GitRemove(ICakeContext, DirectoryPath, bool, FilePath[]) void
Remove file(s) from index.
static
GitReset(ICakeContext, DirectoryPath, GitResetMode, string) void
Sets the current branch head (HEAD) to a specified commit, optionally modifying index and working tree to match.
static
GitReset(ICakeContext, DirectoryPath, GitResetMode) void
Resets the current branch head (HEAD) optionally modifying index and working tree to match.
static
GitShortenSha(ICakeContext, DirectoryPath, GitCommit, Nullable<int>) string
Get the short version of a commit SHA.
static
GitTag(ICakeContext, DirectoryPath, string, string, string, string, string) void
Applys tagName to repository as annotated tag.
static
GitTag(ICakeContext, DirectoryPath, string, string, string, string) void
Applys tagName to repository as annotated tag.
static
GitTag(ICakeContext, DirectoryPath, string, string) void
Applys tagName to repository.
static
GitTag(ICakeContext, DirectoryPath, string) void
Applys tagName to repository.
static
GitTags(ICakeContext, DirectoryPath, bool) List<Tag>
Gets a list of all tags from the repository with the option to load targets of the tags.
static
GitTags(ICakeContext, DirectoryPath) List<Tag>
Gets a list of all tags from the repository.
static
GitUnstage(ICakeContext, DirectoryPath, FilePath[]) void
Removes from the staging area all the modifications of a collection of file since the latest commit (addition, updation or removal).
static
GitUnstageAll(ICakeContext, DirectoryPath) void
Removes from the staging area all the modifications all files the latest commit (addition, updation or removal).
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin