Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

创建组合操作

在本指南中,您将学� 如何构建组合操作。

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

简介

在本指南中,您将了解创建和使用打包的组合操作所需的基本组件。 本指南的重点是打包操作所需的组件,� 此很少讲操作代� �的功能。 该操作将依次打印 "Hello World" 和 "Goodbye",如果您提供自定义名称,则将依次打印 "Hello [who-to-greet]" 和 "Goodbye"。 该操作还将随机数� 射到 random-number 输出变量,并运行名为 goodbye.sh 的脚本。

完成此项目后,您应了解如何构建自己的组合操作和在工作流程测试该操作。

警告:创建工作流程和操作时,您应始终考虑您的代� �是否会执行来自可能的攻击者的不信任输入。 某些上下文应被视为不受信任的输入,� 为攻击者可能会插入自己的恶意内容。 更多信息请参阅“了解脚本注入的风险”。

基本要求

在开始之前,您将在 您的 GitHub Enterprise Server 实例 上创建一个存储库。

  1. 在 您的 GitHub Enterprise Server 实例 上创建公共仓库 您可以选择任何仓库名称,或者使用下面的 hello-world-composite-action 示例。 您可以在项目推送到 GitHub Enterprise Server 之后添� 这些文件。 更多信息请参阅“创建新仓库”。

  2. 将仓库克隆到计算机。 更多信息请参阅“克隆仓库”。

  3. 从您的终端,将目录更改为新仓库。

    cd hello-world-composite-action
  4. hello-world-composite-action 仓库中,创建一个名为 goodbye.sh 的新文件,并添� 以下示例代� �:

    echo "Goodbye"
    
  5. 从您的终端创建 goodbye.sh 可执行文件。

    chmod +x goodbye.sh
  6. 从终端检入 goodbye.sh 文件。

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

创建操作元数据文件

  1. hello-world-composite-action 仓库中,创建一个名为 action.yml 的新文件,并添� 以下示例代� �: 有关此语法的更多信息,请参阅“组合运行步骤的运行”。

    action.yml

    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:
        - run: echo Hello ${{ inputs.who-to-greet }}.
          shell: bash
        - id: random-number-generator
          run: echo "::set-output name=random-number::$(echo $RANDOM)"
          shell: bash
        - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
          shell: bash          
        - run: goodbye.sh
          shell: bash
    

    此文件定义 who-greet 输入,将随机生成的数字� 射到 random-number 输出变量,并运行 goodbye.sh 脚本。 它还告诉运行器如何执行组合操作。

    有关管理输出的更多信息,请参阅“组合运行步骤的输出”。

    有关如何使用 github.action_path 的更多信息,请参阅“github context”。

  2. 从终端检入 action.yml 文件。

    git add action.yml
    git commit -m "Add action"
    git push
  3. 从终端添� � �记。 此示例使用名为 v1 的� �记。 更多信息请参阅“关于操作”。

    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 输入替换为您的名称。

.github/workflows/main.yml

on: [push]

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

从您的仓库中,单击 Actions(操作)选项卡,然后选择最新的工作流程来运行。 输出应包括:"Hello Mona the Octocat"、"Goodbye" 脚本的结果以及随机数字。