Pipelines provides the following custom commands for your use in your YAML file:

Example build definition files are available at Example Pipelines build definition files.

pipelines-artifact

Use with Node.js applications to build and upload the Node.js artifacts. For more information on how to create custom artifact names, see About build artifacts.

Example

version: 1.0.0
variables:
        global:

events:
    build:
    steps:
        - build:
        script:
            - nvm install v6.11.2
            - nvm use 6.11.2
            - npm install --production
        - upload-artifact:
        script:
            - pipelines-artifact start
            - pipelines-artifact upload $SOURCE_DIR
    fail-on-build:
    steps:
        - fail:
        script:
            - pipelines-artifact fail

pipelines-deploy

Create, deploy, or delete a Cloud Platform CD environment, depending on the event it is executed within. The pipelines-deploy command creates a Cloud Platform CD environment and deploys the build artifact if executed in the post-deploy event. The pipelines-deploy command deletes the corresponding Cloud Platform CD environment when used in pr-merged or pr-closed events. While this command can be executed in any event of the build definition file, Acquia recommends using it in the post-deploy event.

Example

build:
  steps:
    - build_site:
          script:
            - echo "Build instructions here"
post-deploy:
  steps:
    - deploy:
            script:
            - pipelines-deploy

For more information, see Creating a CD environment with Pipelines.

pipelines_metadata

Provide information from the container or the build execution for your use in other steps—for example, one item from a specific execution step whose value will influence a future direction in your build process. You can run this command from any section of your build definition file.

To view the contents of any metadata created using this key, run the status command with the --format=json option.

Usage

pipelines_metadata KEY VALUE [options]

where

• [key] is the variable name you want to create for reporting

• [value] is the value you want to set for your created variable

• [options] are any additional options you need to specify

Do not use the = operator. Use the format -u [value] or --url [value].

pipelines-sync-dbs

Syncs the databases provided as parameters, provided they are also listed as parameters in the cde-databases key. Requires the pipelines-deploy command.

If the pipelines-sync-dbs command is written after the pipelines-deploy event, the Pipelines logs will display the following error:

The pipelines-sync-dbs command cannot be defined in pipelines-deploy event.
It is available only in post-deploy, pr-merged and pr-closed events.

When the pipelines-sync-dbs command is written in post-deploy, pr-merged and pr-closed events, but is written before pipelines-deploy, the Pipelines logs display the following error message:

The pipelines-sync-dbs command cannot be used before pipelines-deploy.

For more information about syncing databases, see Copying a database into a Cloud Platform CD environment.

Example

version: 1.2.0
cde-databases:
- db1
- db2

events:

post-deploy:
    steps:
    # Deploy the build artifact to an on-demand environment,
    # and sync the specified databases.
    - deploy:
        script:
            - pipelines-deploy
            - pipelines-sync-dbs db1 db2

Commands available in Pipelines

version: 1.0.0
variables:
        global:

events:
    build:
    steps:
        - build:
        script:
            - nvm install v6.11.2
            - nvm use 6.11.2
            - npm install --production
        - upload-artifact:
        script:
            - pipelines-artifact start
            - pipelines-artifact upload $SOURCE_DIR
    fail-on-build:
    steps:
        - fail:
        script:
            - pipelines-artifact fail

build:
  steps:
    - build_site:
          script:
            - echo "Build instructions here"
post-deploy:
  steps:
    - deploy:
            script:
            - pipelines-deploy

pipelines_metadata KEY VALUE [options]

The pipelines-sync-dbs command cannot be defined in pipelines-deploy event.
It is available only in post-deploy, pr-merged and pr-closed events.

The pipelines-sync-dbs command cannot be used before pipelines-deploy.

version: 1.2.0
cde-databases:
- db1
- db2

events:

post-deploy:
    steps:
    # Deploy the build artifact to an on-demand environment,
    # and sync the specified databases.
    - deploy:
        script:
            - pipelines-deploy
            - pipelines-sync-dbs db1 db2