Skip to content

Commit 406fed5

Browse files
ktranDevtools-frontend LUCI CQ
authored andcommitted
[docs] Build with typescript checks on Github
In order to make sure that the dependencies of our docs are existent, we need to build with typescript checks. If a dependency on the component is missing, typescript checks will throw an error during build time when building the scripts/component_docs target. Drive-by: Change to order of documentation navigation sidebar Bug: 414332459 Change-Id: Ife52bcd35501af930e7685c4765bb9c9cf80fc74 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7100240 Auto-Submit: Kim-Anh Tran <[email protected]> Reviewed-by: Simon Zünd <[email protected]> Commit-Queue: Kim-Anh Tran <[email protected]>
1 parent 0b2c711 commit 406fed5

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

.github/workflows/publish-component-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
run: gclient sync
3333
working-directory: devtools/devtools-frontend
3434
- name: Generate build files (gn)
35-
run: gn gen out/Default --args='devtools_skip_typecheck=true'
35+
run: gn gen out/Default
3636
working-directory: devtools/devtools-frontend
3737
- name: Build DevTools Frontend (autoninja)
3838
run: autoninja -C out/Default scripts/component_docs

scripts/component_docs/generate_docs.mjs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ async function main() {
3636
const componentDocs = JSON.parse(fs.readFileSync(SOURCES_FILE, 'utf-8'));
3737

3838
const componentLinks = componentDocs
39-
.map(p => {
40-
const componentName = path.basename(p, '.docs.js');
41-
return `<li><a href="#${componentName}">${componentName}</a></li>`;
42-
})
39+
.map(p => path.basename(p, '.docs.js'))
40+
.sort()
41+
.map(componentName => `<li><a href="#${componentName}">${componentName}</a></li>`)
4342
.join('\n');
4443

4544
const docImports = componentDocs

0 commit comments

Comments
 (0)