Skip to content

fix: correct fire-and-forget example in apify push --help #1359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kuntal1461 wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −2
Open

fix: correct fire-and-forget example in apify push --help #1359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/commands/actors/push.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ export class ActorsPushCommand extends ApifyCommand<typeof ActorsPushCommand> {
command: 'apify push E2jjCZBezvAZnX8Rb --force',
},
{
description: 'Deploy without waiting for the build to finish.',
command: 'apify push --no-wait-for-finish',
description: 'Deploy without waiting for the build to finish (fire-and-forget).',
command: 'apify push --wait-for-finish=0',
},
];

Expand Down
9 changes: 9 additions & 0 deletions test/local/lib/command-framework/help.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* eslint-disable max-classes-per-file */
import stripAnsi from 'strip-ansi';

import { ActorsPushCommand } from '../../../../src/commands/actors/push.js';
import {
ApifyCommand,
type BuiltApifyCommand as _BuiltApifyCommand,
Expand Down Expand Up @@ -139,6 +140,14 @@ describe('Help rendering', () => {
expect(output).toContain('# Abort a running Actor gracefully.');
expect(output).toContain('$ apify runs abort <runId>');
});

test('renders a valid fire-and-forget example for apify push', () => {
registerCommandForHelpGeneration('apify', ActorsPushCommand);
const output = stripAnsi(renderHelpForCommand(ActorsPushCommand));

expect(output).toContain('$ apify push --wait-for-finish=0');
expect(output).not.toContain('--no-wait-for-finish');
});
});

describe('CommandWithSubcommandsHelp.render()', () => {
Expand Down
Loading