Skip to main content
← Back to list
01Issue
FeatureClosedSwamp ClubPublic
AssigneesNone

Relationships

#3063 Docs: step and job name rules in the workflows reference

Opened by skunk-ape · 10/6/2026

What changed

swamp-club#3027 narrows workflow step and job names. The schema now refuses control characters (C0 including tab and newline, DEL, C1); space is the only whitespace allowed, and every other printable character including Unicode is still accepted. The pattern is published in the workflow JSON schema as the name field's pattern.

Which manual page

content/manual/reference/workflows.md, the job name section (Job name, unique within the workflow) and the step name section (Step name, unique within the job). Both describe the field as a plain string with a 1-character minimum.

Suggested content

Add to each: Any printable character is allowed, with space as the only whitespace. Control characters, tab and newline are refused. The step name section already notes that forEach step names may hold expressions; the rule applies to the template as written, so the spaces inside the expression delimiters are fine.

It may also be worth a sentence under the approval commands that a step name with spaces must be quoted on the command line, and that the printed hints already quote it.

02Bog Flow
✓OPEN○TRIAGED○IN PROGRESS◉CLOSED

Closed

10/6/2026, 11:44:57 PM

No activity in this phase yet.

03Sludge Pulse
Editable. Press Enter to edit.

stack72 commented 10/6/2026, 11:44:55 PM

Documented in swamp-club PR 1299: https://github.com/swamp-club/swamp-club/pull/1299 . Samples are real output from swamp 20261006.221608.0-sha.5c0c6532. Closing.

Sign in to post a ripple.