A CircleCI orb for sending notifications to a Slack channel. This orb is a light wrapper around the circleci/slack orb is order to abstract away some common configuration.
The following environment variables are required to use this orb:
CIRCLE_API_TOKEN: used to retrieve the workflow name since slack does not provide one. See the CircleCI docs on how to generate a token, https://circleci.com/docs/2.0/managing-api-tokens/#creating-a-personal-api-tokenSLACK_ACCESS_TOKEN: the OAuth token acquired through the setup guide, https://github.com/CircleCI-Public/slack-orb/wiki/SetupSLACK_DEFAULT_CHANNEL: a Slack channel ID to post to. You can easily obtain the Slack channel ID by right clicking and copying a link to the channel. The ID will be visible at the end of the URL
It is recommended to create a slack context with these env vars and use that context in your workflows. See these docs on how to do so, https://circleci.com/docs/2.0/contexts/#creating-and-using-a-context
- CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.
- CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.
We welcome issues to be opened, but first, please check out the CircleCI-Public/slack-orb issues page as this repo is just a light wrapper around that orb.
Easily author and add Usage Examples to the src/examples directory.
Each YAML file within this directory will be treated as an orb usage example, with a name which matches its filename.
Usage examples should contain clear use-case based example configurations for using the orb.
- Create and push a branch with your new features.
- When ready to publish a new production version, create a Pull Request from your feature branch to
develop. - The title of the pull request must contain a special semver tag:
[semver:<segement>]where<segment>is replaced by one of the following values.
| Increment | Description |
|---|---|
| major | Issue a 1.0.0 incremented release |
| minor | Issue a x.1.0 incremented release |
| patch | Issue a x.x.1 incremented release |
| skip | Do not issue a release |
Example: [semver:major]
- Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
- On merge, after manual approval, the orb will automatically be published to the Orb Registry.
MIT