fix: correct fire-and-forget example in apify push --help - #1359
Open
kuntal1461 wants to merge 1 commit into
Open
fix: correct fire-and-forget example in apify push --help#1359kuntal1461 wants to merge 1 commit into
kuntal1461 wants to merge 1 commit into
Conversation
The --help example showed `apify push --no-wait-for-finish`, but that flag was never registered. The framework strips the no- prefix at parseArgs registration time, so a boolean no-wait-for-finish flag would conflict with the existing wait-for-finish string flag and cannot exist alongside it. The correct fire-and-forget form -- already documented in the flag description -- is --wait-for-finish=0. Adds a regression test that asserts the working form appears in the rendered help and the broken form does not. Closes apify#1342
kuntal1461
force-pushed
the
fix/push-no-wait-for-finish-example
branch
from
August 27, 2026 20:41
28fc527 to
6a6adc2
Compare
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
2 participants
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.
Summary
--helpexample showedapify push --no-wait-for-finish, but that flag was never registered and crashed withError: Unknown flag provided(fixes apify push --no-wait-for-finish example in --help is broken (Unknown flag provided) #1342)no-prefix atparseArgsregistration time, so a booleanno-wait-for-finishflag would collide with the existingwait-for-finishstring flag — they cannot coexist--wait-for-finish=0, which is already documented in the flag's own description; the example now matchesChanges
src/commands/actors/push.ts— fix the broken example (2-line change)test/local/lib/command-framework/help.test.ts— regression test: asserts--wait-for-finish=0appears and--no-wait-for-finishdoes notTest plan
pnpm vitest run test/local/lib/command-framework/help.test.ts— 13 tests pass, including the new regression testrenders a valid fire-and-forget example for apify pushpnpm vitest run test/local/commands/push.test.ts— 11 tests passpnpm run test:local— 491 tests pass, 4 skippedpnpm run format— cleanpnpm oxlint --type-aware src/commands/actors/push.ts test/local/lib/command-framework/help.test.ts— 0 warnings, 0 errorsgit diff --check— cleanpnpm run dev:apify push --help— correctly shows$ apify push --wait-for-finish=0