fix: stabilize python module order in typedoc snapshots#75
Merged
Conversation
vdusek
force-pushed
the
vdusek/stable-typedoc-snapshots
branch
from
d06af53 to
2493802
Compare
vdusek
changed the title
vdusek
force-pushed
the
vdusek/stable-typedoc-snapshots
branch
from
2493802 to
068dd5d
Compare
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
3 participants
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
In
DocspecTransformer.transform()the sequential IDs assigned bySymbolIdTrackerdepend on the orderpydoc-markdown'sPythonLoaderyields modules. That order is filesystem-walk-dependent, so different CI machines produce different module orders and reshuffle everyidandtargetreference in the generated JSON.Sort the docspec modules by name once at the start of
transform()so IDs are assigned deterministically. Per-module member order (which already follows source-code declaration order) is unchanged.In consumer projects that commit versioned typedoc snapshots (e.g.
crawlee-python'swebsite/versioned_docs/version-*/api-typedoc.json), this was producing ~100k-line no-op diffs in every release commit.Verification
Linked the local plugin into
crawlee-python/websiteand ranpnpm exec docusaurus api:version 99.1twice on the same HEAD — output is byte-identical.yarn build,yarn type, andyarn lintare clean.