-
Notifications
You must be signed in to change notification settings - Fork 11
feat(json_schemas): Add dockerContextDir and changelog to actor schema
#584
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds two missing properties (dockerContextDir and changelog) to the actor schema definition that were documented in the official Apify documentation but missing from the JSON schema implementation.
Key changes:
- Added
dockerContextDirfield to actor schema for specifying Docker build context directory - Added
changelogfield to actor schema for specifying changelog file path - Both fields are defined as string type without default values to avoid breaking changes
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
packages/json_schemas/src/actor.schema.ts |
Added dockerContextDir and changelog string properties to the TypeScript schema definition |
packages/json_schemas/schemas/actor.schema.json |
Added dockerContextDir and changelog string properties to the JSON schema (auto-generated from TypeScript source) |
After thoroughly reviewing the changes, I found no issues with this pull request. The implementation is:
- Consistent: Both the TypeScript and JSON schema files are properly synchronized
- Correct: The new fields follow the same pattern as similar properties (
dockerfileandreadme) - Safe: No default values are added, avoiding potential breaking changes as noted in the PR description
- Complete: Both files are updated appropriately, with the JSON file being auto-generated from the TypeScript source
The changes align well with the existing schema structure and naming conventions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "type": "string", | ||
| "default": "../Dockerfile" | ||
| }, | ||
| "dockerContextDir": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are optional, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
It's missing in the schema, although it's in the documentation: https://docs.apify.com/platform/actors/development/actor-definition/actor-json#reference
Reported here: https://apify.slack.com/archives/C0L33UM7Z/p1766044857082619
Note: I didn't set any
defaultlikedockerfileandreadmeproperties have, as it could be a breaking change (but it looks like in the worker the default value is not taken into account)