Control Deployment

Fails a pipeline if an artifact is not approved for deployment in Merkely.

docker run \
    --env MERKELY_COMMAND=control_deployment \
    --env MERKELY_FINGERPRINT="${MERKELY_FINGERPRINT}" \
    --env MERKELY_OWNER="${MERKELY_OWNER}" \
    --env MERKELY_PIPELINE="${MERKELY_PIPELINE}" \
    --env MERKELY_API_TOKEN="${MERKELY_API_TOKEN}" \
    --env MERKELY_HOST="${MERKELY_HOST}" \
    --env MERKELY_DRY_RUN="${MERKELY_DRY_RUN}" \
    --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    merkely/change:latest

ENV_VAR_NAME

Required?

Notes

MERKELY_COMMAND

yes

The Merkely command to execute. This page documents a value of control_deployment

MERKELY_FINGERPRINT

yes

The artifact’s Fingerprint

MERKELY_OWNER

yes

Your user/organization name in Merkely.

MERKELY_PIPELINE

yes

Your pipeline name in your user/organization in Merkely.

MERKELY_API_TOKEN

yes

Your secret API token for Merkely. Set this to “DRY_RUN” to turn off all commands in all pipelines.

MERKELY_HOST

no

The API hostname for Merkely. Defaults to https://app.merkely.com

MERKELY_DRY_RUN

no

When set to “TRUE”, prints the command’s url+payload, does not make any HTTP calls to Merkely, and exits the command with a zero status code. Defaults to “FALSE”. See also setting the MERKELY_API_TOKEN (above) to code:`DRY_RUN`.

    - step: &fail_the_pipeline_unless_approved_for_deployment_in_merkely
        name: Fail the pipeline unless approved for deployment in Merkely
        services: [ docker ]
        script:
          - *export_merkely_fingerprint_env_vars
          - pipe: docker://merkely/change:latest
            variables:
              MERKELY_COMMAND: control_deployment
              MERKELY_FINGERPRINT: ${MERKELY_FINGERPRINT}
              MERKELY_OWNER: ${MERKELY_OWNER}
              MERKELY_PIPELINE: ${MERKELY_PIPELINE}
              MERKELY_API_TOKEN: ${MERKELY_API_TOKEN}

ENV_VAR_NAME

Required?

Notes

MERKELY_COMMAND

yes

The Merkely command to execute. This page documents a value of control_deployment

MERKELY_FINGERPRINT

yes

The artifact’s Fingerprint

MERKELY_OWNER

yes

Your user/organization name in Merkely.

MERKELY_PIPELINE

yes

Your pipeline name in your user/organization in Merkely.

MERKELY_API_TOKEN

yes

Your secret API token for Merkely. Set this to “DRY_RUN” to turn off all commands in all pipelines.

MERKELY_HOST

no

The API hostname for Merkely. Defaults to https://app.merkely.com

MERKELY_DRY_RUN

no

When set to “TRUE”, prints the command’s url+payload, does not make any HTTP calls to Merkely, and exits the command with a zero status code. Defaults to “FALSE”. See also setting the MERKELY_API_TOKEN (above) to code:`DRY_RUN`.

    - name: Fail the pipeline unless approved for deployment in Merkely
      uses: docker://merkely/change:latest
      env:
        MERKELY_COMMAND: control_deployment
        MERKELY_FINGERPRINT: docker://${{ env.IMAGE_TAGGED }}
        MERKELY_OWNER: ${{ env.MERKELY_OWNER }}
        MERKELY_PIPELINE: ${{ env.MERKELY_PIPELINE }}
        MERKELY_API_TOKEN: ${{ secrets.MERKELY_API_TOKEN }}

ENV_VAR_NAME

Required?

Notes

MERKELY_COMMAND

yes

The Merkely command to execute. This page documents a value of control_deployment

MERKELY_FINGERPRINT

yes

The artifact’s Fingerprint

MERKELY_OWNER

yes

Your user/organization name in Merkely.

MERKELY_PIPELINE

yes

Your pipeline name in your user/organization in Merkely.

MERKELY_API_TOKEN

yes

Your secret API token for Merkely. Set this to “DRY_RUN” to turn off all commands in all pipelines.

MERKELY_HOST

no

The API hostname for Merkely. Defaults to https://app.merkely.com

MERKELY_DRY_RUN

no

When set to “TRUE”, prints the command’s url+payload, does not make any HTTP calls to Merkely, and exits the command with a zero status code. Defaults to “FALSE”. See also setting the MERKELY_API_TOKEN (above) to code:`DRY_RUN`.