Giter Site home page Giter Site logo

archive / github-actions-slack Goto Github PK

View Code? Open in Web Editor NEW
76.0 76.0 32.0 1.1 MB

Github Action for sending message (and reactions/threads/update/blocks) to Slack - With support for Slack's optional arguments

License: MIT License

JavaScript 100.00%
github-actions integration messaging nodejs slack

github-actions-slack's People

Contributors

archive avatar dependabot[bot] avatar kengotoda avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

github-actions-slack's Issues

node 20 support

Hello, thanks for the work done.
Do you plan to support node 20 ?

Is Windows supported?

Hi, when I try the API with my own user (I copied my channel ID), I get this error:

image

Breaks newline and tab

When passing slack example from the documentation

This is a line of text.\nAnd this is another one.

Should appear on slack like:

This is a line of text.
And this is another one.

But instead it shows

This is a line of text.\nAnd this is another one.

This is likely because you're escaping the escape character, in the payload...

{"channel":"some-channel","text":"This is a line of text.\\nAnd this is another one."}

New lines not working during slack-update-message-text

It looks like it is impossible to use text with new lines \n when using update-message

  uses: archive/github-actions-slack@master
  if: failure()
  with:
    slack-function: update-message
    slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_TOKEN }}
    slack-channel: ${{ fromJson(steps.send-message.outputs.slack-result).response.channel }}
    slack-update-message-text: ${{ steps.messages.outputs.failed }}
    slack-update-message-ts: ${{ fromJson(steps.send-message.outputs.slack-result).response.message.ts }}
    slack-optional-unfurl_media: false
    slack-optional-unfurl_links: false

In my case in ${{ steps.messages.outputs.failed }} I have complex message with new lines and emojis. Original text will edited but text will be in one line

Build: Android 1.5.5.0 (1567) \n failed

Upgrade from NodeJS12 to NodeJS 16 - Deprecation warning

Hello!

Thanks for the great action @archive!

With regards to:
https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

It would be great to get this action updated to reduce deprecation warnings ๐Ÿ™‡
Not urgent otherwise as NodeJS12 isn't going anywhere soon.

Happy to raise a PR, but maybe easiest for someone with push access to bump the version and check everything looks OK!

using: "node12"

Cheers!

Include optional params on update?

Hello

Thanks for this action, very nice. One thing I'm wondering is whether it would be possible to add support for including optional params on message update. I'm thinking of appending block sections as new details become available during a build.

Also, would it be possible to include an example showing the use of attachments/blocks? I managed it but found it a bit tricky, and it wasn't 100% clear on what other params were mandatory - I had to go to the code for that. Also, I believe it's possible to send just a block section, so maybe don't make the text field mandatory?

Thanks again.

Wildcard inputs don't work anymore

Hi, thanks for this Action. It seems that around May 2020, GitHub added validation resulting in warnings like this:

##[warning]Unexpected input(s) 'slack-optional-icon_emoji', valid inputs are ['slack-bot-user-oauth-access-token', 'slack-channel', 'slack-text', 'slack-optional-x']

The icon_emoji input also isn't passed in as an INPUT_... environment variable. So this mechanism will, unfortunately, need to be rethought.

Discussion/similar issue in another Action: cypress-io/github-action#141

Improve error handling

Currently, I can see Error: {} in the output which is not very useful. Maybe you can add more information when the error occurs.
In my case, I'm trying to replay in the thread and I guess the message format is wrong (I guess)

Add reaction to existing message

Hi, great library!

We use this to send a message like

๐Ÿš€ Deploying to production

Just before a deployment kicks off.

Since the slack-result output contains channel and timestamp fields, it'd be very useful to be able to add a โœ”๏ธ emoji to the same message after the deployment is complete (or โŒ if it failed). I was imagining something like this, with a new method input corresponding to https://api.slack.com/methods/chat.postMessage, https://api.slack.com/methods/reactions.add etc.:

- id: notify
  uses: archive/[email protected]
  with:
    method: chat.postMessage # this would be the default method for backwards compatibility
    slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN }}
    slack-channel: deployments
    slack-text: ':rocket: Deploying to production'

- run: ./deploy.sh

- uses: archive/[email protected]
  with:
    method: reactions.add
    slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN }}
    slack-channel: ${{ steps.notify.outputs.slack-result.channel }}
    timestamp: ${{ steps.notify.outputs.slack-result.ts }}
    name: white_check_mark

Update existing message

I was thinking that since lack-optional-thread_ts is already supported, it would be neat if (like with voxmedia/github-action-slack-notify-build) it was possible to update an existing message with new content. Mostly to change status during deployment from initial started to failure or success. Would that be difficult to implement?

Emojis Do not work

Tried this workflow and the message I get in slack is not showing and emoji. Not sure why but I tried a non custom one. I would ultimately like to send a custom one.

This is the message I received but no icon. In the input you can see the fire icon is shown and so its enabled but through this action icon_emoji does not work.

Screenshot 2024-05-29 at 2 35 07โ€ฏPM
name: Manual Test of Slack Messaging

on:
  workflow_dispatch:

jobs:
  slack-notifications:
    runs-on: ubuntu-20.04
    name: Sends a message to Slack when a push, a pull request or an issue is made
    steps:
      - name: Send message to Slack API
        uses: archive/[email protected]
        id: notify
        with:
          slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_TOKEN }}
          slack-channel: *********
          slack-text: Hello! Event "${{ github.event_name }}" in "${{ github.repository }}"
          slack-optional-icon_emoji: ":fire:"
      - name: Result from "Send Message"
        run: echo "The result was ${{ steps.notify.outputs.slack-result }}"  

Feature request: Attachments

Can we attach files?

We are running some automated tests. I'd really like it if I could attach failed testing results as a .txt file to a Slack message, to alert the developer.

This is a little easier than having them dig through GitHub log files.

Is there any way to do this? I didn't see it listed in the features, so this could be a useful add.

I may have a work around with my product to just use Sendmail, but slack is really our preferred communication channel!

== John ==

Error: Not In Channel

I'm trying to use this action but I keep getting an error

Run archive/[email protected]
  with:
    slack-bot-user-oauth-access-token: ***
    slack-channel: software-website
    slack-text: just work
    slack-optional-icon_emoji: :rocket:
DEBUG: Payload {"channel":"software-website","text":"just work","icon_emoji":":rocket:"}
Error: ["\"Error! {\\\"statusCode\\\":200,\\\"result\\\":\\\"{\\\\\\\"ok\\\\\\\":false,\\\\\\\"error\\\\\\\":\\\\\\\"not_in_channel\\\\\\\"}\\\"}\""]

It doesn't make any sense because I have the app installed to my workspace and the bot seems to be in the channel:

Screen Shot 2021-02-05 at 5 00 40 PM

I tried both channel IDs and names. This shit just doesn't work lol.

GitHub Workflows YAML Files uses incorrect parameter

The sample action files that use the Slack's Block Kit uses the slack-blocks parameter instead of slack-optional-blocks in .github/workflows/12-slack-message-blocks-update.yml and .github/workflows/11-slack-message-blocks.yml.

The `set-output` command is deprecated and will be disabled soon.

Action is producing warning below:

Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. 
For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

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.