Merge pull request #3 from ynab/db/better-logging

add support for unfurl_links + better logging

Author: dbertram

.github/workflows/branch-builder.yml

@@ -0,0 +1,31 @@
+name: Branch Builder
+
+on:
+    pull_request:
+      types: [opened, reopened, synchronize]
+    push:
+      branches: [ main ]
+      tags-ignore: "**"
+    workflow_dispatch:
+env:
+  BRANCH_NAME: ${{ github.head_ref || github.ref_name }} # github.head_ref for pull_request event and github.ref_name for push event
+  SLACK_BOT_TOKEN: ${{ secrets.SLACK_TEST_TOKEN }}
+  SLACK_CHANNEL_ID: ${{ secrets.SLACK_TEST_CHANNEL_ID }}
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Test Slack message with default settings
+        id: basic-message
+        uses: ./
+        with:
+          channel: ${{ env.SLACK_CHANNEL_ID }}
+          text: 'Test message from <https://github.com/${{ github.repository }}|`${{ github.repository }}`>:\n\nMessage sent from: <https://github.com/${{ github.repository }}/compare/main...${{ env.BRANCH_NAME }}|`${{ env.BRANCH_NAME }}`>\nWorkflow Log: <https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|Run ${{ github.run_id }}>'
+      - name: Test Slack message with optional inputs specified (reply message + unfurl_links disabled)
+        uses: ./
+        with:
+          channel: ${{ env.SLACK_CHANNEL_ID }}
+          thread_ts: ${{ steps.basic-message.outputs.ts }}
+          text: 'Test reply with a link to unfurl (that should _not_ unfurl): <https://aus.youneedabudget.com/|YNAB AU Marketing Site>'
+          unfurl_links: false

action.yml

@@ -13,21 +13,37 @@ inputs:
   text:
     description: "The message text to post"
     required: true
+  unfurl_links:
+    description: "Whether links in the message should be unfurled"
+    type: boolean
+    default: true
 outputs:
   ts:
     description: "The timestamp ID of the message that was just posted"
+    value: ${{steps.slack-post-message.outputs.ts}}
 branding:
   icon: 'tag'
   color: 'blue'
 runs:
   using: 'composite'
   steps:
-    - run: |
-        {
-          echo "ts=<<EOF"
-          curl --silent --show-error -X POST -H "Authorization: Bearer ${{ env.SLACK_BOT_TOKEN || inputs.token }}" -H "Content-Type: application/json; charset=utf-8" --url https://slack.com/api/chat.postMessage \
-            -d "{\"channel\": \"${{ inputs.channel }}\", \"thread_ts\":\"${{ inputs.thread_ts }}\", \"text\":\"${{ inputs.text }}\"}" \
-            | jq --raw-output '.ts'
-          echo "EOF"
-        } >> "$GITHUB_OUTPUT"
+    - name: Validate required inputs
       shell: bash
+      run: |
+        [[ "${{ inputs.channel }}" ]] || { echo "required input 'channel' not specified" ; exit 1; }
+        [[ "${{ inputs.text }}" ]] || { echo "required input 'text' not specified" ; exit 1; }
+    - name: POST to chat.postMessage API
+      id: slack-post-message
+      shell: bash
+      run: |
+        response=$(curl --fail-with-body --silent --show-error \
+          --request POST \
+          --header "Authorization: Bearer ${{ env.SLACK_BOT_TOKEN || inputs.token }}" \
+          --header "Content-Type: application/json; charset=utf-8" \
+          --url https://slack.com/api/chat.postMessage \
+          --data '{"channel": "${{ inputs.channel }}", "thread_ts": "${{ inputs.thread_ts }}", "unfurl_links": ${{ inputs.unfurl_links }}, "text": "${{ inputs.text }}"}' \
+        )
+        echo "Slack message API response:\n$response"
+        ts=$(echo "$response" | jq --raw-output '.ts')
+        echo "Setting ts output to $ts"
+        echo "ts=$ts" >> $GITHUB_OUTPUT