GitHub Actions 快速入门

简介

GitHub Actions 是一个持续集成和持续交付 (CI/CD) 平台，允许您自动化构建、测试和部署管道。您可以创建在您每次将更改推送到仓库时运行测试的工作流，或者将合并的拉取请求部署到生产环境的工作流。

本快速入门指南向您展示如何使用 GitHub.com 的用户界面添加一个工作流，该工作流演示了 GitHub Actions 的一些基本功能。

有关 GitHub Actions 工作流的概述，请参阅 "关于工作流。" 如果您想了解构成 GitHub Actions 的各种组件，请参阅 "了解 GitHub Actions。"

先决条件

本指南假设您

• 至少具备使用 GitHub 的基本知识。如果您没有，建议您先阅读一些关于仓库和拉取请求的文档文章。例如，请参阅“仓库快速入门”，“关于分支”和“关于拉取请求”。

• 您在 GitHub.com 上拥有一个可以添加文件的仓库。

• 您可以访问 GitHub Actions。

  注意

  如果 Actions 选项卡未在 GitHub 上的仓库名称下方显示，可能是因为该仓库禁用了 Actions。有关更多信息，请参阅“管理仓库的 GitHub Actions 设置”。

创建您的第一个工作流

1. 在 GitHub.com 上的仓库中，在 .github/workflows 目录中创建一个名为 github-actions-demo.yml 的工作流文件。为此

   • 如果 .github/workflows 目录已存在，请在 GitHub 上导航到该目录，单击添加文件，然后单击创建新文件，并将文件命名为 github-actions-demo.yml。

   • 如果您的仓库没有 .github/workflows 目录，请转到 GitHub 上的仓库主页，单击添加文件，然后单击创建新文件，并将文件命名为 .github/workflows/github-actions-demo.yml。这将在一步骤中创建 .github 和 workflows 目录以及 github-actions-demo.yml 文件。

   注意

   为了让 GitHub 发现您仓库中的任何 GitHub Actions 工作流，您必须将工作流文件保存在名为 ` .github/workflows ` 的目录中。

   您可以随意命名工作流文件，但必须使用 ` .yml ` 或 ` .yaml ` 作为文件名扩展名。YAML 是一种标记语言，通常用于配置文件。

2. 将以下 YAML 内容复制到 ` github-actions-demo.yml ` 文件中

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v4
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   在这个阶段，您不需要理解此工作流的详细信息。现在，您可以将内容复制粘贴到文件中。完成本快速入门指南后，您可以在 "关于工作流" 中了解工作流文件语法，并了解 GitHub Actions 上下文（例如 ` ${{ github.actor }} ` 和 ` ${{ github.event_name }} `），请参阅 "上下文"。

3. 点击 **提交更改**。

4. 在“建议更改”对话框中，选择将更改提交到默认分支或创建新分支并开始拉取请求的选项。然后点击 **提交更改** 或 **建议更改**。

   

将工作流文件提交到仓库中的分支会触发 ` push ` 事件并运行您的工作流。

如果您选择开始拉取请求，您可以继续创建拉取请求，但这对于本快速入门指南来说不是必需的，因为提交仍然已提交到分支，并将触发新的工作流。

查看您的工作流结果

1. 在 GitHub.com 上，导航到仓库的主页。

2. 在您的仓库名称下，点击 操作.

   

3. 在左侧边栏中，点击您要显示的工作流，在本例中为“GitHub Actions Demo”。

   

4. 从工作流运行列表中，点击您要查看的运行的名称，在本例中为“USERNAME is testing out GitHub Actions”。

5. 在工作流运行页面左侧边栏的 **作业** 下，点击 **Explore-GitHub-Actions** 作业。

   

6. 日志显示了每个步骤的处理方式。展开任何步骤以查看其详细信息。

   

   例如，您可以看到仓库中的文件列表

   

您刚刚添加的示例工作流在每次将代码推送到分支时都会触发，并向您展示了 GitHub Actions 如何与仓库的内容进行交互。有关深入教程，请参阅 "了解 GitHub Actions"。

更多入门工作流

GitHub 提供预配置的入门工作流，您可以对其进行自定义以创建自己的持续集成工作流。GitHub 会分析您的代码，并向您展示可能对您的仓库有用的 CI 入门工作流。例如，如果您的仓库包含 Node.js 代码，您将看到有关 Node.js 项目的建议。您可以使用入门工作流作为起点来构建自定义工作流，或者直接使用它们。

您可以在 actions/starter-workflows 仓库中浏览入门工作流的完整列表。

下一步

GitHub Actions 可以帮助您自动化应用程序开发流程的几乎所有方面。准备开始了吗？以下是一些关于如何使用 GitHub Actions 的有用资源。

• 要快速创建 GitHub Actions 工作流，请参阅“使用入门工作流”。
• 要了解用于构建和测试代码的持续集成 (CI) 工作流，请参阅“自动化构建和测试”。
• 要了解如何构建和发布包，请参阅“发布包”。
• 要了解如何部署项目，请参阅“部署”。
• 要了解如何在 GitHub 上自动化任务和流程，请参阅“管理问题和拉取请求”。
• 要了解演示 GitHub Actions 更复杂功能的示例（包括上述许多用例），请参阅“示例”。您可以看到详细的示例，这些示例解释了如何在运行器上测试代码、访问 GitHub CLI 以及使用并发和测试矩阵等高级功能。
• 如果您想证明您在使用 GitHub Actions 自动化工作流和加速开发方面的熟练程度，您可以通过 GitHub 认证获得 GitHub Actions 证书。有关更多信息，请参阅“关于 GitHub 认证”。