Download the PHP package bbaga/buildkite-php without Composer
On this page you can find all versions of the php package bbaga/buildkite-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package buildkite-php
PHP client library for consuming the Buildkite API
Installation
Usage
- Setting up the API objects
- REST API
- GraphQL API
- Interacting with Buildkite's GraphQL API
- Interacting with Buildkite's REST API
- Example of traversing through resources
- Accessing resources without traversing
- Creating a new pipeline
- Direct API calls
- Organizations API
- List the
- Get a specific organization
- Pipelines API
- List pipelines in an organization
- Get a specific pipeline
- Create a pipeline
- Update a pipeline
- Delete a pipeline
- Builds API
- List all builds across all the organizations
- Get a specific build
- Get builds in an organization
- Get builds for a pipeline
- Create new build
- Cancel a running build
- Restarting a build
- Jobs API
- Retry a job
- Unblock a job
- Get logs for a job
- Delete logs of a job
- Get the environment variables from a job
- Artifacts API
- Get artifacts uploaded from a build
- Get artifacts uploaded from a job
- Get a specific artifact
- Delete a specific artifact
- Agents API
- List agents for an organization
- Get a specific agent
- Stop an agent
- Annotations API
- Get annotations uploaded by a build
- Users API
- Get current user
- Emojis API
- List available emojis
Setting up the API objects
\Psr\Http\Client\ClientInterface
implementation is available in the bbaga/buildkite-php-guzzle-client
package.
Rest API
GraphQL API
Interacting with Buildkite's GraphQL API
Interacting with Buildkite's REST API
Example of traversing through resources
Accessing resources without traversing
Fetching data for a specific build without traversing through the hierarchy.
Creating a new pipeline
Direct API calls
Organizations API
Organizations related methods are exposed via $api->organization()
Detailed documentation for the Organizations API is available here
List the organizations
Get a specific organization
Pipelines API
Pipelines related methods are exposed via $api->pipeline()
Detailed documentation for the Pipelines API is available here
List pipelines in an organizations
Get a specific pipeline
Create a pipeline
Update a pipeline
Delete a pipelne
Builds API
Builds related methods are exposed via $api->build()
Detailed documentation for the Builds API is available here
List all builds across all the organizations
Get a specific build
Get builds in an organization
Get builds for a pipeline
Create a new build
Cancel a running build
Restarting a build
Jobs API
Jobs related methods are exposed via $api->job()
Detailed documentation for the Jobs API is available here
Retry a job
Unblock a job
Get logs for a job
Delete logs of a job
Get the environment variables from a job
Artifacts API
Jobs related methods are exposed via $api->artifact()
Detailed documentation for the Artifacts API is available here
Get artifacts uploaded from a build
Get artifacts uploaded from a job
Get a specific artifact
Delete a specific artifact
Agents API
Agents related methods are exposed via $api->agent()
Detailed documentation for the Agents API is available here
List agents for an organization
Get a specific agent
Stop an agent
Annotations API
Annotations related methods are exposed via $api->annotation()
Detailed documentation for the Annotations API is available here
Get annotations uploaded by a build
Users API
Users related methods are exposed via $api->user()
Detailed documentation for the Users API is available here
Get current user
Emojis API
Emojis related methods are exposed via $api->emoji()
Detailed documentation for the Users API is available here
List available emojis
Contribution
Testing
Integration testing
A Buildkite account and a running agent is required for integration testing and the following environment variables must be set.
BK_TEST_TOKEN
BK_TEST_ORG
BK_TEST_PREFIX
GITHUB_REF
GITHUB_REPOSITORY
These can be set in the phpunit.xml
by making a copy of phpunit.xml.dist
and extending it with the following snippet
Once the environment variables are set the test suite can be started