builds

Creates, updates, deletes, gets or lists a builds resource.

Overview

Name	builds
Type	Resource
Id	cloudflare.workers.builds

Fields

The following fields are returned by SELECT queries:

get

Build retrieved successfully

Name	Datatype	Description
build_outcome	string	(success, fail, skipped, cancelled, terminated) (example: success)
build_trigger_metadata	object
build_uuid	string (uuid)	Build UUID.
created_on	string (date-time)
initializing_on	string (date-time)
modified_on	string (date-time)
pull_request	object
running_on	string (date-time)
status	string	(queued, initializing, running, stopped) (example: running)
stopped_on	string (date-time)
trigger	object	Trigger information without build_token_uuid

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, build_uuid		Retrieve detailed information about a specific build
create_manual_build	insert	account_id, trigger_uuid		Trigger a manual build for a specific trigger
cancel	exec	account_id, build_uuid		Cancel a running or queued build

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
build_uuid	string (uuid)
trigger_uuid	string (uuid)

SELECT examples

get

Retrieve detailed information about a specific build

SELECT
build_outcome,
build_trigger_metadata,
build_uuid,
created_on,
initializing_on,
modified_on,
pull_request,
running_on,
status,
stopped_on,
trigger
FROM cloudflare.workers.builds
WHERE account_id = '{{ account_id }}' -- required
AND build_uuid = '{{ build_uuid }}' -- required
;

INSERT examples

create_manual_build

Trigger a manual build for a specific trigger

INSERT INTO cloudflare.workers.builds (
branch,
commit_hash,
seed_repo,
account_id,
trigger_uuid
)
SELECT 
'{{ branch }}',
'{{ commit_hash }}',
'{{ seed_repo }}',
'{{ account_id }}',
'{{ trigger_uuid }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: builds
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the builds resource.
  - name: trigger_uuid
    value: "{{ trigger_uuid }}"
    description: Required parameter for the builds resource.
  - name: branch
    value: "{{ branch }}"
    description: |
      Git branch name.
  - name: commit_hash
    value: "{{ commit_hash }}"
    description: |
      Git commit hash
  - name: seed_repo
    value:
      branch: "{{ branch }}"
      files:
        - content: "{{ content }}"
          filename: "{{ filename }}"
          isBase64: {{ isBase64 }}
          replace: "{{ replace }}"
      owner: "{{ owner }}"
      path: "{{ path }}"
      provider: "{{ provider }}"
      repository: "{{ repository }}"

Lifecycle Methods

cancel

Cancel a running or queued build

EXEC cloudflare.workers.builds.cancel 
@account_id='{{ account_id }}' --required, 
@build_uuid='{{ build_uuid }}' --required
;