> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# unmars/slack-orb-demo

A simple and reusable Slack notification orb for CircleCI. Provides easy-to-use commands and jobs for sending notifications to your team with customizable messages and build status using the official CircleCI Slack orb.


## Commands

### notify

Send a notification to Slack

| Parameter | Type | Default | Description |
|---|---|---|---|
| `channel` | string | $SLACK_DEFAULT_CHANNEL | Slack channel to send message to |
| `message` | string | Notification from CircleCI | Message to send |

## Jobs

### notify

Job to send notifications to Slack

| Parameter | Type | Default | Description |
|---|---|---|---|
| `channel` | string | $SLACK_DEFAULT_CHANNEL | Slack channel to send message to |
| `message` | string | Notification from CircleCI | Message to send |

## Executors

### default

This is a sample executor using Docker and Node. If you want to provide a custom environment in your orb, insert your image here. If you do not require an executor, you can simply delete this directory.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | lts | Pick a specific cimg/node image variant: https://hub.docker.com/r/cimg/node/tags
 |

## Examples

### example

Example usage of the Slack notification orb showing how to send targeted notifications to specific people, teams, or channels with custom messages.


```yaml
version: '2.1'
orbs:
  notification: unmars/slack-orb-demo@dev:alpha
workflows:
  example:
    jobs:
      - notification/notify:
          channel: '#devops'
          filters:
            branches:
              only: main
          message: ✅ Deployment to production completed successfully! 🚀
      - notification/notify:
          channel: '#general'
          message: New feature deployed to staging! 🎉
      - notification/notify:
          channel: '#alerts'
          message: Database migration completed successfully
```