@chappibunny/repolens 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +45 -0
- package/README.md +28 -11
- package/package.json +1 -1
- package/src/ai/generate-sections.js +0 -6
- package/src/ai/provider.js +19 -13
- package/src/core/config-schema.js +26 -1
- package/src/init.js +0 -3
- package/src/publishers/github-wiki.js +454 -0
- package/src/publishers/index.js +23 -1
- package/src/utils/branch.js +27 -0
- package/src/utils/validate.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,13 +2,58 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to RepoLens will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## 1.1.0
|
|
6
|
+
|
|
7
|
+
### ✨ GitHub Wiki Publisher UX Enhancement
|
|
8
|
+
|
|
9
|
+
Major upgrade to the wiki output quality — better information hierarchy, audience-aware navigation, and richer page structure.
|
|
10
|
+
|
|
11
|
+
- **Audience-grouped Home page**: Pages organized by reader (Stakeholders, Engineers, New Contributors, Change Tracking) instead of a flat list
|
|
12
|
+
- **Page descriptions**: Each link on Home includes a one-line summary of the page's purpose
|
|
13
|
+
- **Status rail**: Home page now shows a metadata table (project, branch, page count, publisher, source)
|
|
14
|
+
- **Recommended reading order**: Guided path through the docs for first-time readers
|
|
15
|
+
- **Grouped sidebar**: Navigation split into Overview and Architecture sections (plus Custom Pages)
|
|
16
|
+
- **Page metadata headers**: Every page gets a `[← Home](Home)` back-link, audience tag, and branch indicator
|
|
17
|
+
- **Cleaner footer**: Compact format with branch context and Home link
|
|
18
|
+
- **New constants**: `PAGE_DESCRIPTIONS`, `AUDIENCE_GROUPS`, `SIDEBAR_GROUPS`, `PAGE_AUDIENCE`
|
|
19
|
+
- **New helpers**: `getPageDisplayTitle()`, `getCustomPageKeys()`, `wikiLink()`, `pageHeader()`
|
|
20
|
+
|
|
21
|
+
### 🐛 Bug Fixes
|
|
22
|
+
- **Temperature still sent to GPT-5**: `DEFAULT_TEMPERATURE = 0.2` always leaked into API requests even after v1.0.1 fixes — the fallback chain (`temperature ?? aiConfig.temperature ?? DEFAULT_TEMPERATURE`) guaranteed it was never `undefined`. Removed the default entirely; temperature is now only sent when explicitly configured via `REPOLENS_AI_TEMPERATURE` env var or `ai.temperature` in config.
|
|
23
|
+
|
|
24
|
+
## 1.0.1
|
|
25
|
+
|
|
26
|
+
### 🐛 Bug Fixes
|
|
27
|
+
- **GPT-5 API compatibility**: Use `max_completion_tokens` instead of deprecated `max_tokens` parameter
|
|
28
|
+
- **GPT-5 temperature handling**: Omit `temperature` from API requests for models that only support the default value (e.g. gpt-5-mini)
|
|
29
|
+
- Removed all hardcoded `temperature: 0.2` overrides from AI section generators
|
|
30
|
+
- Removed `REPOLENS_AI_TEMPERATURE` from CI workflow and `.env.example`
|
|
31
|
+
- Updated `init` scaffolding to omit temperature from default config
|
|
32
|
+
|
|
33
|
+
### 🔧 Improvements
|
|
34
|
+
- Upgraded GitHub Actions: checkout v4.2.2, setup-node v4.2.0, Node.js 22
|
|
35
|
+
|
|
5
36
|
## 1.0.0
|
|
6
37
|
|
|
7
38
|
### 🎉 Stable Release
|
|
8
39
|
|
|
9
40
|
RepoLens v1.0.0 marks the first stable release with a frozen public API. All CLI commands, configuration schema, and plugin interfaces are now covered by semantic versioning guarantees. See [STABILITY.md](STABILITY.md) for the full contract.
|
|
10
41
|
|
|
42
|
+
### ✨ New Features
|
|
43
|
+
- **GitHub Wiki Publisher**: Publish documentation directly to your repository's Wiki tab
|
|
44
|
+
- Git-based: clones wiki repo, writes pages, commits and pushes
|
|
45
|
+
- Generates `Home.md` index, `_Sidebar.md` navigation, `_Footer.md`
|
|
46
|
+
- Branch filtering via `github_wiki.branches` in `.repolens.yml`
|
|
47
|
+
- Auto-detects repository from `GITHUB_REPOSITORY` env or git remote
|
|
48
|
+
- Token sanitization in error messages (never leaks `GITHUB_TOKEN`)
|
|
49
|
+
- Config: `sidebar` and `footer` toggles
|
|
50
|
+
- 17 tests covering publishing, branch filtering, config validation, and security
|
|
51
|
+
|
|
11
52
|
### 🐛 Bug Fixes
|
|
53
|
+
- **GPT-5 API compatibility**: Use `max_completion_tokens` instead of deprecated `max_tokens` parameter
|
|
54
|
+
- **GPT-5 temperature handling**: Omit `temperature` from API requests for models that only support the default value (e.g. gpt-5-mini)
|
|
55
|
+
- **Git identity in wiki publisher**: Set committer name/email (`RepoLens Bot`) so CI runners can commit
|
|
56
|
+
- **Publisher allowlist**: Added `github_wiki` to `validate.js` publisher validation (was only in `config-schema.js`)
|
|
12
57
|
- **Doctor false-success**: `repolens doctor` now correctly exits with code 2 when `runDoctor()` reports failures (previously always printed "validation passed")
|
|
13
58
|
- **Feedback exit code**: `repolens feedback` now exits with code 1 when feedback fails to send (previously exited 0)
|
|
14
59
|
- **Unknown flags**: `repolens --unknown-flag` now prints an error instead of silently running publish
|
package/README.md
CHANGED
|
@@ -124,7 +124,7 @@ RepoLens automatically detects:
|
|
|
124
124
|
✅ **Deterministic Fallback** - Always generates docs even if AI unavailable
|
|
125
125
|
✅ **Business Domain Inference** - Automatically maps code to business functions
|
|
126
126
|
✅ **Data Flow Analysis** - Understands how information moves through your system
|
|
127
|
-
✅ **Multiple Publishers** - Output to Notion, Confluence, Markdown, or all
|
|
127
|
+
✅ **Multiple Publishers** - Output to Notion, Confluence, GitHub Wiki, Markdown, or all four
|
|
128
128
|
✅ **Branch-Aware** - Prevent doc conflicts across branches
|
|
129
129
|
✅ **GitHub Actions** - Autonomous operation on every push
|
|
130
130
|
✅ **Team Notifications** - Discord integration with rich embeds (NEW in v0.6.0)
|
|
@@ -313,6 +313,14 @@ publishers:
|
|
|
313
313
|
```
|
|
314
314
|
Maximum visibility: Notion for async collaboration, Confluence for enterprise docs, Markdown for local backups.
|
|
315
315
|
|
|
316
|
+
**GitHub Wiki** (ideal for open source):
|
|
317
|
+
```yaml
|
|
318
|
+
publishers:
|
|
319
|
+
- github_wiki
|
|
320
|
+
- markdown
|
|
321
|
+
```
|
|
322
|
+
Docs live alongside your code — accessible from the repo's Wiki tab. Requires `GITHUB_TOKEN`.
|
|
323
|
+
|
|
316
324
|
### Step 3: Enable AI Features (Optional)
|
|
317
325
|
|
|
318
326
|
**AI-enhanced documentation adds natural language explanations for non-technical audiences.**
|
|
@@ -336,7 +344,6 @@ REPOLENS_AI_API_KEY=sk-xxxxxxxxxxxxx
|
|
|
336
344
|
# Optional: Customize provider
|
|
337
345
|
REPOLENS_AI_BASE_URL=https://api.openai.com/v1
|
|
338
346
|
REPOLENS_AI_MODEL=gpt-5-mini
|
|
339
|
-
REPOLENS_AI_TEMPERATURE=0.3
|
|
340
347
|
REPOLENS_AI_MAX_TOKENS=2000
|
|
341
348
|
```
|
|
342
349
|
|
|
@@ -346,7 +353,6 @@ REPOLENS_AI_MAX_TOKENS=2000
|
|
|
346
353
|
ai:
|
|
347
354
|
enabled: true # Enable AI features
|
|
348
355
|
mode: hybrid # hybrid, full, or off
|
|
349
|
-
temperature: 0.3 # Lower = more focused (0.0-1.0)
|
|
350
356
|
max_tokens: 2000 # Token limit per request
|
|
351
357
|
|
|
352
358
|
features:
|
|
@@ -944,11 +950,14 @@ features:
|
|
|
944
950
|
| `configVersion` | number | **Yes** | Schema version (must be `1`) |
|
|
945
951
|
| `project.name` | string | Yes | Project name |
|
|
946
952
|
| `project.docs_title_prefix` | string | No | Prefix for documentation titles (default: project name) |
|
|
947
|
-
| `publishers` | array | Yes | Output targets: `notion`, `confluence`, `markdown` (+ plugin publishers) |
|
|
953
|
+
| `publishers` | array | Yes | Output targets: `notion`, `confluence`, `github_wiki`, `markdown` (+ plugin publishers) |
|
|
948
954
|
| `plugins` | array | No | Plugin paths or npm package names |
|
|
949
955
|
| `notion.branches` | array | No | Branch whitelist for Notion publishing. Supports globs. |
|
|
950
956
|
| `notion.includeBranchInTitle` | boolean | No | Add `[branch-name]` to titles (default: `true`) |
|
|
951
957
|
| `confluence.branches` | array | No | Branch whitelist for Confluence publishing. Supports globs. |
|
|
958
|
+
| `github_wiki.branches` | array | No | Branch whitelist for GitHub Wiki publishing. Supports globs. |
|
|
959
|
+
| `github_wiki.sidebar` | boolean | No | Generate `_Sidebar.md` navigation (default: `true`) |
|
|
960
|
+
| `github_wiki.footer` | boolean | No | Generate `_Footer.md` (default: `true`) |
|
|
952
961
|
| `discord.enabled` | boolean | No | Enable Discord notifications (default: `true` if webhook set) |
|
|
953
962
|
| `discord.notifyOn` | string | No | Notification policy: `always`, `significant`, `never` (default: `significant`) |
|
|
954
963
|
| `discord.significantThreshold` | number | No | Change % threshold for notifications (default: `10`) |
|
|
@@ -962,8 +971,8 @@ features:
|
|
|
962
971
|
| `features` | object | No | Feature flags (boolean values) |
|
|
963
972
|
| `ai.enabled` | boolean | No | Enable AI-powered documentation |
|
|
964
973
|
| `ai.mode` | string | No | AI mode: `hybrid`, `full`, or `off` |
|
|
965
|
-
| `ai.temperature` | number | No | Generation temperature (0
|
|
966
|
-
| `ai.max_tokens` | number | No | Max tokens per request (>0) |
|
|
974
|
+
| `ai.temperature` | number | No | Generation temperature (0–2). Not supported by all models (e.g. gpt-5-mini ignores it) |
|
|
975
|
+
| `ai.max_tokens` | number | No | Max completion tokens per request (>0) |
|
|
967
976
|
|
|
968
977
|
---
|
|
969
978
|
|
|
@@ -993,6 +1002,13 @@ Optional for Discord notifications:
|
|
|
993
1002
|
|----------|----------|-------------|
|
|
994
1003
|
| `DISCORD_WEBHOOK_URL` | No | Discord webhook URL for team notifications |
|
|
995
1004
|
|
|
1005
|
+
Required for GitHub Wiki publisher:
|
|
1006
|
+
|
|
1007
|
+
| Variable | Required | Description |
|
|
1008
|
+
|----------|----------|-------------|
|
|
1009
|
+
| `GITHUB_TOKEN` | Yes | Personal access token or Actions `${{ secrets.GITHUB_TOKEN }}` |
|
|
1010
|
+
| `GITHUB_REPOSITORY` | No | `owner/repo` (auto-detected from git remote in Actions) |
|
|
1011
|
+
|
|
996
1012
|
**Local Development:** Create `.env` file in project root
|
|
997
1013
|
**GitHub Actions:** Add as repository secrets in Settings → Secrets and variables → Actions
|
|
998
1014
|
|
|
@@ -1077,7 +1093,7 @@ npm test
|
|
|
1077
1093
|
- Integration workflows
|
|
1078
1094
|
- Doctor command validation
|
|
1079
1095
|
|
|
1080
|
-
**Coverage:**
|
|
1096
|
+
**Coverage:** 180 tests passing across 15 test files
|
|
1081
1097
|
|
|
1082
1098
|
### Test Package Installation Locally
|
|
1083
1099
|
|
|
@@ -1137,6 +1153,7 @@ repolens/
|
|
|
1137
1153
|
│ │ ├── publish.js # Publishing pipeline
|
|
1138
1154
|
│ │ ├── notion.js # Notion API integration
|
|
1139
1155
|
│ │ ├── confluence.js # Confluence REST API integration
|
|
1156
|
+
│ │ ├── github-wiki.js # GitHub Wiki publisher (git-based)
|
|
1140
1157
|
│ │ └── markdown.js # Local Markdown generation
|
|
1141
1158
|
│ ├── integrations/
|
|
1142
1159
|
│ │ └── discord.js # Discord webhook notifications
|
|
@@ -1156,7 +1173,7 @@ repolens/
|
|
|
1156
1173
|
│ ├── telemetry.js # Opt-in error tracking + performance timers
|
|
1157
1174
|
│ ├── errors.js # Enhanced error messages with guidance
|
|
1158
1175
|
│ └── update-check.js # Version update notifications
|
|
1159
|
-
├── tests/ # Vitest test suite (
|
|
1176
|
+
├── tests/ # Vitest test suite (180 tests across 15 files)
|
|
1160
1177
|
├── .repolens.yml # Dogfooding config
|
|
1161
1178
|
├── package.json
|
|
1162
1179
|
├── CHANGELOG.md
|
|
@@ -1218,7 +1235,7 @@ See [RELEASE.md](./RELEASE.md) for detailed workflow.
|
|
|
1218
1235
|
- [x] CLI commands: `init`, `doctor`, `publish`, `migrate`, `watch`, `feedback`, `version`, `help`
|
|
1219
1236
|
- [x] Config schema v1 with validation (frozen)
|
|
1220
1237
|
- [x] Auto-discovery of `.repolens.yml`
|
|
1221
|
-
- [x] Publishers: Notion + Confluence + Markdown
|
|
1238
|
+
- [x] Publishers: Notion + Confluence + GitHub Wiki + Markdown
|
|
1222
1239
|
- [x] Branch-aware publishing with filtering
|
|
1223
1240
|
- [x] Smart tech stack detection from package.json
|
|
1224
1241
|
- [x] Unicode dependency diagrams (no external deps)
|
|
@@ -1227,7 +1244,7 @@ See [RELEASE.md](./RELEASE.md) for detailed workflow.
|
|
|
1227
1244
|
- [x] GitHub Actions automation (publish + release)
|
|
1228
1245
|
- [x] PR architecture diff comments
|
|
1229
1246
|
- [x] Performance guardrails (10k warning, 50k limit)
|
|
1230
|
-
- [x] Comprehensive test suite (
|
|
1247
|
+
- [x] Comprehensive test suite (180 tests across 15 files)
|
|
1231
1248
|
- [x] Security hardening (secret detection, injection prevention, fuzzing)
|
|
1232
1249
|
- [x] Discord notifications with rich embeds
|
|
1233
1250
|
- [x] Documentation coverage & health scoring
|
|
@@ -1250,7 +1267,7 @@ See [RELEASE.md](./RELEASE.md) for detailed workflow.
|
|
|
1250
1267
|
|
|
1251
1268
|
### Future
|
|
1252
1269
|
|
|
1253
|
-
- [ ] Additional publishers (
|
|
1270
|
+
- [ ] Additional publishers (Obsidian)
|
|
1254
1271
|
- [ ] VS Code extension
|
|
1255
1272
|
- [ ] GitHub App
|
|
1256
1273
|
|
package/package.json
CHANGED
|
@@ -25,7 +25,6 @@ export async function generateExecutiveSummary(context) {
|
|
|
25
25
|
const result = await generateText({
|
|
26
26
|
system: SYSTEM_PROMPT,
|
|
27
27
|
user: createExecutiveSummaryPrompt(context),
|
|
28
|
-
temperature: 0.2,
|
|
29
28
|
maxTokens: 1500
|
|
30
29
|
});
|
|
31
30
|
|
|
@@ -47,7 +46,6 @@ export async function generateSystemOverview(context) {
|
|
|
47
46
|
const result = await generateText({
|
|
48
47
|
system: SYSTEM_PROMPT,
|
|
49
48
|
user: createSystemOverviewPrompt(context),
|
|
50
|
-
temperature: 0.2,
|
|
51
49
|
maxTokens: 1200
|
|
52
50
|
});
|
|
53
51
|
|
|
@@ -68,7 +66,6 @@ export async function generateBusinessDomains(context) {
|
|
|
68
66
|
const result = await generateText({
|
|
69
67
|
system: SYSTEM_PROMPT,
|
|
70
68
|
user: createBusinessDomainsPrompt(context),
|
|
71
|
-
temperature: 0.2,
|
|
72
69
|
maxTokens: 2000
|
|
73
70
|
});
|
|
74
71
|
|
|
@@ -89,7 +86,6 @@ export async function generateArchitectureOverview(context) {
|
|
|
89
86
|
const result = await generateText({
|
|
90
87
|
system: SYSTEM_PROMPT,
|
|
91
88
|
user: createArchitectureOverviewPrompt(context),
|
|
92
|
-
temperature: 0.2,
|
|
93
89
|
maxTokens: 1800
|
|
94
90
|
});
|
|
95
91
|
|
|
@@ -110,7 +106,6 @@ export async function generateDataFlows(flows, context) {
|
|
|
110
106
|
const result = await generateText({
|
|
111
107
|
system: SYSTEM_PROMPT,
|
|
112
108
|
user: createDataFlowsPrompt(flows, context),
|
|
113
|
-
temperature: 0.2,
|
|
114
109
|
maxTokens: 1800
|
|
115
110
|
});
|
|
116
111
|
|
|
@@ -131,7 +126,6 @@ export async function generateDeveloperOnboarding(context) {
|
|
|
131
126
|
const result = await generateText({
|
|
132
127
|
system: SYSTEM_PROMPT,
|
|
133
128
|
user: createDeveloperOnboardingPrompt(context),
|
|
134
|
-
temperature: 0.2,
|
|
135
129
|
maxTokens: 2200
|
|
136
130
|
});
|
|
137
131
|
|
package/src/ai/provider.js
CHANGED
|
@@ -4,7 +4,6 @@ import { warn, info } from "../utils/logger.js";
|
|
|
4
4
|
import { executeAIRequest } from "../utils/rate-limit.js";
|
|
5
5
|
|
|
6
6
|
const DEFAULT_TIMEOUT_MS = 60000;
|
|
7
|
-
const DEFAULT_TEMPERATURE = 0.2;
|
|
8
7
|
const DEFAULT_MAX_TOKENS = 2500;
|
|
9
8
|
|
|
10
9
|
export async function generateText({ system, user, temperature, maxTokens, config }) {
|
|
@@ -27,8 +26,8 @@ export async function generateText({ system, user, temperature, maxTokens, confi
|
|
|
27
26
|
const model = process.env.REPOLENS_AI_MODEL || "gpt-5-mini";
|
|
28
27
|
const timeoutMs = parseInt(process.env.REPOLENS_AI_TIMEOUT_MS || DEFAULT_TIMEOUT_MS);
|
|
29
28
|
|
|
30
|
-
// Use config values as fallback for temperature
|
|
31
|
-
const resolvedTemp = temperature ?? aiConfig.temperature ??
|
|
29
|
+
// Use config values as fallback for maxTokens; temperature only when explicitly set
|
|
30
|
+
const resolvedTemp = temperature ?? aiConfig.temperature ?? undefined;
|
|
32
31
|
const resolvedMaxTokens = maxTokens ?? aiConfig.max_tokens ?? DEFAULT_MAX_TOKENS;
|
|
33
32
|
|
|
34
33
|
// Validate configuration
|
|
@@ -81,21 +80,28 @@ async function callOpenAICompatibleAPI({ baseUrl, apiKey, model, system, user, t
|
|
|
81
80
|
const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
|
|
82
81
|
|
|
83
82
|
try {
|
|
83
|
+
// Build request body — omit temperature if not supported by model
|
|
84
|
+
const body = {
|
|
85
|
+
model,
|
|
86
|
+
messages: [
|
|
87
|
+
{ role: "system", content: system },
|
|
88
|
+
{ role: "user", content: user }
|
|
89
|
+
],
|
|
90
|
+
max_completion_tokens: maxTokens
|
|
91
|
+
};
|
|
92
|
+
// Only send temperature when explicitly configured — some models
|
|
93
|
+
// (e.g. gpt-5-mini) reject any non-default value
|
|
94
|
+
if (temperature != null) {
|
|
95
|
+
body.temperature = temperature;
|
|
96
|
+
}
|
|
97
|
+
|
|
84
98
|
const response = await fetch(url, {
|
|
85
99
|
method: "POST",
|
|
86
100
|
headers: {
|
|
87
101
|
"Content-Type": "application/json",
|
|
88
102
|
"Authorization": `Bearer ${apiKey}`
|
|
89
103
|
},
|
|
90
|
-
body: JSON.stringify(
|
|
91
|
-
model,
|
|
92
|
-
messages: [
|
|
93
|
-
{ role: "system", content: system },
|
|
94
|
-
{ role: "user", content: user }
|
|
95
|
-
],
|
|
96
|
-
temperature,
|
|
97
|
-
max_tokens: maxTokens
|
|
98
|
-
}),
|
|
104
|
+
body: JSON.stringify(body),
|
|
99
105
|
signal: controller.signal
|
|
100
106
|
});
|
|
101
107
|
|
|
@@ -136,7 +142,7 @@ export function getAIConfig() {
|
|
|
136
142
|
provider: process.env.REPOLENS_AI_PROVIDER || "openai_compatible",
|
|
137
143
|
model: process.env.REPOLENS_AI_MODEL || "gpt-5-mini",
|
|
138
144
|
hasApiKey: !!process.env.REPOLENS_AI_API_KEY,
|
|
139
|
-
temperature: parseFloat(process.env.REPOLENS_AI_TEMPERATURE
|
|
145
|
+
temperature: process.env.REPOLENS_AI_TEMPERATURE ? parseFloat(process.env.REPOLENS_AI_TEMPERATURE) : undefined,
|
|
140
146
|
maxTokens: parseInt(process.env.REPOLENS_AI_MAX_TOKENS || DEFAULT_MAX_TOKENS)
|
|
141
147
|
};
|
|
142
148
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
const CURRENT_SCHEMA_VERSION = 1;
|
|
11
|
-
const SUPPORTED_PUBLISHERS = ["notion", "markdown", "confluence"];
|
|
11
|
+
const SUPPORTED_PUBLISHERS = ["notion", "markdown", "confluence", "github_wiki"];
|
|
12
12
|
const SUPPORTED_PAGE_KEYS = [
|
|
13
13
|
"system_overview",
|
|
14
14
|
"module_catalog",
|
|
@@ -193,6 +193,31 @@ export function validateConfig(config) {
|
|
|
193
193
|
}
|
|
194
194
|
}
|
|
195
195
|
|
|
196
|
+
// Validate GitHub Wiki configuration (optional)
|
|
197
|
+
if (config.github_wiki !== undefined) {
|
|
198
|
+
if (typeof config.github_wiki !== "object" || Array.isArray(config.github_wiki)) {
|
|
199
|
+
errors.push("github_wiki must be an object");
|
|
200
|
+
} else {
|
|
201
|
+
if (config.github_wiki.branches !== undefined) {
|
|
202
|
+
if (!Array.isArray(config.github_wiki.branches)) {
|
|
203
|
+
errors.push("github_wiki.branches must be an array");
|
|
204
|
+
} else {
|
|
205
|
+
config.github_wiki.branches.forEach((branch, idx) => {
|
|
206
|
+
if (typeof branch !== "string") {
|
|
207
|
+
errors.push(`github_wiki.branches[${idx}] must be a string`);
|
|
208
|
+
}
|
|
209
|
+
});
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
if (config.github_wiki.sidebar !== undefined && typeof config.github_wiki.sidebar !== "boolean") {
|
|
213
|
+
errors.push("github_wiki.sidebar must be a boolean");
|
|
214
|
+
}
|
|
215
|
+
if (config.github_wiki.footer !== undefined && typeof config.github_wiki.footer !== "boolean") {
|
|
216
|
+
errors.push("github_wiki.footer must be a boolean");
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
|
|
196
221
|
// Validate Discord configuration (optional)
|
|
197
222
|
if (config.discord !== undefined) {
|
|
198
223
|
if (typeof config.discord !== "object" || Array.isArray(config.discord)) {
|
package/src/init.js
CHANGED
|
@@ -105,7 +105,6 @@ CONFLUENCE_PARENT_PAGE_ID=
|
|
|
105
105
|
# REPOLENS_AI_API_KEY=sk-...
|
|
106
106
|
# REPOLENS_AI_BASE_URL=https://api.openai.com/v1
|
|
107
107
|
# REPOLENS_AI_MODEL=gpt-5-mini
|
|
108
|
-
# REPOLENS_AI_TEMPERATURE=0.3
|
|
109
108
|
# REPOLENS_AI_MAX_TOKENS=2000
|
|
110
109
|
`;
|
|
111
110
|
|
|
@@ -206,7 +205,6 @@ AI features add natural language explanations for non-technical stakeholders.
|
|
|
206
205
|
ai:
|
|
207
206
|
enabled: true
|
|
208
207
|
mode: hybrid
|
|
209
|
-
temperature: 0.3
|
|
210
208
|
|
|
211
209
|
features:
|
|
212
210
|
executive_summary: true
|
|
@@ -607,7 +605,6 @@ function buildWizardConfig(answers) {
|
|
|
607
605
|
lines.push(`ai:`);
|
|
608
606
|
lines.push(` enabled: true`);
|
|
609
607
|
lines.push(` mode: hybrid`);
|
|
610
|
-
lines.push(` temperature: 0.3`);
|
|
611
608
|
lines.push(``);
|
|
612
609
|
lines.push(`features:`);
|
|
613
610
|
lines.push(` executive_summary: true`);
|
|
@@ -0,0 +1,454 @@
|
|
|
1
|
+
// GitHub Wiki Publisher for RepoLens
|
|
2
|
+
//
|
|
3
|
+
// Publishes rendered documentation to a GitHub repository's wiki.
|
|
4
|
+
// The wiki is a separate git repo at {repo-url}.wiki.git.
|
|
5
|
+
//
|
|
6
|
+
// Environment Variables:
|
|
7
|
+
// - GITHUB_TOKEN: Personal access token or Actions token (required)
|
|
8
|
+
// - GITHUB_REPOSITORY: owner/repo (auto-set in Actions, or detected from git remote)
|
|
9
|
+
//
|
|
10
|
+
// Config (.repolens.yml):
|
|
11
|
+
// github_wiki:
|
|
12
|
+
// branches: [main] # Optional branch filter
|
|
13
|
+
// sidebar: true # Generate _Sidebar.md (default: true)
|
|
14
|
+
// footer: true # Generate _Footer.md (default: true)
|
|
15
|
+
|
|
16
|
+
import { execSync } from "node:child_process";
|
|
17
|
+
import fs from "node:fs/promises";
|
|
18
|
+
import path from "node:path";
|
|
19
|
+
import os from "node:os";
|
|
20
|
+
import { info, warn } from "../utils/logger.js";
|
|
21
|
+
import { getCurrentBranch, getBranchQualifiedTitle, normalizeBranchName } from "../utils/branch.js";
|
|
22
|
+
|
|
23
|
+
const PAGE_ORDER = [
|
|
24
|
+
"executive_summary",
|
|
25
|
+
"system_overview",
|
|
26
|
+
"business_domains",
|
|
27
|
+
"architecture_overview",
|
|
28
|
+
"module_catalog",
|
|
29
|
+
"route_map",
|
|
30
|
+
"api_surface",
|
|
31
|
+
"data_flows",
|
|
32
|
+
"change_impact",
|
|
33
|
+
"system_map",
|
|
34
|
+
"developer_onboarding",
|
|
35
|
+
"graphql_schema",
|
|
36
|
+
"type_graph",
|
|
37
|
+
"dependency_graph",
|
|
38
|
+
"architecture_drift",
|
|
39
|
+
"arch_diff",
|
|
40
|
+
];
|
|
41
|
+
|
|
42
|
+
const PAGE_TITLES = {
|
|
43
|
+
executive_summary: "Executive Summary",
|
|
44
|
+
system_overview: "System Overview",
|
|
45
|
+
business_domains: "Business Domains",
|
|
46
|
+
architecture_overview: "Architecture Overview",
|
|
47
|
+
module_catalog: "Module Catalog",
|
|
48
|
+
route_map: "Route Map",
|
|
49
|
+
api_surface: "API Surface",
|
|
50
|
+
data_flows: "Data Flows",
|
|
51
|
+
change_impact: "Change Impact",
|
|
52
|
+
system_map: "System Map",
|
|
53
|
+
developer_onboarding: "Developer Onboarding",
|
|
54
|
+
graphql_schema: "GraphQL Schema",
|
|
55
|
+
type_graph: "Type Graph",
|
|
56
|
+
dependency_graph: "Dependency Graph",
|
|
57
|
+
architecture_drift: "Architecture Drift",
|
|
58
|
+
arch_diff: "Architecture Diff",
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
const PAGE_DESCRIPTIONS = {
|
|
62
|
+
executive_summary: "High-level project summary for non-technical readers.",
|
|
63
|
+
system_overview: "Snapshot of stack, scale, structure, and detected capabilities.",
|
|
64
|
+
business_domains: "Functional areas inferred from the repository and business logic.",
|
|
65
|
+
architecture_overview: "Layered technical view of the system and its major components.",
|
|
66
|
+
module_catalog: "Structured inventory of modules, directories, and responsibilities.",
|
|
67
|
+
route_map: "Frontend routes and page structure detected across the application.",
|
|
68
|
+
api_surface: "Detected endpoints, handlers, methods, and API structure.",
|
|
69
|
+
data_flows: "How information moves through the system and its major pathways.",
|
|
70
|
+
change_impact: "Contextual architecture changes and likely downstream effects.",
|
|
71
|
+
system_map: "Visual map of system relationships and dependencies.",
|
|
72
|
+
developer_onboarding: "What a new engineer needs to understand the repository quickly.",
|
|
73
|
+
graphql_schema: "GraphQL types, operations, and schema structure.",
|
|
74
|
+
type_graph: "Type-level relationships and structural coupling across the codebase.",
|
|
75
|
+
dependency_graph: "Module and package dependency relationships.",
|
|
76
|
+
architecture_drift: "Detected drift between intended and current architecture patterns.",
|
|
77
|
+
arch_diff: "Architecture-level diff across branches or revisions.",
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
// Audience-based grouping for Home page
|
|
81
|
+
const AUDIENCE_GROUPS = [
|
|
82
|
+
{
|
|
83
|
+
title: "For Stakeholders",
|
|
84
|
+
emoji: "📊",
|
|
85
|
+
keys: ["executive_summary", "business_domains", "data_flows"],
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
title: "For Engineers",
|
|
89
|
+
emoji: "🔧",
|
|
90
|
+
keys: [
|
|
91
|
+
"architecture_overview", "module_catalog", "api_surface",
|
|
92
|
+
"route_map", "system_map", "graphql_schema", "type_graph",
|
|
93
|
+
"dependency_graph", "architecture_drift",
|
|
94
|
+
],
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
title: "For New Contributors",
|
|
98
|
+
emoji: "🚀",
|
|
99
|
+
keys: ["developer_onboarding", "system_overview"],
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
title: "Change Tracking",
|
|
103
|
+
emoji: "📋",
|
|
104
|
+
keys: ["change_impact", "arch_diff"],
|
|
105
|
+
},
|
|
106
|
+
];
|
|
107
|
+
|
|
108
|
+
// Sidebar grouping (compact navigation)
|
|
109
|
+
const SIDEBAR_GROUPS = [
|
|
110
|
+
{
|
|
111
|
+
title: "Overview",
|
|
112
|
+
keys: [
|
|
113
|
+
"executive_summary", "system_overview", "business_domains",
|
|
114
|
+
"data_flows", "developer_onboarding",
|
|
115
|
+
],
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
title: "Architecture",
|
|
119
|
+
keys: [
|
|
120
|
+
"architecture_overview", "module_catalog", "route_map",
|
|
121
|
+
"api_surface", "system_map", "graphql_schema", "type_graph",
|
|
122
|
+
"dependency_graph", "architecture_drift", "arch_diff", "change_impact",
|
|
123
|
+
],
|
|
124
|
+
},
|
|
125
|
+
];
|
|
126
|
+
|
|
127
|
+
// Audience labels for page metadata headers
|
|
128
|
+
const PAGE_AUDIENCE = {
|
|
129
|
+
executive_summary: "Stakeholders · Leadership",
|
|
130
|
+
system_overview: "All Audiences",
|
|
131
|
+
business_domains: "Stakeholders · Product",
|
|
132
|
+
architecture_overview: "Engineers · Tech Leads",
|
|
133
|
+
module_catalog: "Engineers",
|
|
134
|
+
route_map: "Engineers",
|
|
135
|
+
api_surface: "Engineers",
|
|
136
|
+
data_flows: "Stakeholders · Engineers",
|
|
137
|
+
change_impact: "Engineers · Tech Leads",
|
|
138
|
+
system_map: "All Audiences",
|
|
139
|
+
developer_onboarding: "New Contributors",
|
|
140
|
+
graphql_schema: "Engineers",
|
|
141
|
+
type_graph: "Engineers",
|
|
142
|
+
dependency_graph: "Engineers",
|
|
143
|
+
architecture_drift: "Engineers · Tech Leads",
|
|
144
|
+
arch_diff: "Engineers · Tech Leads",
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Get the display title for a page key.
|
|
149
|
+
*/
|
|
150
|
+
function getPageDisplayTitle(key) {
|
|
151
|
+
return PAGE_TITLES[key] || key.replace(/_/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Get custom page keys not in the standard order.
|
|
156
|
+
*/
|
|
157
|
+
function getCustomPageKeys(pageKeys) {
|
|
158
|
+
return pageKeys.filter((key) => !PAGE_ORDER.includes(key));
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Detect the GitHub repository (owner/repo) from environment or git remote.
|
|
163
|
+
*/
|
|
164
|
+
function detectGitHubRepo() {
|
|
165
|
+
if (process.env.GITHUB_REPOSITORY) {
|
|
166
|
+
return process.env.GITHUB_REPOSITORY;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
try {
|
|
170
|
+
const remoteUrl = execSync("git remote get-url origin", {
|
|
171
|
+
encoding: "utf8",
|
|
172
|
+
stdio: ["pipe", "pipe", "ignore"],
|
|
173
|
+
}).trim();
|
|
174
|
+
|
|
175
|
+
const httpsMatch = remoteUrl.match(/github\.com\/([^/]+\/[^/.]+)/);
|
|
176
|
+
if (httpsMatch) return httpsMatch[1];
|
|
177
|
+
|
|
178
|
+
const sshMatch = remoteUrl.match(/github\.com:([^/]+\/[^/.]+)/);
|
|
179
|
+
if (sshMatch) return sshMatch[1];
|
|
180
|
+
} catch {
|
|
181
|
+
// git command failed
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
return null;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Build the authenticated wiki clone URL.
|
|
189
|
+
*/
|
|
190
|
+
function buildWikiCloneUrl(repo, token) {
|
|
191
|
+
return `https://x-access-token:${token}@github.com/${repo}.wiki.git`;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Convert a page key to a wiki-safe filename.
|
|
196
|
+
*/
|
|
197
|
+
function pageFileName(key) {
|
|
198
|
+
const title = getPageDisplayTitle(key);
|
|
199
|
+
return title.replace(/\s+/g, "-") + ".md";
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Build a wiki link for a page key.
|
|
204
|
+
*/
|
|
205
|
+
function wikiLink(key) {
|
|
206
|
+
const display = getPageDisplayTitle(key);
|
|
207
|
+
const slug = pageFileName(key).replace(/\.md$/, "");
|
|
208
|
+
return `[[${display}|${slug}]]`;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Generate the Home.md page — audience-grouped with descriptions and status.
|
|
213
|
+
*/
|
|
214
|
+
function generateHome(pageKeys, projectName, branch, repo) {
|
|
215
|
+
const title = getBranchQualifiedTitle(projectName + " Documentation", branch);
|
|
216
|
+
const lines = [
|
|
217
|
+
`# ${title}`,
|
|
218
|
+
"",
|
|
219
|
+
`> Architecture documentation for **${projectName}**, auto-generated by [RepoLens](https://github.com/CHAPIBUNNY/repolens).`,
|
|
220
|
+
"",
|
|
221
|
+
"## Status",
|
|
222
|
+
"",
|
|
223
|
+
`| | |`,
|
|
224
|
+
`|---|---|`,
|
|
225
|
+
`| **Project** | ${projectName} |`,
|
|
226
|
+
`| **Branch** | \`${branch}\` |`,
|
|
227
|
+
`| **Pages** | ${pageKeys.length} |`,
|
|
228
|
+
`| **Publisher** | GitHub Wiki |`,
|
|
229
|
+
`| **Source** | [RepoLens](https://github.com/CHAPIBUNNY/repolens) |`,
|
|
230
|
+
"",
|
|
231
|
+
"---",
|
|
232
|
+
"",
|
|
233
|
+
];
|
|
234
|
+
|
|
235
|
+
// Audience-grouped sections
|
|
236
|
+
for (const group of AUDIENCE_GROUPS) {
|
|
237
|
+
const activeKeys = group.keys.filter((k) => pageKeys.includes(k));
|
|
238
|
+
if (activeKeys.length === 0) continue;
|
|
239
|
+
|
|
240
|
+
lines.push(`## ${group.emoji} ${group.title}`, "");
|
|
241
|
+
for (const key of activeKeys) {
|
|
242
|
+
const desc = PAGE_DESCRIPTIONS[key] || "";
|
|
243
|
+
lines.push(`- ${wikiLink(key)}${desc ? " — " + desc : ""}`);
|
|
244
|
+
}
|
|
245
|
+
lines.push("");
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
// Custom / plugin pages
|
|
249
|
+
const customKeys = getCustomPageKeys(pageKeys);
|
|
250
|
+
if (customKeys.length > 0) {
|
|
251
|
+
lines.push("## 🧩 Custom Pages", "");
|
|
252
|
+
for (const key of customKeys.sort()) {
|
|
253
|
+
const desc = PAGE_DESCRIPTIONS[key] || "";
|
|
254
|
+
lines.push(`- ${wikiLink(key)}${desc ? " — " + desc : ""}`);
|
|
255
|
+
}
|
|
256
|
+
lines.push("");
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
// Recommended reading order
|
|
260
|
+
lines.push(
|
|
261
|
+
"---",
|
|
262
|
+
"",
|
|
263
|
+
"## 📖 Recommended Reading Order",
|
|
264
|
+
"",
|
|
265
|
+
"1. [[Executive Summary|Executive-Summary]] — Start here for a quick overview",
|
|
266
|
+
"2. [[System Overview|System-Overview]] — Understand the stack and scale",
|
|
267
|
+
"3. [[Architecture Overview|Architecture-Overview]] — Deep dive into system design",
|
|
268
|
+
"4. [[Developer Onboarding|Developer-Onboarding]] — Get started contributing",
|
|
269
|
+
"",
|
|
270
|
+
"---",
|
|
271
|
+
"",
|
|
272
|
+
`*This wiki is auto-generated. Manual edits will be overwritten on the next publish.*`,
|
|
273
|
+
);
|
|
274
|
+
|
|
275
|
+
return lines.join("\n");
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Generate _Sidebar.md — grouped navigation.
|
|
280
|
+
*/
|
|
281
|
+
function generateSidebar(pageKeys, projectName, branch) {
|
|
282
|
+
const title = getBranchQualifiedTitle(projectName, branch);
|
|
283
|
+
const lines = [`### ${title}`, "", "[[Home]]", ""];
|
|
284
|
+
|
|
285
|
+
for (const group of SIDEBAR_GROUPS) {
|
|
286
|
+
const activeKeys = group.keys.filter((k) => pageKeys.includes(k));
|
|
287
|
+
if (activeKeys.length === 0) continue;
|
|
288
|
+
|
|
289
|
+
lines.push(`**${group.title}**`, "");
|
|
290
|
+
for (const key of activeKeys) {
|
|
291
|
+
lines.push(`- ${wikiLink(key)}`);
|
|
292
|
+
}
|
|
293
|
+
lines.push("");
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
// Custom / plugin pages
|
|
297
|
+
const customKeys = getCustomPageKeys(pageKeys);
|
|
298
|
+
if (customKeys.length > 0) {
|
|
299
|
+
lines.push("**Custom Pages**", "");
|
|
300
|
+
for (const key of customKeys.sort()) {
|
|
301
|
+
lines.push(`- ${wikiLink(key)}`);
|
|
302
|
+
}
|
|
303
|
+
lines.push("");
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
lines.push("---", `*[RepoLens](https://github.com/CHAPIBUNNY/repolens)*`);
|
|
307
|
+
return lines.join("\n");
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Generate _Footer.md.
|
|
312
|
+
*/
|
|
313
|
+
function generateFooter(branch) {
|
|
314
|
+
const branchNote = branch !== "main" && branch !== "master"
|
|
315
|
+
? ` · Branch: \`${branch}\``
|
|
316
|
+
: "";
|
|
317
|
+
return [
|
|
318
|
+
"---",
|
|
319
|
+
`📚 Generated by [RepoLens](https://github.com/CHAPIBUNNY/repolens)${branchNote} · [← Home](Home)`,
|
|
320
|
+
].join("\n");
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Build a metadata header to prepend to each page.
|
|
325
|
+
*/
|
|
326
|
+
function pageHeader(key, branch) {
|
|
327
|
+
const audience = PAGE_AUDIENCE[key] || "All Audiences";
|
|
328
|
+
return [
|
|
329
|
+
`[← Home](Home)`,
|
|
330
|
+
"",
|
|
331
|
+
`> **Audience:** ${audience} · **Branch:** \`${branch}\` · **Generated by** [RepoLens](https://github.com/CHAPIBUNNY/repolens)`,
|
|
332
|
+
"",
|
|
333
|
+
"---",
|
|
334
|
+
"",
|
|
335
|
+
].join("\n");
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* Run a git command in the specified directory.
|
|
340
|
+
* Token is never exposed in error output.
|
|
341
|
+
*/
|
|
342
|
+
function git(args, cwd) {
|
|
343
|
+
try {
|
|
344
|
+
return execSync(`git ${args}`, {
|
|
345
|
+
cwd,
|
|
346
|
+
encoding: "utf8",
|
|
347
|
+
stdio: ["pipe", "pipe", "pipe"],
|
|
348
|
+
env: { ...process.env, GIT_TERMINAL_PROMPT: "0" },
|
|
349
|
+
});
|
|
350
|
+
} catch (err) {
|
|
351
|
+
const sanitized = (err.stderr || err.message || "").replace(
|
|
352
|
+
/x-access-token:[^\s@]+/g,
|
|
353
|
+
"x-access-token:***"
|
|
354
|
+
);
|
|
355
|
+
throw new Error(`Git command failed: git ${args.split(" ")[0]} — ${sanitized}`);
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* Publish rendered pages to GitHub Wiki.
|
|
361
|
+
*/
|
|
362
|
+
export async function publishToGitHubWiki(cfg, renderedPages) {
|
|
363
|
+
const token = process.env.GITHUB_TOKEN;
|
|
364
|
+
if (!token) {
|
|
365
|
+
throw new Error(
|
|
366
|
+
"Missing GITHUB_TOKEN. Required for GitHub Wiki publishing.\n" +
|
|
367
|
+
"In GitHub Actions, this is available as ${{ secrets.GITHUB_TOKEN }}.\n" +
|
|
368
|
+
"Locally, create a PAT with repo scope: https://github.com/settings/tokens"
|
|
369
|
+
);
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
const repo = detectGitHubRepo();
|
|
373
|
+
if (!repo) {
|
|
374
|
+
throw new Error(
|
|
375
|
+
"Could not detect GitHub repository. Set GITHUB_REPOSITORY=owner/repo\n" +
|
|
376
|
+
"or ensure git remote 'origin' points to a GitHub URL."
|
|
377
|
+
);
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
const branch = getCurrentBranch();
|
|
381
|
+
const wikiConfig = cfg.github_wiki || {};
|
|
382
|
+
const includeSidebar = wikiConfig.sidebar !== false;
|
|
383
|
+
const includeFooter = wikiConfig.footer !== false;
|
|
384
|
+
const projectName = cfg.project?.name || repo.split("/")[1] || "RepoLens";
|
|
385
|
+
|
|
386
|
+
const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "repolens-wiki-"));
|
|
387
|
+
|
|
388
|
+
try {
|
|
389
|
+
const cloneUrl = buildWikiCloneUrl(repo, token);
|
|
390
|
+
|
|
391
|
+
try {
|
|
392
|
+
git(`clone --depth 1 ${cloneUrl} .`, tmpDir);
|
|
393
|
+
} catch {
|
|
394
|
+
warn("Wiki repository not found — initializing. Enable the wiki tab in GitHub repo settings.");
|
|
395
|
+
git("init", tmpDir);
|
|
396
|
+
git(`remote add origin ${cloneUrl}`, tmpDir);
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
const pageKeys = Object.keys(renderedPages);
|
|
400
|
+
|
|
401
|
+
// Write Home.md
|
|
402
|
+
const home = generateHome(pageKeys, projectName, branch, repo);
|
|
403
|
+
await fs.writeFile(path.join(tmpDir, "Home.md"), home, "utf8");
|
|
404
|
+
|
|
405
|
+
// Write each rendered page with metadata header
|
|
406
|
+
for (const [key, markdown] of Object.entries(renderedPages)) {
|
|
407
|
+
const fileName = pageFileName(key);
|
|
408
|
+
const header = pageHeader(key, branch);
|
|
409
|
+
await fs.writeFile(path.join(tmpDir, fileName), header + markdown, "utf8");
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
// Generate sidebar
|
|
413
|
+
if (includeSidebar) {
|
|
414
|
+
const sidebar = generateSidebar(pageKeys, projectName, branch);
|
|
415
|
+
await fs.writeFile(path.join(tmpDir, "_Sidebar.md"), sidebar, "utf8");
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
// Generate footer
|
|
419
|
+
if (includeFooter) {
|
|
420
|
+
const footer = generateFooter(branch);
|
|
421
|
+
await fs.writeFile(path.join(tmpDir, "_Footer.md"), footer, "utf8");
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
// Stage, commit, push
|
|
425
|
+
git("config user.name \"RepoLens Bot\"", tmpDir);
|
|
426
|
+
git("config user.email \"repolens@users.noreply.github.com\"", tmpDir);
|
|
427
|
+
git("add -A", tmpDir);
|
|
428
|
+
|
|
429
|
+
try {
|
|
430
|
+
execSync("git diff --cached --quiet", { cwd: tmpDir, stdio: "pipe" });
|
|
431
|
+
info("GitHub Wiki is already up to date — no changes to push.");
|
|
432
|
+
return;
|
|
433
|
+
} catch {
|
|
434
|
+
// There are staged changes — continue to commit
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
const branchLabel = branch !== "main" && branch !== "master" ? ` [${branch}]` : "";
|
|
438
|
+
const commitMsg = `docs: update RepoLens documentation${branchLabel}`;
|
|
439
|
+
git(`commit -m "${commitMsg}"`, tmpDir);
|
|
440
|
+
|
|
441
|
+
git("push origin HEAD", tmpDir);
|
|
442
|
+
info(`GitHub Wiki published: https://github.com/${repo}/wiki`);
|
|
443
|
+
|
|
444
|
+
} finally {
|
|
445
|
+
await fs.rm(tmpDir, { recursive: true, force: true }).catch(() => {});
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
/**
|
|
450
|
+
* Check if GitHub Wiki publishing secrets are available.
|
|
451
|
+
*/
|
|
452
|
+
export function hasGitHubWikiSecrets() {
|
|
453
|
+
return !!process.env.GITHUB_TOKEN;
|
|
454
|
+
}
|
package/src/publishers/index.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { publishToNotion } from "./publish.js";
|
|
2
2
|
import { publishToMarkdown } from "./markdown.js";
|
|
3
3
|
import { publishToConfluence, hasConfluenceSecrets } from "./confluence.js";
|
|
4
|
-
import {
|
|
4
|
+
import { publishToGitHubWiki, hasGitHubWikiSecrets } from "./github-wiki.js";
|
|
5
|
+
import { shouldPublishToNotion, shouldPublishToConfluence, shouldPublishToGitHubWiki, getCurrentBranch } from "../utils/branch.js";
|
|
5
6
|
import { info, warn } from "../utils/logger.js";
|
|
6
7
|
import { trackPublishing } from "../utils/telemetry.js";
|
|
7
8
|
import { collectMetrics } from "../utils/metrics.js";
|
|
@@ -80,6 +81,27 @@ export async function publishDocs(cfg, renderedPages, scanResult, pluginManager
|
|
|
80
81
|
}
|
|
81
82
|
}
|
|
82
83
|
|
|
84
|
+
// GitHub Wiki publishing (opt-in if secrets configured)
|
|
85
|
+
if (publishers.includes("github_wiki") || hasGitHubWikiSecrets() && publishers.includes("github_wiki")) {
|
|
86
|
+
if (!hasGitHubWikiSecrets()) {
|
|
87
|
+
info("Skipping GitHub Wiki publish: GITHUB_TOKEN not configured");
|
|
88
|
+
info("In GitHub Actions, add GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} to your env");
|
|
89
|
+
} else if (shouldPublishToGitHubWiki(cfg, currentBranch)) {
|
|
90
|
+
info(`Publishing to GitHub Wiki from branch: ${currentBranch}`);
|
|
91
|
+
try {
|
|
92
|
+
await publishToGitHubWiki(cfg, renderedPages);
|
|
93
|
+
publishedTo.push("github_wiki");
|
|
94
|
+
} catch (err) {
|
|
95
|
+
publishStatus = "failure";
|
|
96
|
+
throw err;
|
|
97
|
+
}
|
|
98
|
+
} else {
|
|
99
|
+
const allowedBranches = cfg.github_wiki?.branches?.join(", ") || "none configured";
|
|
100
|
+
warn(`Skipping GitHub Wiki publish: branch "${currentBranch}" not in allowed list (${allowedBranches})`);
|
|
101
|
+
info("To publish from this branch, add it to github_wiki.branches in .repolens.yml");
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
83
105
|
// Run plugin publishers
|
|
84
106
|
if (pluginManager) {
|
|
85
107
|
const pluginPublishers = pluginManager.getPublishers();
|
package/src/utils/branch.js
CHANGED
|
@@ -112,6 +112,33 @@ export function shouldPublishToConfluence(config, currentBranch = getCurrentBran
|
|
|
112
112
|
});
|
|
113
113
|
}
|
|
114
114
|
|
|
115
|
+
/**
|
|
116
|
+
* Check if current branch should publish to GitHub Wiki
|
|
117
|
+
* Based on config.github_wiki.branches setting
|
|
118
|
+
*/
|
|
119
|
+
export function shouldPublishToGitHubWiki(config, currentBranch = getCurrentBranch()) {
|
|
120
|
+
if (!config.github_wiki) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
if (!config.github_wiki.branches || config.github_wiki.branches.length === 0) {
|
|
125
|
+
return true;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
return config.github_wiki.branches.some(pattern => {
|
|
129
|
+
if (pattern === currentBranch) {
|
|
130
|
+
return true;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
if (pattern.includes("*")) {
|
|
134
|
+
const regex = new RegExp("^" + pattern.replace(/\*/g, ".*") + "$");
|
|
135
|
+
return regex.test(currentBranch);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
return false;
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
|
|
115
142
|
/**
|
|
116
143
|
* Get branch-qualified page title
|
|
117
144
|
*/
|
package/src/utils/validate.js
CHANGED
|
@@ -135,7 +135,7 @@ function validatePublishers(publishers) {
|
|
|
135
135
|
return errors;
|
|
136
136
|
}
|
|
137
137
|
|
|
138
|
-
const validPublishers = ["notion", "markdown", "confluence"];
|
|
138
|
+
const validPublishers = ["notion", "markdown", "confluence", "github_wiki"];
|
|
139
139
|
|
|
140
140
|
if (Array.isArray(publishers)) {
|
|
141
141
|
for (const pub of publishers) {
|