Skip to content

Test Red-DiscordBot cogs

Boots a local tinkerer instance, copies the requested cog folders into Red, and exercises them over RPC to ensure they load cleanly.

Inputs

Input Required Default Description
token ✅ — Token passed to the background redbot tinkerer process for Discord authentication.
cog_paths ✅ — Comma-separated list of local directories that are copied into the cog install path before RPC tests run.
rpc_port ❌ 6133 TCP port exposed via --rpc-port; defaults to 6133 when not specified.

Usage

Caution

A redbot configuration for the instance "tinkerer" is required. Refer to setup-red-discordbot to create the necessary configuration.

Validate local cog folders through RPC (ben-cogs/.github/workflows/check-cogs.yml):

- name: Test cogs via RPC
  uses: nntin/d-flows/actions/test-red-discordbot@v1
  with:
    token: ${{ secrets.DISCORD_BOT_TOKEN }}
    cog_paths: ${{ env.COG_PATHS }}
    rpc_port: ${{ env.RPC_PORT }}