HOW TO USE THIS ORB

Firstly, create a reference to this orb like this:

orbs:
    slack-notifier: svinstech/slack-notifier-orb@1

Then, in a job of your choosing, you can send a Slack message as a step. Here are some examples:

jobs:
  job-name
    docker:
      - image: cimg/base:current
    run:
      - command |
          echo "export STRING_INTERPOLATION='some text'">>"$BASH_ENV"
    steps: 
      - slack-notifier/send-slack-message:
          header: A header for your message.
          message: The message to send. You may also use ${STRING_INTERPOLATION}.
          channel-webhook-environment-variables: SLACK_WEBHOOK_1 SLACK_WEBHOOK_2
  job-name-2
    docker:
      - image: cimg/base:current
    steps: 
      - slack-notifier/build-status-notification:
          header: A header for your message.
          pass-text: Tests passed! :checkmark:
          fail-text: Failures detected! Tag a group like this: !sdet. Tag a user like this: @kellen_kincaid
          when: always
          additional-text: Any other text you want to include.
          channel-webhook-environment-variables: SLACK_WEBHOOK_1

WEBHOOKS

This orb requires that the following be added as CircleCI environment variables:

• Slack webhooks for the message recipients.
  • The Slack webhook environment variable(s) must be used as the input for the channel-webhook-environment-variables argument of either the send-slack-message command or the build-status-notification command.

Obtaining a Slack webhook

You'll need access to a Slack app.
Here are 2 ways to do this:

1. (THE EASY WAY) Make a Jira card on the Quality team's Jira board. In that card, request to be made a collaborator on the Slack app called Notifier. Assign the card to Kellen Kincaid or any other SDET on the Quality team. Once you've been made a collaborator, you should see the Notifier app listed here

2. (THE LESS EASY WAY) If you'd rather create your own Slack app, you can do that here.
   After clicking the Create an app button, you'll be asked how you'd like to configure your app's settings. Select From scratch.
   Then you'll be asked to pick a workspace to develop your app. Select Vouch Insurance from the dropdown menu.
   After creating your app, you may need to request approval from a Slack admin.
   As of June, 2023, some Slack admins include: Yvonne Medellin & Cody Carter.

Webhooks

To get a Slack webhook, navigate into the Slack app and go to the Incoming Webhooks section (under Features). Click the Activate button if the section is inactive.
From there, you can add new webhooks, or copy existing ones.

---

RESOURCES

slack-notifier-orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.

CircleCI Orb Docs - Docs for using, creating, and publishing CircleCI Orbs.

Creating a Slack app - Docs for creating your own Slack app.

Feel free to reach out to Kellen Kincaid with any questions!