返回

开源指南:用 Python 打造 GitHub 操作

开发工具

GitHub Actions 是一个功能强大的平台,可让您在 GitHub 中直接自动化软件开发工作流程。它支持多种编程语言,包括 Python,这使其成为自动化 GitHub 工作流程的理想选择。

本文将带您逐步了解如何使用 Python 和 GitHub Actions 创建自动化的工作流程。我们将探讨如何设置一个操作,它可以在代码提交后自动运行 Python 脚本。

前提条件

要继续本指南,您需要具备以下条件:

  • GitHub 帐户
  • Python 环境
  • 对 GitHub Actions 的基本了解

创建 GitHub 操作

  1. 在 GitHub 上创建一个新存储库。
  2. 在存储库中创建一个名为 .github/workflows/ 的目录。
  3. 在该目录中创建一个名为 main.yml 的 YAML 文件。

定义操作

main.yml 文件中,我们将定义我们的 GitHub 操作。以下是该操作的 YAML 定义:

name: Run Python Script

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      - run: python script.py

让我们逐行分解一下这个定义:

  • name:这是操作的名称,它将在 GitHub UI 中显示。
  • on:这指定了操作将在何时触发。在本例中,它将在推送至 main 分支时触发。
  • jobs:这定义了操作中包含的作业。
  • build:这是我们定义的第一个作业。
  • runs-on:这指定了作业将在哪个平台上运行。在本例中,它将在 Ubuntu Latest 上运行。
  • steps:这是作业中包含的步骤的列表。
  • uses: actions/checkout@v3:这会将代码签出到 GitHub 操作的运行程序。
  • uses: actions/setup-python@v4:这会为操作设置 Python 环境。
  • run: python script.py:这会运行 script.py Python 脚本。

创建 Python 脚本

现在我们已经定义了操作,我们需要创建一个 Python 脚本来运行。在此示例中,我们只需创建一个简单的 Hello World 脚本:

# script.py

print("Hello, world!")

触发操作

要触发操作,请将 script.py 文件推送到您的存储库的 main 分支。GitHub Actions 将自动检测推送并运行操作。

总结

通过遵循本指南,您已经使用 Python 和 GitHub Actions 创建了一个自动化的工作流程。这只是利用这些工具可以实现的众多可能性之一。现在,您可以探索更多的 GitHub Actions 功能,并创建更多复杂的自动化来简化您的开发工作流程。