Skip to content

docs: document pre-GUI submission hooks for Houdini - #390

Open
leon-li-inspire wants to merge 1 commit into
aws-deadline:mainlinefrom
leon-li-inspire:feature/pre-gui-hook-docs
Open

docs: document pre-GUI submission hooks for Houdini#390
leon-li-inspire wants to merge 1 commit into
aws-deadline:mainlinefrom
leon-li-inspire:feature/pre-gui-hook-docs

Conversation

@leon-li-inspire

@leon-li-inspire leon-li-inspire commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

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 mainline had 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 base deadline-cloud README references docs/submission-hooks.md).

What was the solution? (How)

Docs-only: adds a short Submission Hooks section to README.md stating that the submitter supports Deadline Cloud submission hooks (pre-GUI and pre/post-submission), sourced from DEADLINE_HOOKS_DIR and enabled with deadline config set settings.allow_environment_hooks true, plus the Houdini launch path (the /out Deadline Cloud ROP panel). It links deadline-cloud/blob/mainline/docs/submission-hooks.md for the full details (hooks.yaml format, 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.

  • Have you run the unit tests? N/A — no code changed. Verified the Markdown renders and the base-doc link resolves.

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 from src/, then update the installer tests and post the test results below.

N/A — only README.md changed.

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.

@leon-li-inspire
leon-li-inspire requested a review from a team as a code owner August 18, 2026 22:16
@leon-li-inspire
leon-li-inspire force-pushed the feature/pre-gui-hook-docs branch from 427e92a to 8674e2d Compare August 18, 2026 22:24
Comment thread README.md Outdated
@github-actions github-actions Bot added the waiting-on-maintainers Waiting on the maintainers to review. label Aug 18, 2026
Comment thread README.md Outdated
@leon-li-inspire
leon-li-inspire force-pushed the feature/pre-gui-hook-docs branch from 8674e2d to 086a736 Compare August 18, 2026 23:27
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@leon-li-inspire
leon-li-inspire force-pushed the feature/pre-gui-hook-docs branch from 086a736 to 2f6539c Compare August 19, 2026 02:17
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@leon-li-inspire
leon-li-inspire force-pushed the feature/pre-gui-hook-docs branch from 2f6539c to 30a0916 Compare August 19, 2026 19:42
Signed-off-by: Leon Li <2182521+leon-li-inspire@users.noreply.github.com>
@leon-li-inspire
leon-li-inspire force-pushed the feature/pre-gui-hook-docs branch from 30a0916 to 1af98bf Compare August 19, 2026 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-maintainers Waiting on the maintainers to review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant