Skip to content

Update cli_step.md #2223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update cli_step.md #2223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update cli_step.md 
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
  • Loading branch information
@stephanieatte
stephanieatte authored Jun 19, 2023
commit d22b92ccb9b4ca51fedd71894c41347b9b4df80a
1 change: 1 addition & 0 deletions pages/agent/v3/cli_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Use this command in your build scripts to update an attribute of a step.

<%= 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 😊

## Getting a step

Use this command in your build scripts to get the value of a particular attribute from a step.
Expand Down