每天?分享?最新?软件?开发?，Devops，敏捷?，测试?以及?项目?管理?最新?，最热门?的?文章?，每天?花?3分钟?学习?何乐而不为?，希望?大家?点赞?，加?关注?，你的?支持?是我?最大?的?动力?。

了解如何编写、使用和发布一个简单的基于 Python 的 GitHub Action

我们希望分享我们创建第一个 GitHub Action 的发现和经验。在本文中，您将学习如何用 Python 编写一个简单的 GitHub Action。

GitHub 操作简介

2019年，GitHub 发布了自己的 CI 工具 GitHub Actions。根据 GitHub 的说法，Actions 使得开发人员能够轻松地在软件开发生命周期(SDLC)中自动化任务。本机生态系统集成使项目能够从开发人员提交代码以部署到生产环境的那一刻起就自动化。

在查看示例 GitHub Action 之前，我们将先熟悉我们将遇到的语法和术语:

• 工作流: 一个可配置的自动化流程，它将运行一个或多个作业。工作流由回购文件中的 YAML 文件定义，并且在回购文件中的事件触发时运行。它们也可以手动触发，或使用已定义的时间表触发。中定义工作流。Github/workflow 目录，每个 repo 可以有多个工作流，每个工作流可以执行不同的任务集。
• 事件: 触发工作流的活动; 这些活动可以基于诸如推或拉请求之类的事件，但也可以使用 crontab 语法进行调度。
• 作业: 单个工作流中的任务。工作流可能由一个或多个作业组成，为了使工作流成功，所有作业都需要在没有任何错误的情况下执行。
• 步骤: 在作业中执行的较小的任务。为了完成一项工作，所有的步骤都必须完成。
• 操作: 在一个步骤中执行的独立命令。您可以编写自己的 Actions，也可以在 GitHub 市场的工作流中找到要使用的 Actions。
• Runner: 当工作流被触发时运行它们的服务器。每个运行器可以一次运行一个作业。GitHub 为工作流提供 Ubuntu Linux、 Microsoft Windows 和 macOS 运行程序; 每个工作流在一个新的、新配置的虚拟机中运行。

来源

编写 Python GitHub 动作

现在我们已经介绍了基础知识，让我们开始编写第一个 Python 操作。如果还没有回购协议，那么在 GitHub 上创建一个新的公共回购协议。您不能从私有回购中创建和分发您的 GitHub Action。

创建了存储库之后，在本地克隆它并在您喜欢的 IDE 上打开它。

git clone https://github.com/shipyard/github-action-python-template.git && \\
cd github-action-python-template && \\
code .

首先，我们需要为任何 GitHub Action 添加最重要的文件，即 Action.yml。此文件作为 Action 的接口，并定义其输入、输出和 run 命令。它使用 YAML 语法。您可以在这里阅读更多关于 action.yml 的不同组件和配置的信息。

Action.yml 总是必须包括:

• 名称: 你的行动的名称。如果您想要将您的 GitHub Action 发布到 Marketplace，那么它必须是全球独一无二的。
• 描述: 对你的行动所做的一个简短的描述。
• Input: 定义可以传递到 bash 脚本的输入参数。它们被注入为环境变量，您可以使用 $INPUT _ {变量}访问它们。
• Output: 定义可以稍后在另一个工作流步骤中使用的输出参数。
• Run: 定义操作将执行的内容/位置。

现在，让我们创建一个简单的 GitHub Action，它将接受一个整数输入并返回正方形作为输出。下面是我们的 action.yml 文件，我们将在示例中使用它:

# action.yaml
name: 'Custom GitHub Action'
description: 'A GitHub Action that takes an input and returns the square of the number'
inputs:
  num:
    description: 'Enter a number'
    required: true
    default: "1"
outputs:
  num_squared:
    description: 'Square of the input'
    # need to specify the extra `value` field for `composite` actions
    value: ${{ steps.get-square.outputs.num_squared }}
runs:
  using: 'composite'
  steps:
    - name: Install Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'  
    - name: Install Dependencies
      run: pip install -r requirements.txt
      shell: bash
    - name: Pass Inputs to Shell
      run: |
        echo "INPUT_NUM=${{ inputs.num }}" >> $GITHUB_ENV
      shell: bash
    - name: Fetch the number's square
      id: get-square
      run: python src/get_num_square.py
      shell: bash

让我们复习一下 action.yml 文件，重点关注 run 部分，因为其他部分非常简单。

using: 'composite'
steps:

GitHub 为操作提供了三个选项: Docker、 Javascript 和 Composite。您可以在这里阅读所有关于这三个选项以及哪一个最适合您的用例。

安装 Python

- name: Install Python
  uses: actions/setup-python@v4
  with:
    python-version: '3.10'

利用 GitHub 动作市场

我们开始时添加了一个自定义 shell 脚本来为 Action 安装 Python，但很快意识到我们不需要重新发明轮子。GitHub 提供了几个可以使用的操作，比如 setup-Python，我们将使用它来安装 Python。您可以在这里的官方文档中了解更多关于这个 Action 和不同功能的信息，比如 Matrix 测试、版本控制和缓存。

安装依赖项

- name: Install Dependencies
  run: pip install -r requirements.txt

尽管我们的示例非常简单，我们不会安装任何依赖项，但是我们希望包括如何安装依赖项。将命令更新到您正在使用的包管理器，例如 pip、诗歌或 pipenv。

将输入传递给shell(仅适用于复合流道)

- name: Pass Inputs to Shell
  run: |
    echo "INPUT_NUM=${{ inputs.num }}" >> $GITHUB_ENV

这是我们在创建 GitHub Action 时遇到的问题。我们不知道自己做错了什么，只好深入调查，把这件事查个水落石出。有一个积极的问题，防止输入被注入到流道的复合流道。作为解决方案我们将手动注入环境变量。你可以在这里读到这个问题。

运行 Python 脚本

- name: Fetch the number's square
  run: python src/get_num_square.py

最后，我们将运行 Python 脚本。让我们快速编写这个 Python 脚本并测试所有内容。创建一个新文件夹 src 并添加一个新文件 get _ num _ square.py，它只是将输出设置为输入数字的平方。

# src/get_num_square.py
import os

# get the input and convert it to int
num = os.environ.get("INPUT_NUM")
if num:
    try:
        num = int(num)
    except Exception:
        exit('ERROR: the INPUT_NUM provided ("{}") is not an integer'.format(num))
else:
    num = 1

# to set output, print to shell in following syntax
print(f"::set-output name=num_squared::{num ** 2}")

使用行动

现在我们已经准备好了所有的部分，让我们添加一个工作流到我们的回购，并添加新的行动作为一个步骤。中创建新的工作流。Github/workflow 目录。

# .github/workflows/test_action.yaml
name: Test Action
on: [push]

jobs:
  get-num-square:
    runs-on: ubuntu-latest
    name: Returns the number square
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Fetch num squared
        id: get_square
        uses: ./ # Uses an action in the root directory
        # or use a released GitHub Action
        # uses: shipyard/github-action/fetch-shipyard-env@1.0.0
        with:
          num: 11
      - name: Print the square
        run: echo "${{ steps.get_square.outputs.num_squared }}"

提交新的更改并转到 Actions 选项卡查看正在运行的运行者。

我们可以验证我们的输出是正确的。我们将11作为输入参数传递，可以在 Action 的输出中看到121。

发布 GitHub 动作

一旦您验证了 GitHub Action，您就可以通过单击 Draft a release 按钮来发布它，如下面的截图所示。

一旦这个新的 Action 成功发布，人们就可以开始在 GitHub 的所有工作流中使用它了。

结论

正如您所看到的，GitHub Actions 的设置非常简单，可以让开发人员做出令人惊叹的事情。GitHub Actions 拥有一个非常强大的开发人员社区，其中包含几个预构建的 Actions、示例和工作流模板，因此您不必从头开始。希望这能帮助您创建一些很棒的 GitHub Actions。让我们知道这个过程是如何进行的，以及你最终创造了什么。编程愉快！