feat!: wrap payloads to send to a "method" with "token" or "webhook"

.c8rc.json

@@ -0,0 +1,7 @@
+{
+  "include": ["src/*.js"],
+  "exclude": ["**/*.spec.js"],
+  "reporter": ["lcov", "text"],
+  "all": false,
+  "cache": true
+}

.github/pull_request_template.md

@@ -1,4 +1,4 @@
-###  Summary
+### Summary
 
 Describe the goal of this PR. Mention any related Issue numbers.
 

.github/workflows/local/.env.example

@@ -1,4 +1,6 @@
 # Rename this file to .env and update any variables to get started
 
 SLACK_BOT_TOKEN=xoxb-01010101-abcdefgh
+SLACK_CHANNEL_ID=C0123456789
+SLACK_USER_TOKEN=xoxp-22222222-example
 SLACK_WEBHOOK_URL=https://hooks.slack.com/services/T0123456789/B0123456789/abcdefghijklmnopqrstuvwxyz

.github/workflows/local/README.md

@@ -1,25 +1,58 @@
 # Local runs
 
-For a simple development experience, a local version of this action can be used in experiments.
+For a simple development experience, a local version of this action can be used
+in experiments:
+
+```sh
+$ npm run local  # Test techniques
+```
 
 **Requirements**:
 
 - An installation of [nektos/act](https://github.com/nektos/act)
+- A running instance of [Docker](https://www.docker.com)
+
+## Setting up an app
+
+The saved `local.yml` workflow uses `webhook` and `method` for a combination of
+features, which expects the following scopes:
+
+- `chat:write`
+- `files:write`
+- `reactions:write`
 
-## Configuring secrets
+These scopes aren't required if the methods used change, but others might be if
+different API methods are called!
 
-To use `${{ secrets.* }}` in the workflow, move `.env.example` to `.env` and update any variables.
+This app will have useful variables that can be configured as values in this
+next section.
 
-## Mocking event payloads
+## Configuring values
 
-Different event payloads can be mocked directly with changes to the `event.json` file.
+### Changing secrets
+
+To use `${{ secrets.* }}` in the workflow, move `.env.example` to `.env` and
+update any variables.
+
+### Mocking event payloads
+
+Different event payloads can be mocked directly with changes to the `event.json`
+file.
 
 Reference: https://docs.github.com/en/webhooks/webhook-events-and-payloads
 
 ## Updating the workflow
 
-The `local.yml` file contains the workflow used for testing. Updates to these steps can be made to test various functionalities.
+The `local.yml` file contains the workflow used for testing. Updates to these
+steps can be made to test various functionalities.
 
 ## Running an experiment
 
-Run the workflow using `npm run local`. The above configurations will be used to simulate an actual workflow run.
+Run the workflow using `act` with the `npm run local` script. The above settings
+will be used to simulate an actual workflow run:
+
+```sh
+$ npm run local
+...
+[Local run/run] 🏁  Job succeeded
+```

.github/workflows/local/local.yml

@@ -9,20 +9,78 @@ jobs:
   run:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout action
-      uses: actions/checkout@v4
-    - name: Build action
-      run: npm install && npm run build
-    - name: Send a message into channel
-      id: slack
-      uses: ./.
-      with:
-        payload: |
-          {
-            "repository": "${{ github.repository }}",
-            "pull_request_username": "${{ github.event.pull_request.user.login }}",
-            "pull_request_title": ${{ toJSON(github.event.pull_request.title) }},
-            "pull_request_url": "${{ github.event.pull_request.html_url }}"
-          }
-      env:
-        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+      - name: Checkout action
+        uses: actions/checkout@v4
+      - name: Build action
+        run: npm install
+      - name: Post a webhook message into channel
+        id: webhook
+        uses: ./.
+        with:
+          webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
+          payload: |
+            repository: ${{ github.repository }}
+            pull_request_username: ${{ github.event.pull_request.user.login }}
+            pull_request_title: ${{ toJSON(github.event.pull_request.title) }}
+            pull_request_url: ${{ github.event.pull_request.html_url }}
+      - name: Post a token message into channel
+        id: api
+        uses: ./.
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            text: "Action happens at <https://github.com/${{ github.repository }}>"
+      - name: Upload this workflow file
+        id: file
+        uses: ./.
+        with:
+          method: files.uploadV2
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel_id: ${{ secrets.SLACK_CHANNEL_ID }}
+            initial_comment: "This code exists here"
+            file: .github/workflows/local/local.yml
+            filename: action.yml
+      - name: Initiate the deployment sequence
+        id: slack
+        uses: ./.
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            text: "Deployment started :eyes:"
+            attachments:
+              - color: "dbab09"
+                fields:
+                  - title: "Status"
+                    short: true
+                    value: "In Progress"
+      - name: Countdown
+        run: sleep 10
+      - name: Launch time is now
+        uses: ./.
+        with:
+          method: chat.update
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            ts: "${{ steps.slack.outputs.ts }}"
+            text: "Deployment finished :rocket:"
+            attachments:
+              - color: "28a745"
+                fields:
+                  - title: "Status"
+                    short: true
+                    value: "Completed"
+      - name: Celebrate wins
+        uses: ./.
+        with:
+          method: reactions.add
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            timestamp: ${{ steps.slack.outputs.ts }}
+            name: "tada"