Skip to content

feat(init): warn when a Python project has no Dockerfile #1506

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

Closed
patrikbraborec wants to merge 2 commits into from
Closed

feat(init): warn when a Python project has no Dockerfile #1506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c23d656
feat(init): warn when a Python project has no Dockerfile
patrikbraborec Oct 16, 2026
3fb2c62
refactor(init): name the Dockerfile warning condition
patrikbraborec Oct 16, 2026
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
17 changes: 16 additions & 1 deletion src/commands/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { basename } from 'node:path';
import { existsSync } from 'node:fs';
import { basename, join } from 'node:path';
import process from 'node:process';

import { ApifyCommand } from '../lib/command-framework/apify-command.js';
Expand Down Expand Up @@ -163,6 +164,20 @@ export class InitCommand extends ApifyCommand<typeof InitCommand> {
await setLocalConfig(configToWrite, cwd);
}

const isPythonWithoutDockerfile =
project.type === ProjectLanguage.Python &&
!this.flags.dockerfile &&
!actorConfig.unwrapOr(undefined)?.config.dockerfile &&
!existsSync(join(cwd, '.actor', 'Dockerfile')) &&
!existsSync(join(cwd, 'Dockerfile'));

if (isPythonWithoutDockerfile) {
warning({
message:
'No Dockerfile found. Without one, the Apify platform builds the Actor with a Node.js base image. Add one at .actor/Dockerfile (e.g. FROM apify/actor-python) or pass --dockerfile.',
});
}

await setLocalEnv(cwd);

// Create prefilled INPUT.json file from the input schema prefills
Expand Down
26 changes: 26 additions & 0 deletions test/local/commands/init.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ import { KEY_VALUE_STORE_KEYS } from '@apify/consts';
import { testRunCommand } from '../../../src/lib/command-framework/apify-command.js';
import { EMPTY_LOCAL_CONFIG, LOCAL_CONFIG_PATH } from '../../../src/lib/consts.js';
import { getLocalKeyValueStorePath } from '../../../src/lib/utils.js';
import { useConsoleSpy } from '../../__setup__/hooks/useConsoleSpy.js';
import { useTempPath } from '../../__setup__/hooks/useTempPath.js';
import { resetCwdCaches } from '../../__setup__/reset-cwd-caches.js';

const actName = 'init-my-actor';
const { beforeAllCalls, afterAllCalls, joinPath } = useTempPath(actName, {
Expand All @@ -16,11 +18,14 @@ const { beforeAllCalls, afterAllCalls, joinPath } = useTempPath(actName, {
cwdParent: false,
});

const { logMessages } = useConsoleSpy();

const { InitCommand } = await import('../../../src/commands/init.js');

describe('apify init', () => {
beforeEach(async () => {
await beforeAllCalls();
resetCwdCaches();
});

afterEach(async () => {
Expand Down Expand Up @@ -120,4 +125,25 @@ describe('apify init', () => {
expect(config).toStrictEqual(Object.assign(EMPTY_LOCAL_CONFIG, { name: actName }));
expect(config.dockerfile).toBeUndefined();
});

it('warns when a Python project has no Dockerfile', async () => {
await mkdir(joinPath('my_actor'), { recursive: true });
writeFileSync(joinPath('my_actor', '__init__.py'), '');
writeFileSync(joinPath('my_actor', '__main__.py'), '');

await testRunCommand(InitCommand, { args_actorName: actName, flags_yes: true });

expect(logMessages.error.join('\n')).toMatch(/No Dockerfile found/);
});

it('does not warn when a Python project has a Dockerfile', async () => {
await mkdir(joinPath('my_actor'), { recursive: true });
writeFileSync(joinPath('my_actor', '__init__.py'), '');
writeFileSync(joinPath('my_actor', '__main__.py'), '');
writeFileSync(joinPath('Dockerfile'), 'FROM apify/actor-python');

await testRunCommand(InitCommand, { args_actorName: actName, flags_yes: true });

expect(logMessages.error.join('\n')).not.toMatch(/No Dockerfile found/);
});
});
Loading