Merge pull request #16 from T3pp31/codex/add-lightweight-ci-workflow-for-prs

PR/main向け軽量CIワークフローを追加

Author: T3pp31

.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  frontend-and-rust-check:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Rust cache
+        uses: swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            ./src-tauri -> target
+            ./tools/windows-bootstrapper -> target
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: "npm"
+
+      - name: Install Linux dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libwebkit2gtk-4.1-dev \
+            libappindicator3-dev \
+            librsvg2-dev \
+            patchelf \
+            libpcap-dev
+
+      - name: Install frontend dependencies
+        run: npm ci
+
+      - name: Lint frontend
+        run: npm run lint
+
+      - name: Build frontend
+        run: npm run build
+
+      - name: Run frontend tests
+        run: npm test
+
+      - name: Run repository consistency tests
+        run: npm run test:consistency
+
+      - name: Rust check
+        run: cargo check --manifest-path src-tauri/Cargo.toml
+
+      - name: Rust tests
+        run: cargo test --manifest-path src-tauri/Cargo.toml

CONTRIBUTING.md

@@ -53,5 +53,21 @@ npx tauri dev
 
 ## テスト
 
-- `node --test tests/buildRsConsistency.test.mjs tests/readmeConsistency.test.mjs tests/releaseWorkflowConsistency.test.mjs tests/repoCleanupConsistency.test.mjs`
-- `cargo test --manifest-path tools/windows-bootstrapper/Cargo.toml`
+PR / `main` push では `.github/workflows/ci.yml` が軽量 CI として動作し、リリース成果物を作る `.github/workflows/build-release.yml` とは分離しています。
+
+ローカルでも PR 前に最低限以下を確認してください。
+
+```bash
+npm run lint
+npm run build
+npm test
+npm run test:consistency
+cargo check --manifest-path src-tauri/Cargo.toml
+cargo test --manifest-path src-tauri/Cargo.toml
+```
+
+Windows bootstrapper を変更した場合は、追加で以下を実行してください。
+
+```bash
+cargo test --manifest-path tools/windows-bootstrapper/Cargo.toml
+```

README.md

@@ -140,13 +140,17 @@ Npcap SDK は以下のいずれかの方法で配置してください。
 | `npx tauri build` | リリースビルド |
 | `npm run build` | フロントエンドのみビルド |
 | `npm run lint` | ESLint によるコード検査 |
-| `npx vitest` | テスト実行 |
+| `npm test` | Vitest テスト実行 |
+| `npm run test:consistency` | `tests/*.test.mjs` の node:test 整合性チェック |
 | `npx vitest --coverage` | カバレッジ付きテスト実行 |
 | `node --test tests/buildRsConsistency.test.mjs` | `build.rs` の構造検証 |
 | `node --test tests/readmeConsistency.test.mjs` | README 整合性チェック |
 | `node --test tests/buildDelayLoadConsistency.test.mjs` | 遅延ロード設定の回帰チェック |
+| `node --test tests/ciWorkflowConsistency.test.mjs` | CI workflow / Contributor 文書の整合性チェック |
 | `node --test tests/releaseWorkflowConsistency.test.mjs` | Release / Contributor 文書の整合性チェック |
 | `node --test tests/repoCleanupConsistency.test.mjs` | 不要生成物・旧資産の再混入防止チェック |
+| `cargo check --manifest-path src-tauri/Cargo.toml` | Rust/Tauri バックエンドの型・依存関係チェック |
+| `cargo test --manifest-path src-tauri/Cargo.toml` | Rust/Tauri バックエンドの単体テスト |
 | `cargo test --manifest-path tools/windows-bootstrapper/Cargo.toml` | Windows bootstrapper の単体テスト |
 
 ## 設定

package.json

@@ -9,7 +9,9 @@
     "tauri:dev": "tauri dev",
     "build": "tsc -b && vite build",
     "lint": "eslint .",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "test": "vitest run",
+    "test:consistency": "node --test tests/*.test.mjs"
   },
   "dependencies": {
     "@tauri-apps/api": "^2.10.1",

tests/ciWorkflowConsistency.test.mjs

@@ -0,0 +1,42 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+const CI_WORKFLOW_PATH = resolve(import.meta.dirname, "..", ".github", "workflows", "ci.yml");
+const RELEASE_WORKFLOW_PATH = resolve(import.meta.dirname, "..", ".github", "workflows", "build-release.yml");
+const PACKAGE_JSON_PATH = resolve(import.meta.dirname, "..", "package.json");
+const CONTRIBUTING_PATH = resolve(import.meta.dirname, "..", "CONTRIBUTING.md");
+
+const ciWorkflow = readFileSync(CI_WORKFLOW_PATH, "utf-8");
+const releaseWorkflow = readFileSync(RELEASE_WORKFLOW_PATH, "utf-8");
+const packageJson = JSON.parse(readFileSync(PACKAGE_JSON_PATH, "utf-8"));
+const contributing = readFileSync(CONTRIBUTING_PATH, "utf-8");
+
+describe("CI workflow consistency", () => {
+  it("PR / main push 用の軽量 CI と release workflow が分離されていること", () => {
+    assert.match(ciWorkflow, /pull_request:/);
+    assert.match(ciWorkflow, /push:/);
+    assert.match(ciWorkflow, /branches:\n\s+- main/);
+    assert.doesNotMatch(ciWorkflow, /tagName:/);
+    assert.doesNotMatch(ciWorkflow, /tauri-apps\/tauri-action/);
+    assert.match(releaseWorkflow, /tags:\n\s+- "v\*"/);
+  });
+
+  it("frontend と Rust の最低限の検証コマンドを CI で実行すること", () => {
+    assert.match(ciWorkflow, /npm run lint/);
+    assert.match(ciWorkflow, /npm run build/);
+    assert.match(ciWorkflow, /npm test/);
+    assert.match(ciWorkflow, /npm run test:consistency/);
+    assert.match(ciWorkflow, /cargo check --manifest-path src-tauri\/Cargo\.toml/);
+    assert.match(ciWorkflow, /cargo test --manifest-path src-tauri\/Cargo\.toml/);
+  });
+
+  it("テスト用 npm scripts と CONTRIBUTING の案内が CI と一致していること", () => {
+    assert.equal(packageJson.scripts.test, "vitest run");
+    assert.equal(packageJson.scripts["test:consistency"], "node --test tests/*.test.mjs");
+    assert.match(contributing, /\.github\/workflows\/ci\.yml/);
+    assert.match(contributing, /npm run test:consistency/);
+    assert.match(contributing, /cargo test --manifest-path src-tauri\/Cargo\.toml/);
+  });
+});

tests/readmeConsistency.test.mjs

@@ -39,6 +39,7 @@ describe("README consistency", () => {
     assert.match(readme, /node --test tests\/buildRsConsistency\.test\.mjs/);
     assert.match(readme, /node --test tests\/readmeConsistency\.test\.mjs/);
     assert.match(readme, /node --test tests\/buildDelayLoadConsistency\.test\.mjs/);
+    assert.match(readme, /node --test tests\/ciWorkflowConsistency\.test\.mjs/);
     assert.match(readme, /node --test tests\/releaseWorkflowConsistency\.test\.mjs/);
     assert.match(readme, /node --test tests\/repoCleanupConsistency\.test\.mjs/);
     assert.match(readme, /cargo test --manifest-path tools\/windows-bootstrapper\/Cargo\.toml/);