Repository navigation
docs(validate,plan): an id the build phase refuses is a validate and plan warning (forge-cli#813) - #195
Merged
Conversation
…plan warning (forge-cli#813) fluid validate warns (--strict fails) and fluid plan warns and still writes the plan for a contract.id or builds[].id the build phase refuses. apply.md's Build ids section said both passed such an id silently; validate.md gets a section, plan.md a note, upgrading.md an entry.
This branch was previously deployed
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.
Documents forge-cli #813:
fluid validateandfluid planwarn about acontract.idorbuilds[].idthat the build phase refuses (1orders, or more than 128 characters). Plain validate passes,--strictfails, and plan still writes the plan.docs/cli/apply.md, "Build ids": the sentence that said validate and plan simply pass such an id now says they warn about it. The hint in the example output now reads "only warn about it", as #813 prints it.docs/cli/validate.md: a new section, "An id the build phase refuses", with the real output, the exit codes,--format json, and where the check runs (the contract file and a bundle's resolved contract, not workspace mode).docs/cli/plan.md: a Notes bullet. Plan prints the same warning and still writes the plan, whatever--modesays.docs/upgrading.md: an entry under "On forge-climainsince 0.26.0 (not yet released)", after the #803 and #808 ones.Draft until #813 merges, because the text says "on main". Checked against #813's head
a6758b80: the warning text, the hint and the exit codes come from running that tree. Local checks:check_cli_docs.py --markers-only,npm run docs:buildandscripts/check-dist-links.mjs.Update: #813 merged as
8c8116ed. I compareda6758b80with the squash commit. Only #808's--build-idgate inapply.pyand other PRs' CHANGELOG entries differ. The warning text, the apply hint and the CHANGELOG entry quoted here are unchanged, so the docs need no edit and the PR is ready for review.