Nutstone.GitHub.Service.Provider 1.1.8

GitHub.Service.Provider

Provides a library of methods to interact with local and remote git repositories. It uses the GTIHUB http api for remote repositories and LIB2GITSHARP for local repositories

It supports win-x64 and ubuntu 2.X

written in c# .net 8.0 (C) David Nuttall

Authentication

To access GITHUB methods it expects a GITHUB PAT token to be supplied (which is normally held in a local USER environmentvariable which , by default, is called 'GitToken'). OAuth is not currently supported

Usage

Virtualually all methods require a GitRequest object to be passed in as a parameter an example of which is :-

    gitRequest = GitRequest.Create()
                           .WithRepositoryName("remote repository name") // used for both remote and local repo names
                           .WithTokenFromEnvironmentVariable() // uses 'GitToken' en var by default 
                           .WithUser(testOwner) // or WithOrganisation 
                           .WithLocalRepositoryPath("root path to the local repository");
    
    var repoList = await GetRepositoryListAsync(gitRequest, (err, httpError) => {//do something}, (m) => {//verbose msg handler});                        

The library supports dependency injection and a static ServiceProvider method is supplied for registration.

      var serviceCollection = new ServiceCollection()
                                      .RegisterGitHub() // register github
                                      .yourregistrations

Category Visual Studio

Method	Description
GetInstalledTools	Returns a [DotNetToolLocalCollection]. A collection of dot net tools installed in the local user store
InstallDotnetTool	Installs the given packid as a dot net tool to the local user store
GetTools	Gets a [DotNetToolCollection]. of nuget dotnet tools with an optional Filter
GetProject	Returns [VisualStudioProjectCollection]. A collection of visual studio projects
GetAvailableGroups	Gets a list of labels associated with a projectgroup
UninstallDotNetTool	Uninstalls the given package from the dot net tool local tool store
GetProjectsFromDocument	Returns [VisualStudioProjectCollection]. A collection of visual studio projects from a .csproj

Category GitHub

Method	Description
GetRepositoryList	Returns a list of Repositories [GitRepositoryListCollection]
GetRepositoryListAsync	Returns a list of Repositories [GitRepositoryListCollection]

Category Local Git

Method	Description
Clone	Clones a remote repository
CreateBranch	Creates a new branch
Pull	Pulls latest from remote
CreateTag	Creates a tag
GetCommitsAsync	Returns a list of commits [GitCommitCollection]
GetCommits	Returns a list of commits [GitCommitCollection]
GetLatestCommitAsync	Returns the last commit
GetLatestCommit	Returns the last commit
IsLocalRepoLatestCommitAsync	Compares the local last connit with the remote
CheckoutBranch	Checks out a branch. If the branch does not exist - it is created
IsLocalRepoLatestCommit	Compares the local last connit with the remote

GetInstalledTools

Returns a [DotNetToolLocalCollection]. A collection of dot net tools installed in the local user store

Returns DotNetToolLocalCollection

var DotNetToolLocalCollectionResult = GetInstalledTools(msgHandler);

** Parameters **

msgHandler

Type: [Action<IEnumerable`1>] Default: Not Applicable

---

InstallDotnetTool

Installs the given packid as a dot net tool to the local user store

Returns Int32

var Int32Result = InstallDotnetTool(packageId, msgHandler);

** Parameters **

packageId

Type: [String] Default: Not Applicable

msgHandler

Type: [Action<IEnumerable`1>] Default: Not Applicable

---

GetTools

Gets a [DotNetToolCollection]. of nuget dotnet tools with an optional Filter

Returns DotNetToolCollection

var DotNetToolCollectionResult = GetTools(filter);

** Parameters **

filter

Type: [String?] Default:

---

GetProject

Returns [VisualStudioProjectCollection]. A collection of visual studio projects

Returns VisualStudioProjectCollection

var VisualStudioProjectCollectionResult = GetProject(projectPath);

** Parameters **

projectPath

Type: [String] Default: Not Applicable

---

GetAvailableGroups

Gets a list of labels associated with a projectgroup

Returns IEnumerable`1

var IEnumerable`1Result = GetAvailableGroups();

** Parameters **

---

UninstallDotNetTool

Uninstalls the given package from the dot net tool local tool store

Returns Int32

var Int32Result = UninstallDotNetTool(packageId, msgHandler);

** Parameters **

packageId

Type: [String] Default: Not Applicable

msgHandler

Type: [Action<IEnumerable`1>] Default: Not Applicable

---

GetProjectsFromDocument

Returns [VisualStudioProjectCollection]. A collection of visual studio projects from a .csproj

Returns VisualStudioProjectCollection

var VisualStudioProjectCollectionResult = GetProjectsFromDocument(document, projectPath);

** Parameters **

document

Type: [XDocument] Default: Not Applicable

projectPath

Type: [String] Default: Not Applicable

---

GetRepositoryList

Returns a list of Repositories [GitRepositoryListCollection]

Returns GitRepositoryListCollection

var GitRepositoryListCollectionResult = GetRepositoryList(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

GetRepositoryListAsync

Returns a list of Repositories [GitRepositoryListCollection]

Returns GitRepositoryListCollection

var GitRepositoryListCollectionResult = await GetRepositoryListAsync(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

Clone

Clones a remote repository

Returns Boolean

var BooleanResult = Clone(request, progressHandler, errorHandler, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

progressHandler

Type: [Action<CloneProgress>] Default: Not Applicable

errorHandler

Type: [Action<Exception>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

CreateBranch

Creates a new branch

Returns Boolean

var BooleanResult = CreateBranch(request, errorHandler, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

errorHandler

Type: [Action<String>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

Pull

Pulls latest from remote

Returns MergeStatus

var MergeStatusResult = Pull(request, errorHAndler, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

errorHAndler

Type: [Action<String>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

CreateTag

Creates a tag

Returns Boolean

var BooleanResult = CreateTag(request, tagName, releaseNote, errorHandler, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

tagName

Type: [String] Default: Not Applicable

releaseNote

Type: [String] Default: Not Applicable

errorHandler

Type: [Action<String>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

GetCommitsAsync

Returns a list of commits [GitCommitCollection]

Returns GitCommitCollection

var GitCommitCollectionResult = await GetCommitsAsync(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

GetCommits

Returns a list of commits [GitCommitCollection]

Returns GitCommitCollection

var GitCommitCollectionResult = GetCommits(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

GetLatestCommitAsync

Returns the last commit

Returns String

var StringResult = await GetLatestCommitAsync(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

GetLatestCommit

Returns the last commit

Returns String

var StringResult = GetLatestCommit(gitRequest, errorResponse, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

IsLocalRepoLatestCommitAsync

Compares the local last connit with the remote

Returns Boolean

var BooleanResult = await IsLocalRepoLatestCommitAsync(request, errorResponse, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

CheckoutBranch

Checks out a branch. If the branch does not exist - it is created

Returns Boolean

var BooleanResult = CheckoutBranch(gitRequest, errorHandler, msgHandler);

** Parameters **

gitRequest

Type: GitRequest Default: Not Applicable

errorHandler

Type: [Action<String>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---

IsLocalRepoLatestCommit

Compares the local last connit with the remote

Returns Boolean

var BooleanResult = IsLocalRepoLatestCommit(request, errorResponse, msgHandler);

** Parameters **

request

Type: GitRequest Default: Not Applicable

errorResponse

Type: [Action<String, HttpResponseMessage>] Default: Not Applicable

msgHandler

Type: [Action<String>?] Default:

---