Skip to content

Document hook output, post-configure, external commands, and hook PATH - #195

Open
jeremy wants to merge 1 commit into
mainfrom
hook-output-docs
Open

Document hook output, post-configure, external commands, and hook PATH#195
jeremy wants to merge 1 commit into
mainfrom
hook-output-docs

Conversation

@jeremy

@jeremy jeremy commented Feb 20, 2026

Copy link
Copy Markdown
Member

Summary

Documentation for basecamp/kamal#1782, basecamp/kamal#1783, basecamp/kamal#1784, and basecamp/kamal#1785.

  • New docs/configuration/external-commands.md page — .kamal/bin/<name> and kamal-<name> on PATH lookup, precedence, built-in shadowing prevention, hook PATH connection
  • New docs/hooks/post-configure.md page — timing, available env vars, destination rewriting/injection examples, require_destination interaction
  • Updated docs/hooks/overview.mdKAMAL_OUTPUT in env var list, new "Hook output" section (mechanism, special keys, accumulation, precedence), new "Hook PATH" section (.kamal/bin prepended to $PATH during hooks), post-configure in hooks list, fixed --skip_hooks--skip-hooks
  • Updated _data/docs.ymlpost-configure in sidebar navigation, External commands in sidebar navigation

Test plan

  • Verify Jekyll build passes
  • Verify external commands page renders at /docs/configuration/external-commands/
  • Verify post-configure page renders at /docs/hooks/post-configure/
  • Verify hook output and hook PATH anchor links work
  • Verify sidebar shows External commands under Configuration and post-configure under Hooks

Copilot AI review requested due to automatic review settings February 20, 2026 00:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for the new post-configure hook and the hook output mechanism, and wires the new page into the hooks navigation.

Changes:

  • Add new post-configure hook doc page with destination rewrite/injection examples.
  • Expand hooks overview docs to document $KAMAL_OUTPUT and the hook output semantics (special keys, accumulation, precedence).
  • Update the docs sidebar to include post-configure.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/hooks/post-configure.md New page describing post-configure timing, env, and destination injection/rewrites via hook output.
docs/hooks/overview.md Documents KAMAL_OUTPUT and adds a “Hook output” section + lists post-configure among hooks.
_data/docs.yml Adds post-configure to the Hooks section navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/hooks/post-configure.md Outdated
Comment thread docs/hooks/overview.md
@jeremy
jeremy requested a review from djmb February 20, 2026 00:44
@jeremy jeremy changed the title Document hook output and post-configure hook Document hook output, post-configure, external commands, and hook PATH Feb 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants