VHS Action 安装与配置指南

VHS Action 安装与配置指南

vhs-action Keep your GIFs up to date with VHS + GitHub actions 📽️ 项目地址: https://gitcode.com/gh_mirrors/vh/vhs-action

1. 项目基础介绍

VHS Action 是一个开源项目，它利用 GitHub Actions 和 VHS 工具自动生成和更新 GIF 图片。该项目主要用于在持续集成（CI）过程中，根据 .tape 文件生成 GIF 动画，非常适合用于展示项目演示或进行集成测试。

主要编程语言：TypeScript 和 JavaScript。

2. 项目使用的关键技术和框架

• GitHub Actions：GitHub 提供的自动化您的软件开发工作流程的工具。
• VHS：一个命令行工具，用于生成类似视频播放器界面中的 GIF 动画。

3. 项目安装和配置的准备工作与详细步骤

准备工作：

• GitHub 账号
• 本地安装 Git
• 对 GitHub Actions 有基本的了解

安装步骤：

步骤 1: 创建 GitHub 仓库

首先，在 GitHub 上创建一个新的仓库。

步骤 2: 添加 VHS Action 工作流

在你的项目目录中创建一个名为 .github/workflows/vhs.yml 的文件。这个文件将定义 GitHub Actions 的工作流程。

name: VHS Action Workflow

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  generate-gif:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      
      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'
      
      - name: Install VHS
        run: npm install -g vhs
      
      - name: Generate GIF
        uses: charmbracelet/vhs-action@v1
        with:
          path: './path/to/your.tape'

在上述 vhs.yml 文件中，你需要将 './path/to/your.tape' 替换为你的 .tape 文件的实际路径。

步骤 3: 创建 .tape 文件

按照 VHS 的要求创建 .tape 文件，这个文件包含了生成 GIF 的指令。确保 .tape 文件放在你的项目目录中。

步骤 4: 触发工作流程

现在，每当你在 main 分支上创建一个 pull request 或进行一次 commit 时，GitHub Actions 都会自动运行 generate-gif 工作流程，根据 .tape 文件生成 GIF 并更新到你的仓库中。

按照以上步骤，你就可以成功安装并配置 VHS Action，自动化你的 GIF 生成流程。

vhs-action Keep your GIFs up to date with VHS + GitHub actions 📽️ 项目地址: https://gitcode.com/gh_mirrors/vh/vhs-action