创建复合操作

简介

在本指南中，你将了解创建和使用打包复合操作所需的基本组件。为了使本指南重点关注打包操作所需的组件，操作代码的功能是最小的。该操作打印“Hello World”，然后打印“Goodbye”，或者如果你提供自定义名称，它将打印“Hello [who-to-greet]”，然后打印“Goodbye”。该操作还将随机数映射到random-number输出变量，并运行名为goodbye.sh的脚本。

完成此项目后，你应该了解如何构建自己的复合操作并在工作流中对其进行测试。

复合操作和可重复使用的工作流

复合操作允许你将一系列工作流作业步骤收集到一个操作中，然后你可以在多个工作流中将该操作作为单个作业步骤运行。可重复使用的工作流提供了另一种避免重复的方法，它允许你从其他工作流中运行完整的工作流。有关更多信息，请参阅“避免重复”。

先决条件

在开始之前，您需要在 GitHub.com 上创建一个存储库。

1. 在 GitHub.com 上创建一个新的公开存储库。您可以选择任何存储库名称，或使用以下 hello-world-composite-action 示例。您可以在项目推送到 GitHub 后添加这些文件。有关详细信息，请参阅“创建新存储库”。

2. 将您的存储库克隆到您的计算机。有关详细信息，请参阅“克隆存储库”。

3. 在您的终端中，将目录更改为您的新存储库。

   Shell

   cd hello-world-composite-action
   

4. 在 hello-world-composite-action 存储库中，创建一个名为 goodbye.sh 的新文件，并添加示例代码

   Shell

   echo "echo Goodbye" > goodbye.sh
   

5. 在您的终端中，使 goodbye.sh 可执行。

   Shell

   chmod +x goodbye.sh
   

   Shell

   chmod +x goodbye.sh
   

   Shell

   git add --chmod=+x -- goodbye.sh
   

6. 在您的终端中，签入您的 goodbye.sh 文件。

   Shell

   git add goodbye.sh
   git commit -m "Add goodbye script"
   git push
   

   Shell

   git add goodbye.sh
   git commit -m "Add goodbye script"
   git push
   

   Shell

   git commit -m "Add goodbye script"
   git push
   

创建操作元数据文件

1. 在 hello-world-composite-action 存储库中，创建一个名为 action.yml 的新文件，并添加以下示例代码。有关此语法的详细信息，请参阅“GitHub 操作的元数据语法”。

   YAML

   name: 'Hello World'
   description: 'Greet someone'
   inputs:
     who-to-greet:  # id of input
       description: 'Who to greet'
       required: true
       default: 'World'
   outputs:
     random-number:
       description: "Random number"
       value: ${{ steps.random-number-generator.outputs.random-number }}
   runs:
     using: "composite"
     steps:
       - name: Set Greeting
         run: echo "Hello $INPUT_WHO_TO_GREET."
         shell: bash
         env:
           INPUT_WHO_TO_GREET: ${{ inputs.who-to-greet }}
   
       - name: Random Number Generator
         id: random-number-generator
         run: echo "random-number=$(echo $RANDOM)" >> $GITHUB_OUTPUT
         shell: bash
   
       - name: Set GitHub Path
         run: echo "$GITHUB_ACTION_PATH" >> $GITHUB_PATH
         shell: bash
         env:
           GITHUB_ACTION_PATH: ${{ github.action_path }}
   
       - name: Run goodbye.sh
         run: goodbye.sh
         shell: bash
   
   

   此文件定义了 who-to-greet 输入，将随机生成数字映射到 random-number 输出变量，将操作的路径添加到运行程序系统路径（以便在执行期间找到 goodbye.sh 脚本），并运行 goodbye.sh 脚本。

   有关管理输出的详细信息，请参阅“GitHub 操作的元数据语法”。

   有关如何使用 github.action_path 的详细信息，请参阅“上下文”。

2. 在您的终端中，签入您的 action.yml 文件。

   Shell

   git add action.yml
   git commit -m "Add action"
   git push
   

3. 在您的终端中，添加一个标签。此示例使用名为 v1 的标签。有关详细信息，请参阅“关于自定义操作”。

   Shell

   git tag -a -m "Description of this release" v1
   git push --follow-tags
   

在工作流中测试您的操作

以下工作流代码使用你在“创建复合操作”中制作的已完成的 hello world 操作。

将工作流代码复制到另一个存储库中的 .github/workflows/main.yml 文件中，但将 actions/hello-world-composite-action@v1 替换为你创建的存储库和标签。你还可以将 who-to-greet 输入替换为你的姓名。

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v4
      - id: foo
        uses: actions/hello-world-composite-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
      - run: echo random-number "$RANDOM_NUMBER"
        shell: bash
        env:
          RANDOM_NUMBER: ${{ steps.foo.outputs.random-number }}

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v4
      - id: foo
        uses: actions/hello-world-composite-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
      - run: echo random-number "$RANDOM_NUMBER"
        shell: bash
        env:
          RANDOM_NUMBER: ${{ steps.foo.outputs.random-number }}

从你的存储库中，单击“操作”选项卡，然后选择最新的工作流运行。输出应包括：“你好，Mona the Octocat”，这是“再见”脚本的结果，以及一个随机数。

GitHub.com 上的复合操作示例

你可以在 GitHub.com 上找到许多复合操作的示例。

• microsoft/action-python
• microsoft/gpt-review
• tailscale/github-action