Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.
vole
Clone

Read only, no credentials:

https://rodent.software/vole.git

Write over SSH with a registered key:

git clone ssh://git@rodent.software:2222/vole.git

A free and open-source forge that lives in your Git repo.

#147

Show workflow and job names and descriptions

merged · by keenan 8d ago · merged into main at 1cde8b9e by keenan 8d ago

keenan opened this 8d ago

Why

The workflows page showed the file path and job IDs, so a reader had to open the YAML comments to learn what a workflow was for. This is the identity and description slice of #138.

What changes

  • Add top-level name: and description: to workflows, defaulting the name to the file stem (verify.yaml → verify).
  • Add job name: and description:, defaulting the name to the job ID.
  • Validate both as trimmed, single-line text, with an 80-byte name limit and a 500-byte description limit.
  • Pin names and descriptions with a queued run, so editing a workflow later does not rewrite the pages of runs that already happened.
  • Show the metadata on the workflows page, the run page, the runs list, the repository overview, and change check lists.
  • Document the fields in the workflow reference.
  • Add a “What a workflow cannot express” section to the workflow reference.
  • State in docs/workflows.md that CI jobs are independent and unordered; only a local run uses declaration order.

Checks

  • git diff --check
  • go vet -tags sqlite_fts5 ./...
  • vole workflow run verify — formatting, vet, build, licenses, govulncheck, packaging, links, and race tests all passed.

Part of #138. This does not close the tracking issue.

Discussion (0)

No discussion yet.