docs: document pre-GUI submission hooks for Cinema 4D - #532
Merged
leon-li-inspire merged 1 commit intoAug 19, 2026
Merged
Conversation
Add a "Pre-GUI Submission Hooks" section to the README covering the pre-GUI hook support added to the Cinema 4D submitter (PR aws-deadline#480): - enabling env-sourced hooks (settings.allow_environment_hooks) and pointing DEADLINE_HOOKS_DIR at a hooks directory; - a hooks.yaml preGUI entry and a sample pregui_hook.py that reads the submission metadata on stdin and returns name/description/parameters (incl. deadline: job properties and CondaPackages) on stdout; - which submitter fields get pre-populated (Name/Description + the shared job-settings fields) and which Cinema 4D scene/render settings are NOT touched by the hook; - the Job Submission Confirmation prompt and settings.auto_accept. Docs only; no code changes. Signed-off-by: Leon Li <2182521+leon-li-inspire@users.noreply.github.com>
github-actions
Bot
added
the
waiting-on-maintainers
crowecawcaw
approved these changes
Aug 18, 2026
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: N/A — docs follow-up to the merged pre-GUI hook feature (#480)
What was the problem/requirement? (What/Why)
The Cinema 4D submitter gained pre-GUI submission hook support in #480, but the README documents none of it, leaving users with no reference for enabling or writing hooks.
What was the solution? (How)
Docs-only: add a "Pre-GUI Submission Hooks" section to
README.mdcovering enabling env-sourced hooks (DEADLINE_HOOKS_DIR+settings.allow_environment_hooks), thehooks.yamlformat and a samplepregui_hook.py, which submitter fields the hook pre-populates (and which Cinema 4D scene settings it does not), the confirmation prompt /settings.auto_accept, and the fail-closed behavior when a hook errors.What is the impact of this change?
Documentation only — no code, behavior, or dependency changes. Requires the
deadlineclient (deadline[gui] >= 0.60.4) already pinned by this package.How was this change tested?
Docs-only, so no unit/integration tests apply. Verified the Markdown renders and its link references resolve, and cross-checked the content against the merged submitter implementation on
mainline.Was this change documented?
Yes — this change is the documentation. No docstrings or adaptor schemas needed updating.
Is this a breaking change?
No.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.