Turnstyle GitHub Action 使用教程

1. 项目介绍

Turnstyle 是一个用于序列化 GitHub Actions 工作流运行的 GitHub Action。GitHub Actions 是一个事件驱动的系统，工作流在响应事件时独立触发，缺乏协调。在共享仓库中，如果多人同时合并拉取请求，每个请求都会独立触发工作流，这可能导致连续部署过程中的问题。Turnstyle 旨在解决这一问题，确保在当前部署完成之前，不会触发新的工作流。

2. 项目快速启动

2.1 添加 Turnstyle 到工作流

首先，在你的 GitHub 仓库中创建或编辑一个 .github/workflows/main.yml 文件。然后，按照以下步骤添加 Turnstyle 到你的工作流中：

name: Main

on:
  push:
    branches:
      - main

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Turnstyle
        uses: softprops/turnstyle@v2

      - name: Deploy
        run: sleep 30

2.2 配置超时设置

为了避免长时间等待，你可以设置超时时间。例如，设置 timeout-minutes 为 5 分钟：

name: Main

on:
  push:
    branches:
      - main

jobs:
  main:
    timeout-minutes: 5
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Turnstyle
        uses: softprops/turnstyle@v2

      - name: Deploy
        run: sleep 30

2.3 继续或中止设置

你还可以设置在特定时间后继续或中止工作流：

name: Main

on:
  push:
    branches:
      - main

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Turnstyle
        uses: softprops/turnstyle@v2
        with:
          continue-after-seconds: 180

      - name: Deploy
        run: sleep 30

3. 应用案例和最佳实践

3.1 连续部署中的使用

在连续部署过程中，确保每次部署完成后才进行下一次部署是非常重要的。Turnstyle 可以帮助你实现这一点，避免多个部署同时进行导致的冲突。

3.2 并发控制

在需要严格控制并发操作的场景中，Turnstyle 可以确保只有一个工作流在运行，避免资源竞争和数据冲突。

4. 典型生态项目

4.1 GitHub Actions

Turnstyle 是 GitHub Actions 生态系统的一部分，用于增强工作流的协调和管理。

4.2 CI/CD 工具

Turnstyle 可以与各种 CI/CD 工具集成，确保在复杂的部署环境中保持工作流的顺序和一致性。

通过以上步骤和案例，你可以快速上手并有效使用 Turnstyle GitHub Action。