Skip to content

Update cli_step.md#2223

Closed
stephanieatte wants to merge 1 commit intomainfrom
stephanieatte-patch-4
Closed

Update cli_step.md#2223
stephanieatte wants to merge 1 commit intomainfrom
stephanieatte-patch-4

Conversation

@stephanieatte
Copy link
Contributor

Customers have recently wanted to be be able update each job label individually and it is not possible. Because the Buildkite-agent does the label update on a step level

Customers have recently wanted to be be able update each job label individually and it is not possible. The Buildkite-agent does the label update on a step level
@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2223--bk-docs-preview.netlify.app


<%= render 'agent/v3/help/step_update' %>

label update works on a step level and not on the job level, it would not be possible to update each job in a step
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you explain a bit more about when someone might find themselves in this situation? For example, a correct version of something like:

Labels are applied to steps, not jobs, so you can't update a job label. When a step contains multiple jobs, all the jobs use the same label.

I also wonder if this might fit in better above the example where it's already talking about step labels.

Copy link
Contributor

Choose a reason for hiding this comment

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

If there's a ticket in Helpscout or a post in the forum, it might help me understand the details a bit better 😊

@ozdenyilmaz
Copy link
Contributor

This PR is no longer needed. The file it targeted (pages/agent/v3/cli_step.md) has moved to pages/agent/cli/reference/step.md and been rewritten. The current page now has a dedicated section called "Understanding step states vs job states" (line 68–70) that clarifies the distinction between step-level and job-level concepts. The note about label updates working at the step level (not the job level) is contextually covered by this section. Additionally, the one-line addition in the PR was informal and didn't follow docs style conventions. It can be safely closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants