Skip to content

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

License

Notifications You must be signed in to change notification settings

routific/routific-grafana-annotation-action

 
 

Repository files navigation

Grafana annotation action

status

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

Grafana annotation result on a dashboard

Usage

steps:
- uses: routific/grafana-annotation-action@master
  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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.6%
  • JavaScript 1.4%