Skip to main content

Get CI config

GET 
/libraries/:libraryId/ci-config

The operation allows you to retrieve details about a CI config of a specific library and branch.

Request​

Path Parameters

    libraryId stringrequired

    Possible values: non-empty

Query Parameters

    branch stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

CI config detail

Schema

    build

    object

    required


    The build section encompasses fields dedicated to configuring Continuous Integration (CI) pipelines themselves.
    These settings allow users to define the environment variables, build container, and instance of pipeline necessary for building
    artifacts seamlessly within their development workflows.

    image stringrequired


    The field specifies the container utilized for executing build
    and unit test tasks within the Continuous Integration (CI) pipeline.

    environmentVariables

    object[]

    required


    The environmentVariables section configures custom environment variables
    that are utilized within the Continuous Integration (CI) pipeline.

  • Array [

    • name stringrequired


    The name of the environment variable.

    value stringrequired


    The value of the environment variable.

  • ]

    • pipelines

    object

    required


    The pipelines section defines and configures the specific pipelines
    to be executed for release builds and preview builds.

    release stringrequired


    Defines the pipeline id for performed release builds.
    Available pipelines can be obtained through the /ci-pipelines endpoint.

Loading...