Skip to content

docs: document configuration-level runtime.tag#380

Merged
soustruh merged 2 commits into
mainfrom
soustruh/config-runtime-tag
Jun 3, 2026
Merged

docs: document configuration-level runtime.tag#380
soustruh merged 2 commits into
mainfrom
soustruh/config-runtime-tag

Conversation

@soustruh
Copy link
Copy Markdown
Contributor

@soustruh soustruh commented Jun 3, 2026

Why

The configuration-level runtime.tag mechanism was underdocumented:

  • integrate/jobs/index.md mentioned it in one sentence with no key path and no example.
  • The runtime bullet in extend/docker-runner/index.md named no keys.
  • The "Job Runtime configuration" opener listed only backend and parallelism, though tag is documented in the same section.

Result: tooling answering from these docs reports the tag can only be set in the job request and gives no config-level JSON shape.

What

  • integrate/jobs/index.md: restructured the runtime settings into a bulleted list (backend, parallelism, tag); added a JSON example of the config-level runtime node (sibling of parameters), how to read the resolved tag (job tag field), and a note that a pinned config keeps running the old image until the key is removed.
  • extend/docker-runner/index.md: runtime bullet now lists the keys (tag, backend, parallelism) and links to the runtime settings section.

@soustruh soustruh force-pushed the soustruh/config-runtime-tag branch from 3a7e641 to d9ab1aa Compare June 3, 2026 09:35
@soustruh soustruh marked this pull request as ready for review June 3, 2026 09:36
@soustruh soustruh requested a review from odinuv June 3, 2026 09:42
Comment thread integrate/jobs/index.md
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks!

@soustruh soustruh merged commit bc5ca6d into main Jun 3, 2026
1 check passed
@soustruh soustruh deleted the soustruh/config-runtime-tag branch June 3, 2026 12:39
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