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.

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

Specified dependencies by default #2708

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

Specified dependencies by default #2708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6605215
Specified dependencies by default
Mar 11, 2024
da404e8
Convert HTML in callout to Markdown (simplify contribution syntax) an…
gilesgas Mar 11, 2024
99a779a
Remove trailing space that caused the linting error.
gilesgas Mar 11, 2024
7c40535
Improve Markdown guidance on callouts.
gilesgas Mar 11, 2024
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
7 changes: 3 additions & 4 deletions pages/pipelines/_build_states.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Build state can be one of `creating`, `scheduled`, `running`, `passed`, `failing`, `failed`, `blocked`, `canceling`, `canceled`, `skipped`, `not_run`.
You can query for `finished` builds to return builds in any of the following states: `passed`, `failed`, `blocked`, or `canceled`.

>🚧
> When a <a href="/docs/pipelines/trigger-step">triggered build</a> fails, the step that triggered it will be stuck in the <code>running</code> state forever.

>📘
> 🚧
> When a [triggered build](/docs/pipelines/trigger-step) fails, the step that triggered it will be stuck in the `running` state forever.
> When all the steps in a build are skipped (either by using skip attribute or by using `if` condition), the build state will be marked as `not_run`.
> By default, all steps depend on the step that uploads them, and they will not run until that one is finished.
Comment on lines 6 to +7
Copy link
Contributor

@gilesgas gilesgas Mar 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

A couple of minor wording tweak suggestions, even though some of this content already existed...

Suggested change
> When all the steps in a build are skipped (either by using skip attribute or by using `if` condition), the build state will be marked as `not_run`.
> By default, all steps depend on the step that uploads them, and they will not run until that one is finished.
> When all the steps in a build are skipped (either by using the skip attribute or by using the `if` condition), the build state will be marked as `not_run`.
> By default, all steps depend on the step that uploads them, and they will not run until the uploading step is finished.

When you said 'that one', were you referring to the uploading step?
If so, it'd be better to refer to 'that one' as 'the uploading step' to be clear what it is you're referring to as 'that one' is inherently a tad ambiguous.

8 changes: 4 additions & 4 deletions styleguides/markdown-syntax-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ A regular info callout ("purple"):

```
> 📘 An info callout title
> Callout content can have <code>code</code> or _emphasis_ and other inline elements in it, <a href="#">including links</a>.
> Callout content can have `code` or _emphasis_ and other inline elements in it, including [internal](/docs/) or <a href="#">external</a> links.
> Every line break after the first becomes a new paragraph inside the callout.
```

Expand All @@ -220,7 +220,7 @@ This will be rendered as the following HTML in the site:
```
<section class="callout callout--info">
<p class="callout__title" id="a-callout-title"📘 An info callout title</p>
<p>Callout content can have <code>code</code> or <em>emphasis</em> and other inline elements in it, <a href="#">including links</a></p>
<p>Callout content can have <code>code</code> or <em>emphasis</em> and other inline elements in it, including <a href="/docs/">internal</a> or <a href="#">external</a> links.</p>
<p>Every line break after the first becomes a new paragraph inside the callout.</p>
</section>
```
Expand All @@ -233,15 +233,15 @@ For troubleshooting callouts ("orange"), use the 🚧 emoji:

```
> 🚧 A troubleshooting callout title
> Callout content can have <code>code</code> or <em>emphasis</em> and other inline elements in it, <a href="#">including links</a>.
> Callout content can have `code` or _emphasis_ and other inline elements in it, including [internal](/docs/) or <a href="#">external</a> links.
> Every line break after the first becomes a new paragraph inside the callout.
```

While no longer used in the Buildkite Docs, Work-in-progress (WIP) or Experimental callouts ("orange"), use the 🛠 emoji:

```
> 🛠 This marks it as WIP
> Callout content can have <code>code</code> or <em>emphasis</em> and other inline elements in it, <a href="#">including links</a>.
> Callout content can have `code` or _emphasis_ and other inline elements in it, including [internal](/docs/) or <a href="#">external</a> links.
> Every line break after the first becomes a new paragraph inside the callout.
```

Expand Down
Loading