README.md

Grafana annotation action

Add a Grafana annotation to your dashboards during your deployment with this GitHub Action.

Usage

steps:
- uses: frankie567/[email protected]
  with:
    apiHost: https://myinstance.grafana.net
    apiToken: ${{ secrets.GRAFANA_API_TOKEN }}
    text: Deployment of ${{ github.sha }}
    dashboardId: 1
    tags: deployment,github

Parameters

• apiHost (REQUIRED): Grafana API host.
• apiToken (REQUIRED): Grafana API token. How to create an API token ?.
• text (REQUIRED): Text of the annotation.
• dashboardId (OPTIONAL): Id. of the dashboard to add the annotation on. If not provided, will be global to all dashboards.
• panelId (OPTIONAL): Id. of the panel to add the annotation on. If not provided, will be global to all panels.
• tags (OPTIONAL): Comma-separated list of tags assigned to the annotation.

License

MIT License