docs: document pre-GUI submission hooks for Houdini - #390
Open
leon-li-inspire wants to merge 1 commit into
Open
Conversation
leon-li-inspire
force-pushed
the
feature/pre-gui-hook-docs
branch
from
August 18, 2026 22:24
427e92a to
8674e2d
Compare
leon-li-inspire
force-pushed
the
feature/pre-gui-hook-docs
branch
from
August 18, 2026 23:27
8674e2d to
086a736
Compare
leon-li-inspire
force-pushed
the
feature/pre-gui-hook-docs
branch
from
August 19, 2026 02:17
086a736 to
2f6539c
Compare
leon-li-inspire
force-pushed
the
feature/pre-gui-hook-docs
branch
from
August 19, 2026 19:42
2f6539c to
30a0916
Compare
Signed-off-by: Leon Li <2182521+leon-li-inspire@users.noreply.github.com>
leon-li-inspire
force-pushed
the
feature/pre-gui-hook-docs
branch
from
August 19, 2026 20:03
30a0916 to
1af98bf
Compare
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
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 — documentation follow-up to #364.
What was the problem/requirement? (What/Why)
The Houdini submitter runs submission hooks (pre-GUI shipped in #364; pre/post-submission via the client), but
mainlinehad no mention of it — an artist/TD reading this README wouldn't know hooks are supported or how to turn them on. Rather than duplicate the client library's hooks documentation, this points readers at it (matching how the basedeadline-cloudREADME referencesdocs/submission-hooks.md).What was the solution? (How)
Docs-only: adds a short Submission Hooks section to
README.mdstating that the submitter supports Deadline Cloud submission hooks (pre-GUI and pre/post-submission), sourced fromDEADLINE_HOOKS_DIRand enabled withdeadline config set settings.allow_environment_hooks true, plus the Houdini launch path (the/outDeadline Cloud ROP panel). It linksdeadline-cloud/blob/mainline/docs/submission-hooks.mdfor the full details (hooks.yamlformat, hook I/O, version requirements, confirmation prompt, security). No code changes.What is the impact of this change?
Documentation only — no source, adaptor, installer, or schema changes.
How was this change tested?
Docs-only change; no code paths were modified.
Please run the integration tests and paste the results below.
N/A — documentation-only change.
If
installer/was modified or a file was added/removed fromsrc/, then update the installer tests and post the test results below.N/A — only
README.mdchanged.Was this change documented?
Yes — this change is the documentation (README only; this repo keeps no user-facing DCC docs under
docs/). No docstrings or adaptor init-data/run-data schemas were affected.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.