Skip to content

Commit 9ae7b75

Browse files
authored
Merge pull request #21 from catuscio/develop
Release v1.5.0
2 parents cfe9759 + 38fd6b8 commit 9ae7b75

14 files changed

Lines changed: 2233 additions & 1448 deletions

.github/workflows/wiki-as-readme-action.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ on:
3131
type: boolean
3232
required: false
3333
default: false
34+
is_comprehensive_view:
35+
description: 'Generate comprehensive wiki with more pages (true/false)'
36+
type: boolean
37+
required: false
38+
default: true
3439
commit_method:
3540
description: 'How to apply changes'
3641
type: choice
@@ -72,12 +77,13 @@ jobs:
7277
7378
# 2. Generate Wiki Content & Sync
7479
- name: Generate Content (and Sync to Notion if enabled)
75-
uses: docker://ghcr.io/catuscio/wiki-as-readme-action:latest
80+
uses: catuscio/wiki-as-readme@v1.5.0
7681
env:
7782
# --- Basic Settings ---
7883
# Use input if available, otherwise default to 'en' (e.g., for push events)
7984
LANGUAGE: ${{ inputs.language || 'en' }}
8085
WIKI_OUTPUT_PATH: ${{ env.WIKI_OUTPUT_PATH }}
86+
IS_COMPREHENSIVE_VIEW: ${{ inputs.is_comprehensive_view == '' && 'true' || inputs.is_comprehensive_view }}
8187

8288
# --- LLM Provider and Model Settings ---
8389
LLM_PROVIDER: ${{ inputs.llm_provider || 'google' }}

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ LABEL org.opencontainers.image.description="Turn your codebase into a comprehens
2323
LABEL org.opencontainers.image.licenses="MIT"
2424
LABEL org.opencontainers.image.authors="catuscio <catuscio@hotmail.com>"
2525
LABEL org.opencontainers.image.title="wiki-as-readme"
26-
LABEL org.opencontainers.image.version="1.3.0"
26+
LABEL org.opencontainers.image.version="1.5.0"
2727

2828
RUN useradd -m -u 1000 appuser
2929

Dockerfile.action

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ LABEL org.opencontainers.image.description="Turn your codebase into a comprehens
2626
LABEL org.opencontainers.image.licenses="MIT"
2727
LABEL org.opencontainers.image.authors="catuscio <catuscio@hotmail.com>"
2828
LABEL org.opencontainers.image.title="wiki-as-readme"
29-
LABEL org.opencontainers.image.version="1.3.0"
29+
LABEL org.opencontainers.image.version="1.5.0"
3030

3131
WORKDIR /app
3232

Dockerfile.server

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ LABEL org.opencontainers.image.description="Turn your codebase into a comprehens
2222
LABEL org.opencontainers.image.licenses="MIT"
2323
LABEL org.opencontainers.image.authors="catuscio <catuscio@hotmail.com>"
2424
LABEL org.opencontainers.image.title="wiki-as-readme-server"
25-
LABEL org.opencontainers.image.version="1.3.0"
25+
LABEL org.opencontainers.image.version="1.5.0"
2626

2727
RUN useradd -m -u 1000 appuser
2828

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@ Optionally sync the generated content to a Notion Database.
139139
type: boolean
140140
required: false
141141
default: false
142+
is_comprehensive_view:
143+
description: 'Generate comprehensive wiki with more pages (true/false)'
144+
type: boolean
145+
required: false
146+
default: true
142147
commit_method:
143148
description: 'How to apply changes'
144149
type: choice
@@ -147,6 +152,10 @@ Optionally sync the generated content to a Notion Database.
147152
- pull-request
148153
default: 'push'
149154

155+
concurrency:
156+
group: wiki-update-${{ github.ref }}
157+
cancel-in-progress: true
158+
150159
jobs:
151160
wiki-time:
152161
runs-on: ubuntu-latest
@@ -180,13 +189,14 @@ Optionally sync the generated content to a Notion Database.
180189
181190
# 2. Generate Wiki Content & Sync
182191
- name: Generate Content (and Sync to Notion if enabled)
183-
uses: docker://ghcr.io/catuscio/wiki-as-readme-action:latest
192+
uses: catuscio/wiki-as-readme@v1.5.0
184193
env:
185194
# --- Basic Settings ---
186195
# Use input if available, otherwise default to 'en' (e.g., for push events)
187196
LANGUAGE: ${{ inputs.language || 'en' }}
188197
WIKI_OUTPUT_PATH: ${{ env.WIKI_OUTPUT_PATH }}
189-
198+
IS_COMPREHENSIVE_VIEW: ${{ inputs.is_comprehensive_view == '' && 'true' || inputs.is_comprehensive_view }}
199+
190200
# --- LLM Provider and Model Settings ---
191201
LLM_PROVIDER: ${{ inputs.llm_provider || 'google' }}
192202
MODEL_NAME: ${{ inputs.model_name || 'gemini-2.5-flash' }}
@@ -366,6 +376,7 @@ See [`.env.example`](.env.example) for a complete template with comments.
366376
| | `temperature` | LLM randomness (0.0 = deterministic, 1.0 = creative) | `0.0` |
367377
| | `max_retries` | Retry count for failed LLM requests | `3` |
368378
| | `max_concurrency` | Max parallel LLM calls (prevents rate limits) | `5` |
379+
| | `llm_timeout` | Timeout in seconds for each LLM request | `300` |
369380
| **Auth** | `OPENAI_API_KEY` | OpenAI API Key | — |
370381
| | `ANTHROPIC_API_KEY` | Anthropic API Key | — |
371382
| | `OPENROUTER_API_KEY` | OpenRouter API Key | — |
@@ -377,6 +388,7 @@ See [`.env.example`](.env.example) for a complete template with comments.
377388
| | `WIKI_OUTPUT_PATH` | Path to save generated wiki | `./WIKI.md` |
378389
| | `LOCAL_REPO_PATH` | Local repo path for Docker mounting | `.` |
379390
| | `IGNORED_PATTERNS` | **JSON array** of glob patterns to exclude from analysis | (see `config.py`) |
391+
| | `IS_COMPREHENSIVE_VIEW` | Generate comprehensive wiki (8-12 pages) vs concise (4-6 pages) | `true` |
380392
| **Notion** | `NOTION_SYNC_ENABLED` | Sync to Notion after generation | `false` |
381393
| | `NOTION_API_KEY` | Notion Integration Token | — |
382394
| | `NOTION_DATABASE_ID` | Target Notion Database ID | — |

README_ko.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@
139139
type: boolean
140140
required: false
141141
default: false
142+
is_comprehensive_view:
143+
description: 'Generate comprehensive wiki with more pages (true/false)'
144+
type: boolean
145+
required: false
146+
default: true
142147
commit_method:
143148
description: 'How to apply changes'
144149
type: choice
@@ -147,6 +152,10 @@
147152
- pull-request
148153
default: 'push'
149154

155+
concurrency:
156+
group: wiki-update-${{ github.ref }}
157+
cancel-in-progress: true
158+
150159
jobs:
151160
wiki-time:
152161
runs-on: ubuntu-latest
@@ -180,13 +189,14 @@
180189
181190
# 2. Generate Wiki Content & Sync
182191
- name: Generate Content (and Sync to Notion if enabled)
183-
uses: docker://ghcr.io/catuscio/wiki-as-readme-action:latest
192+
uses: catuscio/wiki-as-readme@v1.5.0
184193
env:
185194
# --- Basic Settings ---
186195
# Use input if available, otherwise default to 'en' (e.g., for push events)
187196
LANGUAGE: ${{ inputs.language || 'en' }}
188197
WIKI_OUTPUT_PATH: ${{ env.WIKI_OUTPUT_PATH }}
189-
198+
IS_COMPREHENSIVE_VIEW: ${{ inputs.is_comprehensive_view == '' && 'true' || inputs.is_comprehensive_view }}
199+
190200
# --- LLM Provider and Model Settings ---
191201
LLM_PROVIDER: ${{ inputs.llm_provider || 'google' }}
192202
MODEL_NAME: ${{ inputs.model_name || 'gemini-2.5-flash' }}
@@ -366,6 +376,7 @@ GitHub 등의 웹훅 요청을 처리할 수 있는 API 서버로 배포할 수
366376
| | `temperature` | LLM 무작위성 (0.0 = 결정적, 1.0 = 창의적) | `0.0` |
367377
| | `max_retries` | LLM 요청 실패 시 재시도 횟수 | `3` |
368378
| | `max_concurrency` | 최대 병렬 LLM 호출 수 (rate limit 방지) | `5` |
379+
| | `llm_timeout` | LLM 요청당 타임아웃 (초) | `300` |
369380
| **인증** | `OPENAI_API_KEY` | OpenAI API 키 | — |
370381
| | `ANTHROPIC_API_KEY` | Anthropic API 키 | — |
371382
| | `OPENROUTER_API_KEY` | OpenRouter API 키 | — |
@@ -377,6 +388,7 @@ GitHub 등의 웹훅 요청을 처리할 수 있는 API 서버로 배포할 수
377388
| | `WIKI_OUTPUT_PATH` | 생성된 위키 저장 경로 | `./WIKI.md` |
378389
| | `LOCAL_REPO_PATH` | 도커 마운트용 로컬 저장소 경로 | `.` |
379390
| | `IGNORED_PATTERNS` | 분석에서 제외할 파일 패턴 (**JSON 배열**) | (`config.py` 참조) |
391+
| | `IS_COMPREHENSIVE_VIEW` | 상세 위키(8-12페이지) vs 간결 위키(4-6페이지) | `true` |
380392
| **노션** | `NOTION_SYNC_ENABLED` | 생성 후 노션 동기화 여부 | `false` |
381393
| | `NOTION_API_KEY` | 노션 통합 토큰 | — |
382394
| | `NOTION_DATABASE_ID` | 대상 노션 데이터베이스 ID | — |

WIKI-AS-README-AS-ACTION.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
7777
# 2. Generate Wiki Content & Sync
7878
- name: Generate Content (and Sync to Notion if enabled)
79-
uses: docker://ghcr.io/catuscio/wiki-as-readme-action:latest
79+
uses: catuscio/wiki-as-readme@v1.5.0
8080
env:
8181
# --- Basic Settings ---
8282
# Use input if available, otherwise default to 'en' (e.g., for push events)

0 commit comments

Comments
 (0)