Declare Pipeline¶

Declares a pipeline in Merkely.

Open an example, similar to the fragment below, from a git repo.

docker run \
    --env MERKELY_COMMAND=declare_pipeline \
    --env MERKELY_OWNER="${MERKELY_OWNER}" \
    --env MERKELY_PIPELINE="${MERKELY_PIPELINE}" \
    --env MERKELY_PIPE_PATH="${MERKELY_PIPE_PATH}" \
    --env MERKELY_API_TOKEN="${MERKELY_API_TOKEN}" \
    --env MERKELY_HOST="${MERKELY_HOST}" \
    --env MERKELY_DRY_RUN="${MERKELY_DRY_RUN}" \
    --rm \
    --volume ${YOUR_MERKELY_PIPE}:/data/Merkelypipe.json \
    merkely/change:latest

ENV_VAR_NAME	Required?	Notes
MERKELY_COMMAND	yes	The Merkely command to execute. This page documents a value of declare_pipeline
MERKELY_OWNER	yes	Your user/organization name in Merkely.
MERKELY_PIPELINE	yes	Your pipeline name in your user/organization in Merkely.
MERKELY_PIPE_PATH	no	The full path to your Merkelypipe file. Must be volume-mounted in the container. Defaults to /data/Merkelypipe.json.
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`.

Open an example, similar to the fragment below, from a git repo.

    - step: &declare_merkely_pipeline
        name: Declare Merkely Pipeline
        services: [ docker ]
        script:
          - *export_merkely_pipeline_env_vars
          - pipe: docker://merkely/change:latest
            variables:
              MERKELY_COMMAND: declare_pipeline
              MERKELY_OWNER: ${MERKELY_OWNER}
              MERKELY_PIPELINE: ${MERKELY_PIPELINE}
              MERKELY_PIPE_PATH: ${MERKELY_PIPE_PATH}
              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 declare_pipeline
MERKELY_OWNER	yes	Your user/organization name in Merkely.
MERKELY_PIPELINE	yes	Your pipeline name in your user/organization in Merkely.
MERKELY_PIPE_PATH	no	The full path to your Merkelypipe file. Must be volume-mounted in the container. Defaults to /data/Merkelypipe.json.
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`.

Open an example, similar to the fragment below, from a git repo.

    - name: Declare Merkely Pipeline
      uses: docker://merkely/change:latest
      env:
        MERKELY_COMMAND: declare_pipeline
        MERKELY_OWNER: ${{ env.MERKELY_OWNER }}
        MERKELY_PIPELINE: ${{ env.MERKELY_PIPELINE }}
        MERKELY_PIPE_PATH: ${{ github.workspace }}/Merkelypipe.json
        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 declare_pipeline
MERKELY_OWNER	yes	Your user/organization name in Merkely.
MERKELY_PIPELINE	yes	Your pipeline name in your user/organization in Merkely.
MERKELY_PIPE_PATH	no	The full path to your Merkelypipe file. Must be volume-mounted in the container. Defaults to /data/Merkelypipe.json.
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`.