Skip to main content

GitHub Actions 快速入门

在 5 分钟或更短的时间内尝试 GitHub Actions 的功能。

简介

您只需要 GitHub 仓库来创建和运行 GitHub Actions 工作流程。 在本指南中,您将添加一个工作流程,演示 GitHub Actions 的一些基本功能。

下面的示例显示 GitHub Actions 作业如何自动触发、在哪里运行及其如何与仓库中的代码交互。

创建第一个工作流程

  1. 如果 .github/workflows 目录不存在,请在 GitHub 的仓库中创建此目录。

  2. .github/workflow 目录中,创建一个名为 github-actions-demo.yml 的文件。 更多信息请参阅“创建新文件”。

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

    YAML
    name: GitHub Actions Demo
    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@v3
          - 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 }}."
    
  4. 滚动到页面底部,然后选择 Create a new branch for this commit and start a pull request(为此提交创建一个新分支并开始拉取请求)。 然后,若要创建拉取请求,请单击 Propose new file(提议新文件)提交工作流程文件

向仓库的分支提交工作流程文件会触发 push 事件并运行工作流程。

查看工作流程结果

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

  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

  3. 在左侧边栏中,单击您想要查看的工作流程。

    左侧边栏中的工作流程列表

  4. 从工作流程运行列表中,单击要查看的运行的名称。

    工作流程运行的名称

  5. Jobs(作业)下,单击 Explore-GitHub-Actions 作业。

    查找作业

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

    示例工作流程结果

    例如,您可以在仓库中看到文件列表: 示例操作详细信息

更多入门工作流程

GitHub 提供预配置的入门工作流程,您可以自定义以创建自己的持续集成工作流程。 GitHub Enterprise Cloud 分析代码并显示可能适用于您的仓库的 CI 模板入门工作流程。 例如,如果仓库包含 Node.js 代码,您就会看到 Node.js 项目的建议。 您可以使用入门工作流程作为起点来构建自定义工作流程,或按原样使用工作流程。

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

更复杂的示例

For examples that demonstrate more complex features of GitHub Actions, see "Examples." You can see detailed examples that explain how to test your code on a runner, access the GitHub CLI, and use advanced features such as concurrency and test matrices.

后续步骤

每次将代码推送到分支时,您刚刚添加的示例工作流程都会运行,并显示 GitHub Actions 如何处理仓库的内容。 但是,这只是您可以对 GitHub Actions 执行操作的开始:

  • 您的仓库可以包含多个基于不同事件触发不同任务的工作流程。
  • 您可以使用工作流程安装软件测试应用程序,并让它们自动在 GitHub 的运行器上测试您的代码。

GitHub Actions 可以帮助您自动执行应用程序开发过程的几乎每个方面。 准备好开始了吗? 以下是一些帮助您对 GitHub Actions 执行后续操作的有用资源: