GitHub Action

The pushtodisplay/action GitHub Action lets you send display updates directly from your CI/CD pipelines. Use it to push deploy notifications, test results, build status, or any other information to your boards.

Basic usage

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

Setup

1. Store your API key as a secret

Go to your GitHub repository → Settings → Secrets and variables → Actions → New repository secret.

Name: PTD_API_KEY
Value: Your Push To Display API key

2. Add the action to your workflow

Create or edit a workflow file (e.g., .github/workflows/deploy.yml):

name: Deploy
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # ... your deploy steps ...

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

Inputs

Input	Required	Description
`api-key`	Yes	Your API key. Use a GitHub secret — never hardcode it.
`board-id`	No	Board ID. Uses your default board if omitted.
`text`	No	Simple text content. Use this or `blocks`, not both.
`blocks`	No	JSON array of styled blocks. Use this or `text`, not both.
`panel-id`	No	Target panel (1–4).
`full-panel`	No	Fill the entire panel area (`true` / `false`).
`density`	No	Content spacing: `compact`, `standard`, or `spacious`.
`align-x`	No	Horizontal alignment: `start`, `center`, or `end`.
`align-y`	No	Vertical alignment: `start`, `center`, or `end`.
`background`	No	Panel background color in hex (`#RRGGBB`).

You must provide either text or blocks. If both are provided, blocks takes priority.

Outputs

Output	Description
`message-id`	The unique message ID returned by the API.

Use the output in subsequent steps:

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

- run: echo "Message ID: ${{ steps.ptd.outputs.message-id }}"

See Examples for real-world workflow recipes.