write

The write step type opens a multi-line text editor prompt, giving your custom commands and workflows a place to collect longer free-form input such as release notes or commit messages.

steps:
  - name: notes
    type: write
    prompt: Release notes
    placeholder: Summarize the change
    height: 8

Fields

prompt: Required. Prompt text shown to the user.
placeholder: Optional placeholder text.
height: Optional editor height in lines.
default: Optional text returned in a non-TTY environment (e.g. CI) instead of prompting.

Interactive steps require a TTY; in a non-TTY environment such as CI, the step uses its default text if set and otherwise errors. Reference the text later with {{ .steps.notes.value }}.

Fields​

Fields