{{ message }}
docs(constraints): document the possible constraints and installTools#42837
Draft
jamietanna wants to merge 3 commits intomainfrom
Draft
docs(constraints): document the possible constraints and installTools#42837jamietanna wants to merge 3 commits intomainfrom
constraints and installTools#42837jamietanna wants to merge 3 commits intomainfrom
Conversation
To provide better coverage for our users of what is a valid option for a `constraints` value, we can validate the overall format of the `constraints` block, as well as the given names of constraints. Where we have a Tool defined, we can use the default versioning for that Tool to validate the constraint's value. For now, both the validation of the `constraints`' value, and the validation of `constraints`' names will be a warning, but in the future may be made an error.
This requires `toolNames` and `additionalConstraintNames` are exported for use.
…ols` Now we have a stronger type for what a valid tool constraint is, and what additional constraints are, we should be very explicit with what each option is, and specify them in the `constraints` as well as our `installTools` docs.
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.
Changes
Context
Please select one of the following:
constraintsandinstallToolsoptions? #42597AI assistance disclosure
Did you use AI tools to create any part of this pull request?
Please select one option and, if yes, briefly describe how AI was used (e.g., code, tests, docs) and which tool(s) you used.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via:
The public repository: