Push To Display — GitHub Action

A GitHub Action that pushes content to devices using the Push To Display API. Use it in your CI/CD workflows to send deployment statuses, build results, alerts, or any structured content to physical display devices.

Quick Start

- uses: pushtodisplay/action@v1
  with:
    api-key: ${{ secrets.PTD_API_KEY }}
    board-id: ${{ secrets.PTD_BOARD_ID }}
    text: "Deploy completed"

Inputs

Input	Required	Description
api-key	Yes	API key for authentication (X-Api-Key header)
board-id	No	Signed board ID to push content to (defaults to your default board)
text	No*	Simple text content to display (creates a single block)
blocks	No*	JSON array of display blocks
panel-id	No	Panel ID (1–4) to target a specific panel
full-panel	No	Use full panel display mode
size	No	Text size: small, medium, or large
color	No	Text color in hex format #RRGGBB

* Either text or blocks must be provided.

Outputs

Output	Description
message-id	The message ID returned by the API

Authentication

API keys are issued from the Push To Display admin portal and should be stored as GitHub secrets.

License

MIT.