# workflows

**Repository Path**: avotokyo/workflows

## Basic Information

- **Project Name**: workflows
- **Description**: 面向 TypeScript / Vite+ 项目的可复用 GitHub Actions 集合。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-26
- **Last Updated**: 2026-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# avotokyo/workflows

面向 TypeScript / Vite+ 项目的可复用 [GitHub Actions](https://github.com/features/actions) 集合。

> [!NOTE]
> 推荐优先使用**组合 Workflow**（`unit-test`、`release`）快速接入。完整组件列表、inputs、permissions 与扩展示例见 [skills/avotokyo-workflows](./skills/avotokyo-workflows)。

## 安装

在消费方仓库的 `.github/workflows/*.yml` 中引用（将 `@main` 替换为 tag 或 commit SHA）：

```yaml
jobs:
  test:
    uses: avotokyo/workflows/.github/workflows/unit-test.yml@main
```

为 Cursor 等 Agent 安装详细使用说明：

```bash
pnpx skills add avotokyo/workflows --skill=avotokyo-workflows
```

## 推荐入口

| Workflow    | 路径            | 说明                                                      |
| ----------- | --------------- | --------------------------------------------------------- |
| `unit-test` | `unit-test.yml` | CI：Check + 多 OS / Node 矩阵测试                         |
| `release`   | `release.yml`   | 发布：Changelog + 按 `type` 发布（npm / GitHub Packages） |
| `deploy`    | `deploy-pages.yml` | 部署：构建静态站点并发布到 GitHub Pages              |

## 快速上手

### CI

```yaml
name: CI
on: [push, pull_request]

jobs:
  test:
    uses: avotokyo/workflows/.github/workflows/unit-test.yml@main
```

### 发布

```yaml
name: Release
on:
  push:
    tags: ["v*"]

jobs:
  release:
    uses: avotokyo/workflows/.github/workflows/release.yml@main
    with:
      publish: true
      build: vp run build
    permissions:
      contents: write
      id-token: write
```

发布到 GitHub Packages 时增加 `type: github`，并将 `permissions` 改为 `contents: write` + `packages: write`。

### 部署到 GitHub Pages

仓库 Settings → Pages → Source 需选 **GitHub Actions**。

```yaml
name: Deploy
on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  deploy:
    uses: avotokyo/workflows/.github/workflows/deploy-pages.yml@main
    permissions:
      contents: read
      pages: write
      id-token: write
```

Rspress 等输出到 `doc_build` 的项目：

```yaml
jobs:
  deploy:
    uses: avotokyo/workflows/.github/workflows/deploy-pages.yml@main
    permissions:
      contents: read
      pages: write
      id-token: write
    with:
      artifact-path: doc_build
      fetch-all: true
```

---


## 文档

| 文档                                                     | 说明               |
| -------------------------------------------------------- | ------------------ |
| [ARCHITECTURE.md](./ARCHITECTURE.md)                     | 三层架构与目录约定 |
| [skills/avotokyo-workflows](./skills/avotokyo-workflows) | Agent 完整组件参考 |

Forked from [sxzz/workflows](https://github.com/sxzz/workflows)