ci(actions): clarify workflow and job names, add CI guide#141
Merged
Conversation
Names previously answered only "which language?". The new names also encode cadence (when a workflow runs) and depth (smoke to regression to nightly), reusing one shared vocabulary across all three stacks so the Actions tab reads clearly to a newcomer. Only workflow name: values, job keys, and job name: display strings change. No steps, matrices, service images, ports, timeouts, or if: guards are touched.
Adds docs/ci-workflows.md, a standalone guide to the CI topology: the trigger fan-out, the two lanes, the per-stack regressions, and the nightly sweep, with workflow and job/step tables plus the matrix, tag, and artifact conventions. Links the guide from the README docs list and from the senior CI reviewer learning path as the overview to read before inspecting the slices.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two related changes to make CI legible from the Actions tab, with no behavior change.
1. Clarify workflow and job names (
ci(actions))Renames the 5 workflows and their 12 jobs so the names encode cadence (when a
workflow runs) and depth (
smoke→regression→nightly), using one sharedvocabulary across all three stacks. Only workflow
name:values, job keys(
id), and jobname:display strings change — no steps, matrices, serviceimages, ports, timeouts, or
if:guards are touched.2. Add a CI workflow guide (
docs(actions))Adds
docs/ci-workflows.md: the trigger fan-out (with a Mermaid diagram), thetwo lanes (code-change vs scheduled), a workflows table, a jobs-and-steps table,
and the matrix, tag, and artifact conventions. Links it from the README docs
list and from the senior CI reviewer learning path.
Verification (local)
actionlint1.7.12 clean on all 5 workflows.docs/scenario-matrix.mdregenerated byte-identical (no drift).markdownlint-cli20.23.0 clean on the new doc and the edited files.commitlint(config-conventional) clean on both commits.Notes
mastercurrently has an empty required-status-checkslist, so the display-name changes do not orphan any required check — nothing
to reconcile.
master(thenightly-grid work on the previous branch already merged via Fix nightly Java Grid downloads and Edge session startup #140).