DevOps Bootcamp · 课时

开发自定义 GitHub Actions

学习使用 JavaScript 或 Docker 创建自己的可复用自定义操作，扩展 GitHub Actions 的功能

开发自定义 GitHub Actions 是 CoddyKit 上的免费 DevOps Bootcamp 课时。这是第 1 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 DevOps Bootcamp 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 DevOps Bootcamp 课程共包含 4 节课。

扩展 GitHub 操作

如果您需要在工作流中执行 GitHub 操作开箱即不提供的特定任务，或者有复杂逻辑需要重复使用，该怎么办？

自定义操作可以帮助您为工作流构建可重复使用的工具。它们就像执行特定任务的小型程序，可以根据您的需求进行定制。

自定义的强大力量

自定义操作可以为您的 CI/CD 流水线带来多项好处：

可重复使用：编写一次，即可在多个工作流和代码仓库中使用。
标准化：确保组织内的流程保持一致。
封装：通过简单的接口隐藏复杂逻辑。
集成：与特定的内部工具或 API 交互。

JavaScript 还是 Docker？

GitHub 操作支持两种主要的自定义操作创建方式：

JavaScript 操作：使用 JavaScript（或 TypeScript）编写，直接在运行器机器上执行。适用于简单任务，速度快且易于实现。
Docker 容器操作：将环境和代码封装在 Docker 镜像中。适用于需要特定依赖项或编程语言的操作。

定义您的操作

每个自定义操作都需要在根目录中包含一个 action.yml 文件。这个 YAML 文件类似于清单，用于向 GitHub 操作说明您的操作：

name 和 description：说明操作的功能。
inputs：操作接收的数据。
outputs：操作生成的数据。
runs：操作的执行方式（例如 JavaScript 文件或 Docker 镜像）。

简单的 JS 操作示例

下面来看一个基础的 JavaScript 操作。您需要一个 action.yml 文件和一个 index.js 文件。action.yml 用于定义操作的元数据和执行环境。

# action.yml
name: 'Hello World Action'
description: 'Greets a person using a custom message'
inputs:
  who-to-greet:
    description: 'Who to greet'
    required: true
    default: 'World'
outputs:
  greeting-message:
    description: 'The greeting message generated'
runs:
  using: 'node16'
  main: 'index.js'

编写 JavaScript 代码

index.js 文件包含实际逻辑。我们使用 @actions/core 工具包来获取输入并设置输出。

请尝试运行下面这段简单的 JavaScript 代码片段，从概念上了解输入和输出的工作方式，即使不在完整工作流中运行也可以。

// index.js (simplified for demonstration)
const core = require('@actions/core');

try {
  const name = core.getInput('who-to-greet');
  const message = `Hello, ${name}!`;
  console.log(message);
  core.setOutput('greeting-message', message);
} catch (error) {
  core.setFailed(error.message);
}

// A standalone runnable example to demonstrate core logic
function runSimpleGreeting(inputName) {
  const name = inputName || 'World';
  const message = `Hello from runnable JS, ${name}!`;
  return message;
}

console.log(runSimpleGreeting('CoddyKit'));
console.log(runSimpleGreeting());

Docker 操作基础

对于更复杂的环境，Docker 容器操作非常强大。它们包含一个 Dockerfile，用于定义容器镜像，并打包所有必要的依赖项。

您的 action.yml 会引用此镜像，告知 GitHub 操作构建并运行它。

# action.yml for Docker action
name: 'Docker Hello World'
description: 'Greets a name from within a Docker container'
inputs:
  who-to-greet:
    description: 'Who to greet'
    required: true
    default: 'Docker'
outputs:
  greeting-message:
    description: 'The greeting message from Docker'
runs:
  using: 'docker'
  image: 'Dockerfile'

操作的运行环境

Dockerfile 指定基础镜像、安装依赖项，并定义操作的入口点。这可以确保您的操作在一致且受控的环境中运行。

# Dockerfile
FROM alpine:3.16

LABEL "com.github.actions.name"="Docker Hello World"
LABEL "com.github.actions.description"="Greets a name from within a Docker container"
LABEL "com.github.actions.icon"="globe"
LABEL "com.github.actions.color"="blue"

# Copy your script into the container
COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh

ENTRYPOINT ["/entrypoint.sh"]

编写 Docker 操作脚本

在 Docker 容器中，您的入口脚本（例如 entrypoint.sh）会接收作为环境变量的输入（前缀为 INPUT_）。它会将输出写入环境变量 $GITHUB_OUTPUT 指定的文件。

#!/bin/sh -l

# entrypoint.sh

echo "Hello from Docker, $INPUT_WHO_TO_GREET!"
GREETING="Hello from Docker, $INPUT_WHO_TO_GREET!"
echo "greeting-message=$GREETING" >> "$GITHUB_OUTPUT"

操作的最佳实践

开发自定义操作时，请考虑以下建议，以构建可靠且易于维护的工具：

版本管理：使用语义化版本（例如 v1、v2）来确保稳定性。
测试：在本地和工作流中严格测试您的操作。
错误处理：实现清晰的错误消息和优雅的失败处理。
安全性：清理输入，避免暴露敏感数据。
文档：在您的 README 中提供清晰的使用说明。

操作类型检查

您需要创建一个自定义 GitHub 操作，而该操作需要使用标准 GitHub 操作运行器中未预先安装的特定 Python 库。通常哪种类型的操作最适合这种情况？

自定义操作总结

我们探讨了如何通过创建自己的自定义操作来扩展 GitHub 操作。您了解了两种主要类型：JavaScript 操作和 Docker 容器操作，以及 action.yml 文件的重要作用。我们还介绍了如何为每种类型定义输入、输出和核心逻辑，以及开发时的最佳实践。

自定义操作非常适合实现 CI/CD 流水线中的重复使用和标准化！

常见问题解答

「开发自定义 GitHub Actions」课时是免费的吗？

是的 — 「开发自定义 GitHub Actions」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 DevOps Bootcamp 课程的其余内容，请升级到 CoddyKit PRO。 DevOps Bootcamp 课程共包含 4 节课。

「开发自定义 GitHub Actions」这节课中我会学到什么？

学习使用 JavaScript 或 Docker 创建自己的可复用自定义操作，扩展 GitHub Actions 的功能你通过在浏览器中直接运行的动手代码来练习 DevOps Bootcamp，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 DevOps Bootcamp 需要有经验吗？

无需任何先前经验。CoddyKit 上的 DevOps Bootcamp 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 4 节。

「开发自定义 GitHub Actions」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 DevOps Bootcamp 课中编写并运行代码吗？

能。每节 DevOps Bootcamp 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 DevOps Bootcamp