Repository navigation
ci: check the CLI and API references against the code - #242
Merged
Merged
Conversation
Deploying spicetify-docs with
|
| Latest commit: |
ae497a6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://97617349.spicetify-docs.pages.dev |
| Branch Preview URL: | https://ci-reference-checks.spicetify-docs.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The v3 docs pass (#241) found the reference pages had drifted from the CLI and the wrapper in many places. Two checks now catch that automatically, on every pull request and weekly (so a CLI change that outdates the docs shows up without a docs PR).
pnpm run check:cli-commands <spicetify>): runsspicetify --helpand each subcommand's--helprecursively from the newest v3 release (Linux x86_64 asset, checksum verified), and compares the command paths withcli/commands.md(single-code-span headings, andspicetify ...lines in shell code blocks). Fails on commands missing from the page and on documented commands the CLI doesn't have. The Linux-onlyspotifycommands only warn on a non-Linux binary.pnpm run check:api-wrapper): lists the top-level members ofdeclare namespace Spicetifyin the CLI'sv3-betaglobals.d.tswith the TypeScript compiler API, and checks each has a page (bytitle), a`Spicetify.X`heading, or a row in the libraries table underdevelopment/api-wrapper. Fails on undocumented members and on pages for members that no longer exist.@deprecatedand underscore members are skipped; the allowlist is just thetestdebug helper..github/workflows/reference-checks.yml: both checks onpull_request, weekly, and on dispatch, withcontents: readonly and actions pinned by SHA.Color,Locale,extractColorPreset,Events, and aContextMenuV2section. (Config, the last gap, is now@deprecatedin the CLI, fix(types): mark Config deprecated, since v3 never sets it cli#3998.)Testing
spotifysubtree checked with a stub).pnpm buildpasses with 0 broken links.### restartsection, a bogus documented command; a deletedQueuepage, a CORSProxy heading turned into prose, a page for a member that doesn't exist.cli-commandsjob's release download and theGITHUB_TOKEN Permissionsheader.