Skip to content

Commit caaa0f9

Browse files
committed
rebase fixes
1 parent d098db8 commit caaa0f9

File tree

6 files changed

+17
-13
lines changed

6 files changed

+17
-13
lines changed

.github/workflows/generate.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,14 @@ jobs:
140140
- name: Install dependencies
141141
run: npm ci
142142

143+
- name: Get generator name
144+
id: generator
145+
run: echo "name=$(node -p "import('${{ matrix.target }}').then(m => m.name)")" >> "$GITHUB_OUTPUT"
146+
143147
- name: Create output directory
144-
run: mkdir -p out/${{ matrix.target }}
148+
run: mkdir -p out/${{ steps.generator.outputs.name }}
145149

146-
- name: Generate ${{ matrix.target }}
150+
- name: Generate ${{ steps.generator.outputs.name }}
147151
run: |
148152
node packages/core/bin/cli.mjs generate \
149153
-t ${{ matrix.target }} \
@@ -157,7 +161,7 @@ jobs:
157161
if: ${{ matrix.compare && needs.prepare.outputs.base-run }}
158162
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
159163
with:
160-
name: ${{ matrix.target }}
164+
name: ${{ steps.generator.outputs.name }}
161165
path: base
162166
run-id: ${{ needs.prepare.outputs.base-run }}
163167
github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -169,8 +173,8 @@ jobs:
169173
run: |
170174
node scripts/comparators/${{ matrix.compare }}.mjs > out/comparison.txt
171175
172-
- name: Upload ${{ matrix.target }} artifacts
176+
- name: Upload ${{ steps.generator.outputs.name }} artifacts
173177
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
174178
with:
175-
name: ${{ matrix.target }}
179+
name: ${{ steps.generator.outputs.name }}
176180
path: out

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The steps below will give you a general idea of how to prepare your local enviro
8989
For fast iteration during development, target a single Markdown file instead of all API docs:
9090

9191
```bash
92-
node bin/cli.mjs generate \
92+
node packages/core/bin/cli.mjs generate \
9393
-t legacy-html \
9494
-i ../node/doc/api/fs.md \
9595
-o out \
@@ -110,7 +110,7 @@ The steps below will give you a general idea of how to prepare your local enviro
110110
Add `--log-level debug` before the `generate` subcommand to see the full pipeline trace:
111111

112112
```bash
113-
node bin/cli.mjs --log-level debug generate -t legacy-html -i ../node/doc/api/fs.md -o out
113+
node packages/core/bin/cli.mjs --log-level debug generate -t legacy-html -i ../node/doc/api/fs.md -o out
114114
```
115115

116116
> [!TIP]

docs/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export default [
6969

7070
### Step 3: Update CLI Entry Point
7171

72-
The CLI in `bin/cli.mjs` automatically loads commands from `bin/commands/index.mjs`, so no changes are needed there if you followed step 2.
72+
The CLI in `packages/core/bin/cli.mjs` automatically loads commands from `bin/commands/index.mjs`, so no changes are needed there if you followed step 2.
7373

7474
## Command Options
7575

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/core/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@
1515
"test:ci": "c8 --reporter=lcov node --test --experimental-test-module-mocks \"src/**/*.test.mjs\" --test-reporter=@reporters/github --test-reporter-destination=stdout --test-reporter=junit --test-reporter-destination=junit.xml --test-reporter=spec --test-reporter-destination=stdout",
1616
"test:update-snapshots": "node --test --experimental-test-module-mocks --test-update-snapshots \"src/**/*.test.mjs\"",
1717
"test:watch": "node --test --experimental-test-module-mocks --watch \"src/**/*.test.mjs\"",
18-
"run": "node bin/cli.mjs",
19-
"watch": "node --watch bin/cli.mjs"
18+
"run": "node packages/core/bin/cli.mjs",
19+
"watch": "node --watch packages/core/bin/cli.mjs"
2020
},
2121
"main": "./src/generators.mjs",
2222
"exports": {
2323
"./generators/*": "./src/generators/*/index.mjs"
2424
},
2525
"bin": {
26-
"doc-kit": "./bin/cli.mjs"
26+
"doc-kit": "./packages/core/bin/cli.mjs"
2727
},
2828
"dependencies": {
2929
"@actions/core": "^3.0.0",

scripts/vercel-build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
node bin/cli.mjs generate \
1+
node packages/core/bin/cli.mjs generate \
22
-t @node-core/doc-kit/generators/orama-db \
33
-t @node-core/doc-kit/generators/legacy-json \
44
-t @node-core/doc-kit/generators/llms-txt \

0 commit comments

Comments
 (0)