Skip to content

Commit 293c32b

Browse files
authored
chore: move typedoc entirely to workflow (#1371)
1 parent db05409 commit 293c32b

File tree

5 files changed

+10
-183
lines changed

5 files changed

+10
-183
lines changed

.github/workflows/typedoc.yaml

+7-3
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ jobs:
1919
node-version: 22
2020
registry-url: https://registry.npmjs.org/
2121
cache: pnpm
22+
23+
- run: pnpm install --frozen-lockfile
24+
- run: pnpm add -g typedoc
25+
2226
- name: Generate docs
23-
run: |
24-
pnpm install --frozen-lockfile
25-
pnpm run typedoc
27+
run: typedoc --gitRevision "$(git describe --tag --abbrev=0)" --tsconfig tsconfig.json --excludePrivate --excludeProtected --excludeExternals --entryPointStrategy expand ./src --sourceLinkTemplate "https://github.com/Koenkk/zigbee-herdsman/blob/{gitRevision}/{path}#L{line}" -out typedoc
28+
2629
- uses: actions/upload-pages-artifact@v3
2730
with:
2831
name: github-pages
2932
# typedoc "out" path
3033
path: ./typedoc
34+
3135
deploy:
3236
needs: build
3337
runs-on: ubuntu-latest

eslint.config.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default tseslint.config(
2626
},
2727
},
2828
{
29-
ignores: ['typedoc/', 'test/', 'dist/', '**/*.js', '**/*.mjs'],
29+
ignores: ['test/', 'dist/', '**/*.js', '**/*.mjs'],
3030
},
3131
eslintConfigPrettier,
3232
);

package.json

-4
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@
5050
"eslint-config-prettier": "^10.1.1",
5151
"prettier": "^3.5.3",
5252
"rimraf": "^6.0.1",
53-
"typedoc": "^0.28.1",
54-
"typedoc-plugin-markdown": "^4.6.0",
55-
"typedoc-plugin-no-inherit": "^1.5.0",
5653
"typescript": "^5.8.2",
5754
"typescript-eslint": "^8.28.0",
5855
"vitest": "^3.0.9"
@@ -82,7 +79,6 @@
8279
"eslint": "eslint --max-warnings=0",
8380
"pretty:write": "prettier --write .",
8481
"pretty:check": "prettier --check .",
85-
"typedoc": "typedoc --gitRevision $(git describe --tag --abbrev=0) --tsconfig tsconfig.json --excludePrivate --excludeProtected --excludeExternals --entryPointStrategy expand ./src --sourceLinkTemplate 'https://github.com/Koenkk/zigbee-herdsman/blob/{gitRevision}/{path}#L{line}' -out typedoc",
8682
"clean": "rimraf temp coverage dist tsconfig.tsbuildinfo",
8783
"prepack": "pnpm run clean && pnpm run build"
8884
},

pnpm-lock.yaml

+2-134
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

typedoc-tsconfig.json

-41
This file was deleted.

0 commit comments

Comments
 (0)