Skip to main content

Module settings

Module settings 

Source
Expand description

Every stk-owned git config key and its resolution logic, in one place.

Constants§

ABSORB_INCLUDE_UNSTAGED_KEY
CHECK_TIMEOUT_KEY
DEFAULT_CHECK_TIMEOUT_SECS
How long merge --wait polls a review’s checks before giving up, unless stk.checkTimeout overrides it. Generous so a slow-but-real CI is not cut off; the point is to bound a pipeline that never settles, not a long one.
DEFAULT_REMOTE
GITLAB_HOST_KEY
MERGE_STRATEGY_KEY
MERGE_WAIT_KEY
NO_UPDATE_CHECK_KEY
PROVIDER_KEY
PUSH_ON_RESTACK_KEY
PUSH_ON_SUBMIT_KEY
REMOTE_KEY
SETTINGS
Every [stk] setting the tool reads, with its default behavior. Shown by git stk config.
SUBMIT_DRAFT_KEY
SUBMIT_STACK_KEY
UPDATE_REFS_KEY

Functions§

bool_setting
A boolean setting’s value, defaulting to false when unset.
check_timeout
How long merge --wait keeps polling a review’s checks before giving up, from stk.checkTimeout (whole seconds). 0 waits indefinitely; unset uses DEFAULT_CHECK_TIMEOUT_SECS.
gitlab_host
A self-hosted GitLab host (e.g. gitlab.example.com) to recognize as GitLab alongside gitlab.com (stk.gitlabHost). glab reads the host from the git remote on its own, so this only widens stk’s provider detection.
merge_strategy
The merge strategy for git stk merge: squash, rebase, or merge.
push_enabled
Resolve a --push/--no-push flag pair against its config-key default.
remote
The remote used for provider detection, trunk discovery, and pushes.