Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 1.91 KB

README.md

File metadata and controls

77 lines (50 loc) · 1.91 KB
Raw

Bitbucket Pipelines Pipe: dorametrix-pipe

Conveniently call Dorametrix to create a deployment event.

Looking for a demo? In that case you might be interested in the Dorametrix Pipe demo.

YAML Definition

Add the following snippet to the script section of your bitbucket-pipelines.yml file:

- pipe: docker://mikaelvesavuori/dorametrix-pipe:1.0.0
  variables:
    ENDPOINT: "$ENDPOINT"
    API_KEY: "$API_KEY"
    PRODUCT: "$BITBUCKET_REPO_SLUG"

Variables

Ideally set these as repository variables ("secrets").

endpoint

Environment variable name: ENDPOINT.

Dorametrix API endpoint, in the format https://mydomain.com/stagename.

api-key

Environment variable name: API_KEY.

Dorametrix API token.

product (optional)

Environment variable name: PRODUCT.

The product name can be optionally set. If not, it will default to the repository name.

Details

This Action uses two secrets: ENDPOINT and API_KEY, as described above.

Prerequisites

  • Set the required environment variables, ENDPOINT and API_KEY.
  • Always ensure you have secure settings regarding what actions you allow.
  • Note that Dorametrix will not work without access to the Git history (i.e. with.fetch-depth: 0).

Examples

image:
  name: atlassian/default-image:3

pipelines:
  default:
    - step:
        name: Dorametrix
        script:
          - pipe: docker://mikaelvesavuori/dorametrix-pipe:1.0.0
            variables:
              ENDPOINT: "$ENDPOINT"
              API_KEY: "$API_KEY"
              PRODUCT: "$BITBUCKET_REPO_SLUG"

Support

Please create an issue on GitHub.

If you're reporting an issue, please include:

  • The version of the pipe
  • Relevant logs and error messages
  • Steps to reproduce the issue