Git Product home page Git Product logo

action-slack's Introduction

๐Ÿš€ Slack for GitHub Actions

Sends a Slack notification. Simple as that.

GitHub Action

Appearance on Slack :

Slack message

This GitHub action is part of a list of Actions that are located in an other repo. Feel free to check it out : https://github.com/Ilshidur/actions.


Usage

action "Slack notification" {
  uses = "Ilshidur/action-slack@master"
  secrets = ["SLACK_WEBHOOK"]
  args = "A new commit has been pushed."
}

NOTICE : for stability purposes, it is recommended to use the action with an explicit commit SHA-1 :

uses = "Ilshidur/action-slack@c2f5329" (=> link to the commits list : https://github.com/Ilshidur/action-slack/commits/master)

Arguments

The argument is the message to display in the Slack notification.

Environment variables can be interpolated in the message using brackets ({{ and }}) :

e.g.: Action called : {{ GITHUB_ACTION }}

Note : be careful to properly format your messages for Slack.

Event Payload data can also be interpolated in the message using brackets ({{ and }}) with the EVENT_PAYLOAD variable.

e.g.: Action called: {{ GITHUB_ACTION }} as {{ EVENT_PAYLOAD.pull_request.id }}

See the event types for valid payload information

Examples

  • args = "Hello, beautiful ! I ran a GitHub Action for you <3"
  • args = "I showed you my commit. Please respond."

Environment variables

  • SLACK_CHANNEL (optional) : overrides the default channel of the webhook.
  • SLACK_OVERRIDE_MESSAGE (optional boolean, defaults to nothing) : set to true to remove the first line of the message (Ilshidur/nicolas-coutin.fr/Deployment triggered by Ilshidur (push) :). Any other value will override the message set in the args of this Action.

Secrets

Debugging / testing / development

Developers, all you need is in the DEVELOPMENT.md file.

Alternatives

Because open source is about everyone :

https://github.com/marketplace/actions/post-slack-message

https://github.com/marketplace/actions/slack-notify

https://github.com/marketplace/actions/slack-bot-action


Don't forget to ๐ŸŒŸ Star ๐ŸŒŸ the repo if you like this GitHub Action !
Your feedback is appreciated

action-slack's People

Contributors

hawler avatar ilshidur avatar renovate-bot avatar renovate[bot] avatar tsnolan23 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.