Repository navigation
chore(deps): pin the docs TypeScript, and say what decides it - #2
Merged
Merged
Conversation
Dependabot opened `typescript 6.0.3 → 7.0.2` against `tools/docs` the day
this repository went public. Merging it would have left typedoc unable to
load: its peer range stops at `6.0.x`, and 6.0.3 is the newest version
that range allows.
There are two TypeScripts here — the build runs 7, the documentation
tooling runs 6 — and Dependabot matches by dependency name, so it cannot
be told to leave one alone and update the other. Majors are ignored for
`typescript` as a result, which makes the build's own major a manual
decision rather than a PR that appears.
That trade is only safe if the manual decision has a trigger, so both the
rule and CONTRIBUTING name the question that answers it:
npm view typedoc version peerDependencies
Checked today: typedoc 0.28.20, still `5.0.x … 6.0.x`. The pin stands.
Minors and patches are unaffected in both places.
Co-Authored-By: htjulia <htjulia1@gmail.com>
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.
Dependabot opened #1 —
typescript 6.0.3 → 7.0.2againsttools/docs— the day this repository went public. Merging it would leave typedoc unable to load: its peer range stops at6.0.x, and 6.0.3 is the newest version that range allows.Why an ignore rather than closing the PR
There are two TypeScripts here and they are not free to move together:
tools/docs5.0.x … 6.0.x; 6.0.3 is the newest it acceptsDependabot matches by dependency name and cannot be told to leave one alone while updating the other. Closing #1 would bring it back next week, so majors are ignored for
typescript.The cost, and the trigger that pays for it
The cost is real: the build's own TypeScript major is now a manual decision rather than a PR that appears. That is only safe if the decision has a trigger, so the rule and
CONTRIBUTING.mdboth name the question that answers it:If typedoc accepts the newer major, raise both and drop the ignore. If it has not, the pin stays — and a "typescript is out of date" report is answered by that command rather than by bumping.
Checked today: typedoc 0.28.20 (latest), peer still
5.0.x || … || 6.0.x. 6.0.3 is also the newest 6.x that exists, so the pin costs nothing today.Minors and patches are unaffected in both places.
Verified
core 384, api reports match, actionlint PASS, dependabot.yml parses.
Closes #1 once merged — the ignore rule is what stops it returning.