Repository navigation
Rename codes to MSKIT<FAMILY><nnn> and add HelpLinks - #13
Merged
Merged
Conversation
- docs-check fails on the old underscore spelling anywhere except "formerly" in the code reference and released changelog sections, and on a <Warning>/<Error> without a HelpLink to its codes.md section - tests/codes.sh reads the HelpLink back from the terminal logger and checks MSKit_CodesHelpBaseUrl moves it - the runtime checks expect the new spelling (red until the rename)
- docs-check also flags a family prefix or a bare prefix with an underscore; the scanners spell it MSKIT[_] so they do not flag themselves
- drop the underscore after the prefix in all 58 codes, keeping the family and number; codes.md names each former spelling, VER003 stays reserved - every <Warning>/<Error> sets HelpLink to its codes.md section through MSKit_CodesHelpBaseUrl (Core default: the GitHub copy of the page) - breaking change in CHANGELOG and a troubleshooting row: NoWarn, WarningsAsErrors, WarningsNotAsErrors and MSKit_SkipPackageChecks entries naming old codes stop matching
- update.sh --source kit --root manager, so the manager builds against the renamed codes (and the merged icon fix)
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
1 participant
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.
MSKITVER006,MSKITPKG015); family and number unchanged, 58 codes.docs/reference/codes.mdnames each former spelling;VER003stays reserved.<Warning>/<Error>setsHelpLinkto itscodes.mdsection through the newMSKit_CodesHelpBaseUrl(default: the GitHub copy of the page).tools/docs-check.shfails on the old spelling anywhere except "formerly" incodes.mdand released changelog sections, and on a diagnostic without a matching HelpLink;tests/codes.shreads the link back from the terminal logger.manager/.toolkitreinstalled from the working-tree kit.Breaking changes
NoWarn,WarningsAsErrors,WarningsNotAsErrorsandMSKit_SkipPackageChecksentries that name a code the old way no longer match. See the code reference.