Skip to content
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

docs: Document defer task options #1907

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

mjpieters
Copy link
Contributor

  • Fix the defer_call JSON schema to include the vars mapping.
  • Update the schema reference documentation to cover defer: {task: ..., vars: {...}}.

@mjpieters
Copy link
Contributor Author

mjpieters commented Nov 5, 2024

Do let me know if #1879 is likely to be accepted, as that would require updates to this PR (we can then simplify the JSON schema to use "anyOf": [{"type": "string"},{"$ref": "#/definitions/task_call"}], and we could retool [`Dependency`](#dependency) in the schema reference documentation to work for both dependencies and deferred tasks).

@vmaerten
Copy link
Member

vmaerten commented Dec 7, 2024

Hello !
I've merged #1879

- Reuse the task_call schema for the defer_call schema.
- Update the schema reference documentation to cover `defer: {task: ...,
  vars: {...}, silent: bool}`.
@mjpieters mjpieters force-pushed the json_schema_defer_task_vars branch from 318e684 to a433c6f Compare December 8, 2024 19:40
@mjpieters
Copy link
Contributor Author

Hello ! I've merged #1879

Excellent, thanks for the heads-up. I've reworked this MR to take that into account.

@andreynering andreynering added the area: docs Changes related to documentation. label Dec 12, 2024
@andreynering
Copy link
Member

Thanks @mjpieters!

@andreynering andreynering merged commit 82f6029 into go-task:main Dec 12, 2024
14 checks passed
@mjpieters mjpieters deleted the json_schema_defer_task_vars branch December 12, 2024 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Changes related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants