Skip to content

Commit e2d3b28

Browse files
committed
Clarify background step schema and error messages
1 parent 6cd024a commit e2d3b28

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

workflow-parser/src/model/converter/steps.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ function convertStep(context: TemplateContext, idBuilder: IdBuilder, step: Templ
167167
cancel
168168
};
169169
}
170-
context.error(step, "Expected uses or run to be defined");
170+
context.error(step, "Expected one of uses, run, wait, wait-all, or cancel to be defined");
171171
}
172172

173173
function createActionStepId(step: ActionStep): string {

workflow-parser/src/workflow-v1.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2132,7 +2132,7 @@
21322132
}
21332133
},
21342134
"steps": {
2135-
"description": "A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job. Must contain either `uses` or `run`.",
2135+
"description": "A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, run an action in your repository, a public repository, or an action published in a Docker registry, wait for background steps to complete, or cancel a background step. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.",
21362136
"sequence": {
21372137
"item-type": "steps-item"
21382138
}

0 commit comments

Comments
 (0)