Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions .github/review-references.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Cross-repository references for the apify-factory review (apify/ai-developer, `review-references`).
version: 1

instructions: |
This repository emulates the Apify platform for local Actor development. Find where the pull request
makes the runtime behave differently from the real platform in a way a user would notice: status
codes, error types and messages, field names and types, defaults, ordering, pagination, limits, run
and build lifecycle, events, and what an Actor sees in its container. A difference documented in
`requirements/` (`unsupported.md`, the `501` list in `api.md`, the "Known differences" sections) is
not a finding. Back every finding with the reference file and line (create public github link fixed
to a commit you have seen).

references:
- repository: apify/apify-core
ref: latest-release
paths:
- src/api/**
- src/packages/**
- src/daemons/**
instructions: |
The real platform: the API, storages, runs, builds, webhooks, schedules. Route handlers live under
`src/api/src/routes/<resource>/`, constants and limits in `src/packages/consts/`. Compare the
endpoint the pull request implements or changes with its handler here.
- repository: apify/apify-worker
instructions: |
How the platform starts a run's container: environment variables, resources and limits, lifecycle,
events and timeouts (`src/runtime/`, `src/actor/`, `src/builds/`). Compare the runtime's driver
and build with it.
- repository: apify/apify-containerd-proxy
instructions: |
How the platform routes and proxies traffic to and from a run's container (`internal/`). Compare
the runtime's container, HTTP and Standby proxies with it.
7 changes: 4 additions & 3 deletions .github/workflows/factory_review.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
name: apify-factory review (AI review, and auto-approval)

# Calls the review and auto-approval pipeline in apify/ai-developer. Approvals additionally need the
# repository's `factory_auto_approve` custom property set to true.
on:
# Taken from the default branch, never from the pull request, so a pull request cannot rewrite
# its own review pipeline. Pull request code is never checked out or executed.
Expand All @@ -19,11 +17,14 @@ permissions:

jobs:
factory-review:
uses: apify/ai-developer/.github/workflows/_factory_review.yaml@main
uses: apify/workflows/.github/workflows/factory_review.yaml@main
secrets: inherit
# Paths never auto-approved here, on top of the pipeline's defaults. Proposed from the
# repository's layout when this workflow was added; edit them like any other code.
with:
# The cross-repository references are drafted on this ai-developer branch; back to
# `main` once they land there.
ai-developer-ref: claude/review-references
policy: |
{
"denyGlobs": [
Expand Down
75 changes: 0 additions & 75 deletions .github/workflows/platform_parity_review.yaml

This file was deleted.

5 changes: 5 additions & 0 deletions CLAUDE.MD
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ does not emulate). When a change alters what the runtime does for
its users, update `skills/actor-runtime/SKILL.md` in the same commit - it is shipped documentation,
not a README.

### Additional context

The runtime emulates code that lives in other repositories. The most important references are defined in
[review references](./.github/review-references.yaml).

## Contribution conventions

### Requirements (`requirements/*.md`)
Expand Down
Loading