Skip to content
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.

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

Annotations priority docs #2683

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Annotations priority docs #2683

wants to merge 5 commits into from

Conversation

matthewborden
Copy link
Contributor

@matthewborden matthewborden commented Feb 29, 2024

Recently we've introduced the ability to control the ordering of build annotations using priority, a customer provided ordering. Priority is an integer value from 1 to 10 with 10 being the highest and 1 being the lowest. Annotations are ordered by priority then by the most recently created at annotation first.

This updates the Agent CLI docs with the new buildkite-agent annotate --priority 10 flag, and also updates the REST API docs to include the field when creating and reading annotations for a build.

@buildkite-docs-bot
Copy link
Contributor

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

Copy link
Contributor

@123sarahj123 123sarahj123 left a comment

Choose a reason for hiding this comment

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

amazing work!

my comments are just nit picks/optional suggestions ^_^

it's great! just not ticking bc I am not a snazzy documentation person 🥰

pages/agent/v3/cli_annotate.md Show resolved Hide resolved
pages/agent/v3/cli_annotate.md Outdated Show resolved Hide resolved
pages/agent/v3/cli_annotate.md Show resolved Hide resolved
<tr>
<th><code>priority</code></th>
<td>
An integer value by which to order the annotations on the build. This allows influencing the order of annotations. Ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If priority is not set, the default priority is 3.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
An integer value by which to order the annotations on the build. This allows influencing the order of annotations. Ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If priority is not set, the default priority is 3.
An integer value used to order the annotations on the build, allowing for controlled prioritization. Priority levels ranges from 1 to 10, with 10 being the highest priority and 1 being the lowest. If not specified, annotations default to a priority of 3.

seeing if I can make the phrasing just a little more concise :)

Comment on lines +50 to +54
buildkite-agent annotate 'Example 1 (Priority 1)' --context 'first' --priority 1
buildkite-agent annotate 'Example 2 (Priority 10)' --style 'info' --context 'second' --priority 10
buildkite-agent annotate 'Example 3 (Priority 4)' --style 'warning' --context 'third' --priority 4
buildkite-agent annotate 'Example 4 (Priority 4)' --style 'error' --context 'fourth' --priority 4
buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth'
Copy link
Contributor

Choose a reason for hiding this comment

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

Since the code block doesn't hold the entire width of each line, I'd move the --priority X options to the first position, similar to how the --style options are in the first position (in the section above)...

Suggested change
buildkite-agent annotate 'Example 1 (Priority 1)' --context 'first' --priority 1
buildkite-agent annotate 'Example 2 (Priority 10)' --style 'info' --context 'second' --priority 10
buildkite-agent annotate 'Example 3 (Priority 4)' --style 'warning' --context 'third' --priority 4
buildkite-agent annotate 'Example 4 (Priority 4)' --style 'error' --context 'fourth' --priority 4
buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth'
buildkite-agent annotate 'Example 1 (Priority 1)' --priority 1 --context 'first'
buildkite-agent annotate 'Example 2 (Priority 10)' --priority 10 --style 'info' --context 'second'
buildkite-agent annotate 'Example 3 (Priority 4)' --priority 4 --style 'warning' --context 'third'
buildkite-agent annotate 'Example 4 (Priority 4)' --priority 4 --style 'error' --context 'fourth'
buildkite-agent annotate 'Example 5 (Priority 3, Default)' --style 'success' --context 'fifth'

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

Successfully merging this pull request may close these issues.

4 participants