我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

GitHub Actions 快速入门

在 5 分钟或更短时间内将 GitHub Actions 工作流程添加到现有仓库。

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

简介

您只需要一个现有的 GitHub 仓库来创建和运行 GitHub Actions 工作流程。 在本指南中,您将添加一个工作流程,使用 GitHub Super-Linter 操作链接多种编码语言。 每次有新的提交被推送到您的仓库时,工作流程都会使用 Super-Linter 验证源代码。

创建第一个工作流程

  1. 从 GitHub 上的仓库,在 .github/workflow 目录中创建一个名为 superlinter.yml 的新文件。 更多信息请参阅“创建新文件”。

  2. 将以下 YAML 内容复制到 superlinter.yml 文件中。 注: 如果您的默认分支不是 main,请更新 DEFAULT_BRANCH 的值以匹配您仓库的默认分支名称。

    name: Super-Linter
    
    # Run this workflow every time a new commit pushed to your repository
    on: push
    
    jobs:
      # Set the job key. The key is displayed as the job name
      # when a job name is not provided
      super-lint:
        # Name the Job
        name: Lint code base
        # Set the type of machine to run on
        runs-on: ubuntu-latest
    
        steps:
          # Checks out a copy of your repository on the ubuntu-latest machine
          - name: Checkout code
            uses: actions/checkout@v2
    
          # Runs the Super-Linter action
          - name: Run Super-Linter
            uses: github/super-linter@v3
            env:
              DEFAULT_BRANCH: main
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    
  3. 要运行您的工作流程, 滚动到页面底部,然后选择 为此提交创建一个新分支并开始拉取请求。 然后,若要创建拉取请求,请单击 Propose new file(提议新文件)

    提交工作流程文件

在仓库中提交工作流程文件会触发 push 事件并运行工作流程。

查看工作流程结果

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

  2. 在仓库名称下,单击 Actions(操作)

    主仓库导航中的操作选项卡

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

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

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

    工作流程运行的名称

  5. 在左侧边栏中,单击 Lint code base(Lint 代码库)作业。

    Lint 代码库作业

  6. Any failed steps are automatically expanded to display the results.

    Super linter 工作流程结果

更多入门工作流程

GitHub 提供预配置的工作流程模板,您可以从这些模板开始自动执行或创建持续集成工作流程。 您可以在 actions/starter-workflows 仓库中浏览工作流程模板的完整列表。

后续步骤

只要代码推送到仓库,您刚才添加的 super-linter 工作流程就会运行,以帮助您发现代码中的错误和不一致。 但是,这只是您可以对 GitHub Actions 执行操作的开始。 您的仓库可以包含多个基于不同事件触发不同任务的工作流程。 GitHub Actions 可以帮助您自动执行应用程序开发过程的几乎每个方面。 准备好开始了吗? 以下是一些帮助您对 GitHub Actions 执行后续操作的有用资源:

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。