Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## What this is

A GitHub Action that sends messages, reactions, threads, and block-based messages to Slack via the Slack API. Written in JavaScript with zero runtime dependencies beyond `@actions/core` and `@actions/github`.
A GitHub Action that sends messages, reactions, threads, and block-based messages to Slack via the Slack API. Written in JavaScript with one runtime dependency: `@actions/core`.

- **Action entry point:** `dist/index.js` (compiled bundle — never edit this directly)
- **Source entry point:** `index.js` → `src/invoke.js`
Expand All @@ -17,12 +17,18 @@ npm run test-debug # Debug Jest with Node inspector
npm run lint # ESLint with auto-fix
npm run build # Compile dist/index.js via ncc (required before deploy)
npm run build-legacy # Use if build fails due to OpenSSL issues
```

Integration test (requires real Slack token):
```bash
# PowerShell
$env:BOT_USER_OAUTH_ACCESS_TOKEN="<token>"; $env:CHANNEL="<channel-id>"; node integration-test/end-to-end.js

# Integration test (requires real Slack token)
env BOT_USER_OAUTH_ACCESS_TOKEN=<token> CHANNEL=<channel-id> node integration-test/end-to-end.js
# bash/macOS
BOT_USER_OAUTH_ACCESS_TOKEN=<token> CHANNEL=<channel-id> node integration-test/end-to-end.js
```

**After any source change, run `yarn build` to update `dist/index.js`.** The action runs from `dist/index.js`, not the source files.
**After any source change, run `npm run build` to update `dist/index.js`.** The action runs from `dist/index.js`, not the source files.

## Architecture

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This Action allows you to send messages (and reactions/threads/update/blocks) to Slack from your Github Actions. Supports Slack's required arguments as well as all the optional once. It's JavaScript-based and thus fast to run.

The goal is to have zero npm/yarn dependencies except the two from Github that is required for an action to work (@actions/core & @actions/github).
The goal is to have zero npm/yarn dependencies except `@actions/core` which is required for an action to work.

![Slack result](./images/slack-result.png "Slack result")

Expand Down
Loading
Loading