Skip to content
Alex's Starlight Docs Alex's Starlight Docs
  • Auto
  • Light
  • Dark

Create

API Reference
Builds
Create a new build
client.Builds.New(ctx, body) (*IDstringConfigCommitstringCreatedAtTimeDocumentedSpecBuildObjectDocumentedSpecUnionObjectBuildObjectObjectOrgstringProjectstringTargetsBuildObjectTargetsUpdatedAtTimeBuildObject, error)
post/v0/builds

Create a new build

Parameters
bodyProjectfieldRevisionfieldAllowEmptyfieldBranchfieldCommitMessagefieldTargetsfieldBuildNewParams
Hide ParametersShow Parameters
Projectfield
optional
param.Field[string]

Project name

Revisionfield
param.Field[BuildNewParamsRevisionUnion]

Specifies what to build: a branch name, commit SHA, merge command ("base..head"), or file contents

Hide ParametersShow Parameters
string
BuildNewParamsRevisionMaptype
map[string, FileInputUnion]

File contents to commit directly

Hide ParametersShow Parameters
AllowEmptyfield
optional
param.Field[bool]

Whether to allow empty commits (no changes). Defaults to false.

Branchfield
optional
param.Field[string]

Optional branch to use. If not specified, defaults to "main". When using a branch name or merge command as revision, this must match or be omitted.

CommitMessagefield
optional
param.Field[string]

Optional commit message to use when creating a new commit.

Targetsfield
optional
param.Field[[]TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget]

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Hide ParametersShow Parameters
TargetNodeconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"node"
TargetTypescriptconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"typescript"
TargetPythonconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"python"
TargetGoconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"go"
TargetJavaconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"java"
TargetKotlinconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"kotlin"
TargetRubyconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"ruby"
TargetTerraformconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"terraform"
TargetCliconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"cli"
TargetPhpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"php"
TargetCsharpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"csharp"
Returns
IDstringConfigCommitstringCreatedAtTimeDocumentedSpecBuildObjectDocumentedSpecUnionObjectBuildObjectObjectOrgstringProjectstringTargetsBuildObjectTargetsUpdatedAtTimeBuildObject
package main

import (
  "context"
  "fmt"

  "github.com/stainless-api/stainless-api-go"
  "github.com/stainless-api/stainless-api-go/option"
)

func main() {
  client := stainless.NewClient(
    option.WithAPIKey("My API Key"),
  )
  buildObject, err := client.Builds.New(context.TODO(), stainless.BuildNewParams{
    Project: stainless.String("project"),
    Revision: stainless.BuildNewParamsRevisionUnion{
      OfString: stainless.String("string"),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", buildObject.ID)
}
200 Example
{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      },
      "upload": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}