How access git commits from Microsoft.TeamFoundation.WorkItemTracking.Client

Question

I'm using TFS 2017 update 1 on premises. I'm using #ID in log comments of commits in order to associate workitem ID (of User Story, Task etc.) with GIT commits of source code. It properly works (I can see links to commit from workitem interface) but I'd like to use TFS SDK API with tfs aggregator in order to better manage GIT commits (e.g. dashboards using custom fields) . How can access git commits from Microsoft.TeamFoundation.WorkItemTracking.Client ?

Answer 1

The git commits are linked to workitems with "ExternalLink" type. So you can get the links of the work item to query that information.

    WorkItemStore wis = ttpc.GetService<WorkItemStore>();
    int workitemid = 1;
    WorkItem wi = wis.GetWorkItem(workitemid);
    foreach (Link w in wi.Links)
    {
        if (w.GetType().ToString() == "Microsoft.TeamFoundation.WorkItemTracking.Client.ExternalLink")
        {
            ExternalLink el = (ExternalLink)w;
            Console.WriteLine(el.LinkedArtifactUri);

        }

    }

The LinkedArtifactUri will include the ID of the git commit. And then you can get the commit information via:

            GitHttpClient ght = ttpc.GetClient<GitHttpClient>();
            GitCommit gc = ght.GetCommitAsync("CommitID", "RepoID",99).Result;
            Console.WriteLine(gc.Committer.Date);
            Console.WriteLine(gc.Committer.Name);
            foreach (GitChange gch in gc.Changes)
            {
                Console.WriteLine(gch.Item.Path);
            }
            Console.ReadLine();