Skip to content

document BUILD_STATUS #599

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
taylorsilva wants to merge 1 commit into
base: master
Choose a base branch
from
Open

document BUILD_STATUS #599

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
11 changes: 9 additions & 2 deletions docs/docs/resource-types/implementing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,12 @@ the URL. Same as what you would see in the web UI. Will be the same value as

: The short URL of the build in the form `$ATC_EXTERNAL_URL/builds/$BUILD_ID`

`$BUILD_STATUS`

: Will have a value of `success/failure/aborted/errored`. Only present when
the resource is under one of the hook steps
[`on_[success/failure/abort/error]`](../steps/modifier-and-hooks/index.md)

If the build is a one-off, `$BUILD_NAME`, `$BUILD_JOB_NAME`, `$BUILD_PIPELINE_NAME`, and `$BUILD_PIPELINE_INSTANCE_VARS`
will not be set.

Expand All @@ -267,8 +273,9 @@ None of these variables are available to [check](#check-check-for-new-versions).
These variables should be used solely for annotating things with metadata for traceability, i.e. for linking to the
build in an alert or annotating an automated commit to facilitate its origin discovery.

They should _not_ be used to emulate versioning (e.g. by using the increasing build number). They are not provided
to [`task` steps](../steps/task.md) to avoid this anti-pattern.
They should _not_ be used to emulate versioning (e.g. by using the increasing
build number). By default they are not provided to [`task`
steps](../steps/task.md) to avoid this anti-pattern.

## Certificate Propagation

Expand Down