GitHub Actions 实用参考

开发工具

2023-10-22 18:26:04

GitHub Actions 是一种功能强大的工具，可让您自动化开发工作流程。通过使用 GitHub Actions，您可以设置工作流，当满足某些触发条件时自动运行。这可以用于构建和测试代码、部署应用程序、发送通知等。

在本文中，我们将介绍 GitHub Actions 的一些最常见的用例，并提供一些有关如何使用它们的提示。

构建和测试代码

GitHub Actions 可以用于自动构建和测试代码。这可以帮助您在代码提交到主分支之前捕获错误，并确保您的代码始终处于良好的工作状态。

要使用 GitHub Actions 构建和测试代码，您可以使用以下步骤：

在 GitHub 存储库中创建一个名为 .github/workflows 的目录。
在此目录中创建一个新的工作流文件，扩展名为 .yml。
在工作流文件中，定义工作流的触发条件和要执行的任务。
将工作流文件推送到 GitHub。

以下是构建和测试代码的示例工作流文件：

name: Build and Test

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Install dependencies
        run: npm i

      - name: Build code
        run: npm run build

      - name: Test code
        run: npm test

部署应用程序

GitHub Actions 可用于自动部署应用程序。这可以帮助您快速、轻松地将您的应用程序部署到生产环境中。

要使用 GitHub Actions 部署应用程序，您可以使用以下步骤：

在 GitHub 存储库中创建一个名为 .github/workflows 的目录。
在此目录中创建一个新的工作流文件，扩展名为 .yml。
在工作流文件中，定义工作流的触发条件和要执行的任务。
将工作流文件推送到 GitHub。

以下是部署应用程序的示例工作流文件：

name: Deploy Application

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Build code
        run: npm run build

      - name: Deploy code
        run: ssh user@server.com 'mkdir -p /var/www/myapp; rsync -av /tmp/build/* /var/www/myapp'

发送通知

GitHub Actions 可用于自动发送通知。这可以帮助您在发生某些事件时收到通知，例如当有人提交了拉取请求、当构建失败或当应用程序部署成功时。

要使用 GitHub Actions 发送通知，您可以使用以下步骤：

在 GitHub 存储库中创建一个名为 .github/workflows 的目录。
在此目录中创建一个新的工作流文件，扩展名为 .yml。
在工作流文件中，定义工作流的触发条件和要执行的任务。
将工作流文件推送到 GitHub。

以下是发送通知的示例工作流文件：

name: Send Notification

on:
  push:
    branches:
      - master

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Send notification
        run: curl -X POST https://my.webhook.url -d '{"message": "Build successful"}'