fix: reconcile documentation with actual behavior#381
Open
josegonzalez wants to merge 2 commits into
Open
Conversation
The review tracked in #374 surfaced six documented behaviors the code did not implement. Where the documentation was the intended spec, the code now matches it: `apply` and `plan` fetch a recipe from an `http(s)` `--tasks` URL, and `docket init` writes a play-level name so `--play` resolves after scaffolding. The apply marker table, the play-skipped summary, the vars-file bool coercion forms, and the WSL install destination were corrected in the docs to match the code.
|
A remote `--tasks` URL was requested twice per command, once while parsing flags and once while running; the recipe bytes read during flag parsing are now reused when the same source is resolved, so `apply` and `plan` make a single request. Also reformats the new bats test to satisfy shfmt.
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.
The review tracked in #374 surfaced six documented behaviors the code did not implement. Where the documentation was the intended spec, the code now matches it:
applyandplanfetch a recipe from anhttp(s)--tasksURL (fetched once per command and reused across flag parsing and execution), anddocket initwrites a play-level name so--playresolves after scaffolding. The apply marker table, the play-skipped summary, the vars-file bool coercion forms, and the WSL install destination were corrected in the docs to match the code.