gh-get-current-pr：项目核心功能/场景

gh-get-current-pr：项目核心功能/场景

gh-get-current-pr Github Action for getting all the details about the current Pull Request if the commit is part of one 项目地址: https://gitcode.com/gh_mirrors/gh/gh-get-current-pr

gh-get-current-pr 是一个用于检查当前提交是否属于一个 Pull Request（PR）并在该情况下返回完整的 PR 对象的 GitHub Action。

项目介绍

gh-get-current-pr 是一个开源的 GitHub Action，它解决了一个常见的问题：在 GitHub Actions 工作流程中，当触发事件不是 pull_request 时，无法获取当前提交是否属于一个 PR。例如，当触发事件是 push 时，我们无法得知当前的提交是否与任何 PR 相关联。这个 Action 通过检查当前提交是否属于一个 PR，并在是的情况下返回完整的 PR 对象，从而为开发者提供了这一关键信息。

项目技术分析

该项目使用了 GitHub Actions，这是一种自动化您的软件开发工作流程的方式。通过定义一系列步骤，可以自动执行如代码审查、构建、测试和部署等任务。gh-get-current-pr Action 专门用于处理 PR 相关的操作，它通过查询 GitHub API 来检索与当前提交相关联的 PR 对象。

技术细节上，该 Action 支持多种输入参数，如 github-token 用于认证，sha 用于指定特定的提交 SHA 值，以及 filterOutClosed 和 filterOutDraft 用于过滤不同状态的 PR。此外，该 Action 提供了丰富的输出参数，包括 PR 编号、URL、标题、正文字段以及创建、合并和关闭时间等。

项目及技术应用场景

gh-get-current-pr Action 的应用场景非常广泛，适用于任何需要检查当前提交是否属于 PR 并根据 PR 状态执行后续操作的情况。以下是一些具体的应用场景：

1. 自动化测试和部署：在 CI/CD 流程中，根据 PR 的状态自动执行不同的测试或部署流程。
2. 自动化通知：当 PR 被创建、更新或关闭时，发送通知到团队或相关的项目管理工具。
3. 分支管理：根据 PR 状态自动管理分支的生命周期，例如自动删除不再需要的分支。
4. 数据统计和分析：收集 PR 相关数据，用于后续的分析和改进工作流程。

项目特点

1. 灵活性：支持多种输入参数，可以根据不同的需求定制使用方式。
2. 易用性：通过简单的 YAML 配置即可集成到现有的 GitHub Actions 工作流程中。
3. 健壮性：通过单元测试和集成测试保证了 Action 的稳定性和可靠性。
4. 开放性：作为一个开源项目，欢迎社区贡献和反馈，共同改进项目。

以下是 gh-get-current-pr Action 的一个典型使用示例：

steps:
  - uses: 8BitJonny/gh-get-current-pr@3.0.0
    id: PR

  - run: echo "您的 PR 编号是 ${{ steps.PR.outputs.number }}，PR JSON 对象为 ${{ steps.PR.outputs.pr }}"

通过上述示例，我们可以看到该 Action 的集成非常简单，只需添加相应的步骤到您的 GitHub Actions 工作流程文件中即可。

总之，gh-get-current-pr Action 是一个强大且灵活的工具，能够帮助开发者更好地管理和自动化他们的 PR 相关工作流程。通过其丰富的功能和易于集成的特性，它已经成为许多开发者和团队的必备工具。

gh-get-current-pr Github Action for getting all the details about the current Pull Request if the commit is part of one 项目地址: https://gitcode.com/gh_mirrors/gh/gh-get-current-pr