Skip to content
Jason Yonker edited this page Oct 25, 2024 · 3 revisions

Glue Orb For CircleCI

Easily send customized Glue notifications as a part of your CI/CD pipeline, using rich templates.

What are Orbs?

Usage

The Glue orb makes use of Glue webhooks to post messages to your Glue workspace. Follow our setup guide for setting up a webhook.

For full usage guidelines, see the orb registry listing.

Templates

The Glue Orb comes with a number of included templates to get you started with minimal setup. Feel free to use an included template or create your own.

Template Preview Template Description
basic_success_1 basic_success_1 Should be used with the "pass" event.
basic_fail_1 basic_fail_1 Should be used with the "fail" event.
success_tagged_deploy_1 success_tagged_deploy_1 To be used in the event of a successful deployment job. see orb usage examples
basic_on_hold_1 basic_on_hold_1 To be used in the on-hold job. see orb usage examples

Branch or Tag Filtering

Limit Glue notifications to particular branches with the "branch_pattern" or "tag_pattern" parameter.

A comma separated list of regex matchable branch or tag names. Notifications will only be sent if sent from a job from these branches/tags. By default ".+" will be used to match all branches/tags. Pattern must match the full string, no partial matches. Keep in mind that "branch_pattern" and "tag_pattern" are mutually exclusive.

See usage examples.

Threaded Messages

Create threads for notifications using the thread_subject parameter. When using a thread_subject, your target value must be the group ID where the thread should be created. To send followup messages to the same thread, specify a thread_by value. All messages with a given thread_by value and group ID will go to the same thread.

- glue/notify:
      event: always
      target: grp_ABCXYZ
      thread_by: testing-$CIRCLE_SHA1
      thread_subject: Tests for $CIRCLE_SHA1
      custom: |
        **Tests started.**
- glue/notify:
      event: always
      target: grp_ABCXYZ
      thread_by: testing-$CIRCLE_SHA1
      thread_subject: Tests for $CIRCLE_SHA1
      custom: |
        **Tests finished.**

FAQ

View the FAQ Page