ASP.NET项目中如何获取Git最新提交标签并在API中返回

嘿，我刚好做过类似的需求！在你的.NET应用里获取Git最新提交标签并通过API对外提供，这里有两种实用的方案，你可以根据自己的场景选：

这是最贴合.NET生态的方式，不需要调用外部命令，稳定性更高。

• 首先在项目里安装NuGet包：Install-Package LibGit2Sharp 或者通过NuGet包管理器搜索安装。
• 然后写代码获取最新标签：

using LibGit2Sharp;

public string GetLatestGitTag(string repoPath)
{
    try
    {
        using var repo = new Repository(repoPath);
        // 获取所有带标签的提交，按提交时间倒序排列
        var latestTaggedCommit = repo.Tags
            .Select(tag => tag.Target as Commit)
            .Where(commit => commit != null)
            .OrderByDescending(commit => commit.Committer.When)
            .FirstOrDefault();

        if (latestTaggedCommit == null)
        {
            return "No tags found in repository";
        }

        // 找到对应这个提交的标签名（可能有多个标签指向同一个提交，取第一个）
        var latestTag = repo.Tags
            .First(tag => tag.Target == latestTaggedCommit)
            .FriendlyName;

        return latestTag;
    }
    catch (RepositoryNotFoundException)
    {
        return "Git repository not found at specified path";
    }
    catch (Exception ex)
    {
        return $"Error retrieving latest tag: {ex.Message}";
    }
}

如果你的应用运行环境已经安装了Git，这种方式更简单，不用加额外的NuGet包。

using System.Diagnostics;

public string GetLatestGitTagViaCommandLine(string repoPath)
{
    var processStartInfo = new ProcessStartInfo
    {
        FileName = "git",
        Arguments = "describe --abbrev=0 --tags",
        WorkingDirectory = repoPath,
        RedirectStandardOutput = true,
        RedirectStandardError = true,
        UseShellExecute = false,
        CreateNoWindow = true
    };

    using var process = Process.Start(processStartInfo);
    process.WaitForExit();

    if (process.ExitCode != 0)
    {
        var error = process.StandardError.ReadToEnd();
        return string.IsNullOrEmpty(error) ? "No tags found or Git command failed" : error.Trim();
    }

    return process.StandardOutput.ReadToEnd().Trim();
}

把上面的方法集成到你的API控制器里就行，比如：

[ApiController]
[Route("api/[controller]")]
public class VersionController : ControllerBase
{
    // 注意：这里的仓库路径可以根据实际情况设置，比如部署时可能需要指向应用根目录的.git文件夹
    private readonly string _repoPath = Path.Combine(AppContext.BaseDirectory, "..", "..", ".."); // 示例路径，按需调整

    [HttpGet("latest-tag")]
    public IActionResult GetLatestTag()
    {
        var tag = GetLatestGitTag(_repoPath); // 或者用GetLatestGitTagViaCommandLine
        return Ok(new { LatestGitTag = tag });
    }
}

• 如果是部署到生产环境，要确保应用有权限访问Git仓库的文件（或者在构建阶段就把标签信息嵌入到程序集里，避免运行时依赖Git仓库）。
• 可以考虑把标签信息缓存起来，避免每次请求都去读取Git仓库，提升性能。
• 如果你的Git仓库里有轻量标签和附注标签，两种方法都能正常识别，不用担心。

内容的提问来源于stack exchange，提问作者Aymen Bouein