Summary

This PR introduces a handful of changes across this action in preparation for @v2! - #312 ✨

A few more changes might be needed, but I'm hoping this is in an alright place to test things! Most details are in the README but some testing notes are below 🙏 📚

One notable change from the proposal is the parsing of YAML values 😳 I stumbled across the js-yaml package during development and am finding that it parses super well and makes it a bit easier to author workflows - it all seems like YAML but it's parsed as a string that's converted to JSON via YAML! I think it's neat, but open to all discussion on this!

Planning to soon find ways to test this beyond local builds, but the steps for reviews can hopefully be helpful for testing things 🧪

- name: Checkout the Slack GitHub Action
  uses: actions/checkout@v4
  with:
    repository: slackapi/slack-github-action
    ref: v2-development
    path: ./slack-send
    token: ${{ secrets.GITHUB_TOKEN }}

- name: Setup Node
  uses: actions/setup-node@v4
  with:
    node-version: 20
    cache: "npm"
    cache-dependency-path: ./slack-send/package-lock.json

- name: Install dependencies
  run: npm install
  working-directory: ./slack-send

- name: Post a token message into channel
  uses: ./slack-send
  with:
    method: chat.postMessage
    token: ${{ secrets.SLACK_BOT_TOKEN }}
    payload: |
      channel: ${{ secrets.SLACK_CHANNEL_ID }}
      text: "Action happens at <https://github.com/${{ github.repository }}>"

📆 If these changes are seeming alright, I'm hoping to keep this PR open for a few more weeks for possible issues to appear in testing. Please do share issues you find!

Preview

Here, the payload uses a method and token with YAML values:

- name: Post a message to a channel using a token
  uses: slackapi/slack-github-action@v2
  with:
    method: chat.postMessage
    token: ${{ secrets.SLACK_BOT_TOKEN }}
    payload: |
      text: "Actions happen at <https://github.com/${{ github.repository }}>"
      channel: ${{ secrets.SLACK_CHANNEL_ID }}

This example POSTs the payload-file-path to the webhook URL:

- name: Start a Slack workflow using a webhook URL
  uses: slackapi/slack-github-action@v2
  with:
    webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
    payload-file-path: ./build-artifacts.json

Reviewers

From the kind reviewer, testing of all kinds is super appreciated! Using these changes with various token and method combinations, or testing edge cases with the payloads and inputs with webhook are all things that have changed, as well as some of the documentation that goes with this 📚

With this branch checked out, the following commands can be useful for testing on your own machine:

$ cat .github/workflows/local/README.md  # Explore details of the environment
$ vim .github/workflows/local/local.yml  # Change the action jobs to whatever
$ npm install
$ npm run local  # Run the workflows

Inspecting changes to code is also super appreciated, as always, though I'm still in the process of finishing some tests. Feel free to leave comments on anything or push directly!

Also holding off on requesting reviewers right at this moment since I'll be somewhat AFK the next weeks and slow to fast-follow fixes. Do know that I'm not meaning to ignore comments 👾

Notes

• Some tests cover happy paths and some cover edge cases but a few still don't exist for stubbing actual API calls for the @slack/web-api in client.js and similar-
• This change brings more files than before, but I found this made some sense during development. Open to all thoughts on this though!
• I'm unsure if the build step is needed for distributing the action, so I makes sense to add back if it's not a certain change! Hoping to test this within the PR though 👀

⚠️ CI is failing for two reasons! One is because the pull_request_targed used in main.yml is running the workflow on main with the changes of this PR. That fails due to build setups... Another failure is due to test coverage.

Hoping that the red "x" isn't so off-putting, but I believe the pull_request workflow is the most important for our tests 🔬

Todo

• Stub IRL callings of the @slack/web-api WebClient
• Add the build step back if it's now breaking - it does seem needed to avoid the npm install in testing...
• Confirm that thread_ts are being returned!
• Revert the removal of pull_request_target in CI

Requirements

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.