Skip to content

Install typedoc just-in-time for API docs (end Dependabot churn, keep the docs) #7723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
amcaplan wants to merge 3 commits into from
Closed

Install typedoc just-in-time for API docs (end Dependabot churn, keep the docs) #7723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdae1f2
[Refactor] Use uniq helper in info service
gonzaloriestra Jun 4, 2026
b975f5a
Remove typedoc from cli-kit; drop unused API-docs generation
amcaplan Jun 5, 2026
33a59c4
Keep cli-kit API docs; install typedoc just-in-time in CI
amcaplan Jun 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ jobs:
uses: ./.github/actions/setup-cli-deps
with:
node-version: "22"
# typedoc is needed only to generate the cli-kit API docs published to
# GitHub Pages. It's installed here just-in-time rather than tracked as a
# cli-kit devDependency so it doesn't generate Dependabot churn. Left
# unpinned so docs track the latest typedoc (and stay compatible with the
# repo's TypeScript) automatically; nothing here is committed.
- name: Install typedoc (docs generation only)
run: pnpm --filter @shopify/cli-kit add --save-dev typedoc
Comment on lines +41 to +47

@gonzaloriestra gonzaloriestra Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree.

Also, if we remove this dependency (which is only for dev), then there's no way to run the build-api-docs locally, no?

If the "Dependabot churn" means one more line in a PR like this from time to time, then I prefer to keep that.

@amcaplan amcaplan Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gonzaloriestra you're not wrong about being unable to run build-api-docs unless you install typedoc locally. But honestly, I don't think most of us are using those docs built locally at this point. Are we using them at all? Do our agents need them?

@gonzaloriestra gonzaloriestra Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not too much, I guess. It's a price I would be willing to pay if there were any benefit, but I still don't see it 😄

@gonzaloriestra gonzaloriestra Jun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more thing: we are installing and using here always the latest version without any check. If there's a buggy or malicious release, we won't have a way to detect it. Dependabot allows us to test and check new versions before using them.

- name: Build TSDoc docs
run: pnpm build-api-docs --output-style=stream
- name: Build Markdown files into HTML
Expand Down
1 change: 1 addition & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The list below contains valuable resources for people interested in contributing

The [`@shopify/cli-kit`](https://www.npmjs.com/package/@shopify/cli-kit) NPM package provides utilities to abstract away interactions with the Shopify platform (e.g., authentication, API requests) and ensures experiences are consistent across the board. If you are creating a new plugin or contributing to an existing one, we recommend checking out the following resources:

- [API reference](https://shopify.github.io/cli/api/cli-kit/)
- [Creating a new command or flag](cli-kit/command-guidelines.md)
- [Content and UI guidelines](cli-kit/ui-kit/guidelines.md)
- [Using UI Kit](cli-kit/ui-kit/readme.md)
Expand Down
6 changes: 2 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,9 @@
"**/graphql/**/generated/*.ts"
],
"project": "**/*.{ts,tsx}!",
"ignoreBinaries": [
"open"
],
"ignoreDependencies": [
"@graphql-typed-document-node/core"
"@graphql-typed-document-node/core",
"typedoc"
],
"vite": {
"config": [
Expand Down
3 changes: 2 additions & 1 deletion packages/app/src/cli/services/info.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
} from '@shopify/cli-kit/node/output'
import {AlertCustomSection, InlineToken} from '@shopify/cli-kit/node/ui'
import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
import {uniq} from '@shopify/cli-kit/common/array'

export type Format = 'json' | 'text'
export interface InfoOptions {
Expand Down Expand Up @@ -230,7 +231,7 @@ class AppInfo {

extensionsSections(): AlertCustomSection[] {
const extensions = this.app.allExtensions.filter((ext) => ext.isReturnedAsInfo())
const types = Array.from(new Set(extensions.map((ext) => ext.type)))
const types = uniq(extensions.map((ext) => ext.type))
return types
.map((extensionType: string): AlertCustomSection | undefined => {
const relevantExtensions = extensions.filter((extension: ExtensionInstance) => extension.type === extensionType)
Expand Down
4 changes: 1 addition & 3 deletions packages/cli-kit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
"build": "nx build",
"clean": "nx clean",
"build-api-docs": "nx build-api-docs",
"open-api-docs": "nx open-api-docs",
"lint": "nx lint",
"lint:fix": "nx lint:fix",
"prepack": "NODE_ENV=production pnpm nx build && cp ../../README.md README.md",
Expand Down Expand Up @@ -170,8 +169,7 @@
"@vitest/coverage-istanbul": "^3.1.4",
"msw": "^2.7.1",
"node-stream-zip": "^1.15.0",
"ts-morph": "^17.0.1",
"typedoc": "^0.28.17"
"ts-morph": "^17.0.1"
},
"engines": {
"node": ">=22.12.0"
Expand Down
10 changes: 0 additions & 10 deletions packages/cli-kit/project.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@
"cwd": "packages/cli-kit"
}
},
"open-api-docs": {
"executor": "nx:run-commands",
"dependsOn": [
"build-api-docs"
],
"options": {
"command": "open ../../docs/api/cli-kit/index.html",
"cwd": "packages/cli-kit"
}
},
"lint": {
"executor": "nx:run-commands",
"options": {
Expand Down
Loading
Loading