Skip to content

docs(apify-actor-development): clarify apify push builds but does not run — trigger a run explicitly #73

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

Draft
DaveHanns wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(apify-actor-development): clarify apify push builds but does not run — trigger a run explicitly #73

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
11 changes: 11 additions & 0 deletions skills/apify-actor-development/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Use the appropriate CLI command based on the user's language choice. Additional
6. **Write documentation** - Create comprehensive README.md for the marketplace (see [references/actor-readme.md](references/actor-readme.md) — this is mandatory, not optional)
7. **Test locally** - Run `apify run` to verify functionality (see Local testing section below)
8. **Deploy** - Run `apify push` to deploy the Actor on the Apify platform (Actor name is defined in `.actor/actor.json`)
9. **Trigger a run** - `apify push` only builds; it does not execute the Actor. If the task is "deploy and produce output", follow up with `apify call <actor-id>` (blocking) or `apify actors start <actor-id> --input '{...}'` then `apify runs wait <runId>` (non-blocking). Confirm `apify runs info <runId>` reports `status: SUCCEEDED`. See [`apify push` builds, it does not run](#apify-push-builds-it-does-not-run) below.

## Security

Expand Down Expand Up @@ -180,6 +181,16 @@ Actor input is one JSON object, not an array. `--input` accepts inline JSON obje

If no dedicated Actor exists for your target, search Apify Store for community options before building from scratch.

### `apify push` builds, it does not run

`apify push` only uploads source and builds a new Actor version — it does not execute the Actor. If the task is "deploy and produce output", follow up with an explicit invocation:

- `apify call <actor-id>` — blocking, prints the run summary.
- `apify actors start <actor-id> --input '{...}'` then `apify runs wait <runId>` — non-blocking start plus wait.
- For Standby Actors: hit the Standby URL once so the platform spins up a run.

End every deploy workflow with a check that `apify runs info <runId>` reports `status: SUCCEEDED`. A successful `apify push` exits 0 and prints a Console URL, which is easy to read as "done" even when the runs tab is still empty.

### Local and runtime commands

Always use `apify run` to test Actors locally. Do not use `npm run start`, `npm start`, `yarn start`, or other package manager commands - these will not properly configure the Apify environment and storage.
Expand Down
Loading