Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ node ~/.commitlore/dist/commitlore.mjs context src/auth --no-index

コミット済み bundle は build なしで動きます。ただし native module `better-sqlite3` は bundle に含まれないため、clone だけでは SQLite index を開けません。`--no-index` で Git を直接 scan するか、clone 内で `npm install` を実行して現在の index を有効にします。native module を外す決定は [ADR-0012](docs/adr/ADR-0012-drop-the-native-dependency.md) に記録されています。

## GitHub Actions

query、guard、inject を実行する job は全 history を取得する必要があります。

```yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```

MCP client には同じ clone の entry point を登録します。

```json
Expand Down
10 changes: 10 additions & 0 deletions README.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ node ~/.commitlore/dist/commitlore.mjs context src/auth --no-index

커밋된 번들은 빌드 없이 실행된다. 단, 네이티브 `better-sqlite3` 모듈은 번들에 들어 있지 않으므로 clone만으로는 SQLite 인덱스를 열 수 없다. `--no-index`로 Git을 직접 스캔하거나 clone 안에서 `npm install`을 실행해 현재 인덱스를 활성화한다. 네이티브 모듈 제거 결정은 [ADR-0012](docs/adr/ADR-0012-drop-the-native-dependency.md)에 기록돼 있다.

## GitHub Actions

query, guard 또는 inject 명령을 실행하는 job은 전체 history를 받아야 한다.

```yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```

MCP 클라이언트에는 같은 clone의 진입점을 등록한다.

```json
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ node ~/.commitlore/dist/commitlore.mjs context src/auth --no-index

The committed bundle runs without a build. One caveat remains: it does not carry the native `better-sqlite3` module, so a clone alone cannot open the SQLite index. Use `--no-index` to scan Git directly, or run `npm install` inside the clone to enable the current index. The accepted migration away from the native module is recorded in [ADR-0012](docs/adr/ADR-0012-drop-the-native-dependency.md).

## GitHub Actions

Jobs that run a query, guard, or inject command must fetch the complete history:

```yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```

For an MCP client, register the same cloned entry point:

```json
Expand Down
10 changes: 10 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ node ~/.commitlore/dist/commitlore.mjs context src/auth --no-index

仓库中提交的 bundle 无需构建即可运行。但它没有携带原生 `better-sqlite3` 模块,因此仅靠 clone 无法打开 SQLite 索引。可以使用 `--no-index` 直接扫描 Git,或在 clone 中运行 `npm install` 来启用当前索引。移除原生模块的决定记录在 [ADR-0012](docs/adr/ADR-0012-drop-the-native-dependency.md) 中。

## GitHub Actions

运行 query、guard 或 inject 命令的 job 必须获取完整 history。

```yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```

在 MCP 客户端中注册同一 clone 的入口:

```json
Expand Down
6 changes: 5 additions & 1 deletion dist/commands/doctor.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/commands/doctor.js.map

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions dist/commands/guard.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/commands/guard.js.map

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions dist/commands/inject.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/commands/inject.js.map

Large diffs are not rendered by default.

Loading
Loading