https://github.com/frankie567/grafana-annotation-action

Add a Grafana annotation to your dashboards during your deployment with this GitHub Action
https://github.com/frankie567/grafana-annotation-action

deployment github-actions grafana

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/frankie567/grafana-annotation-action
• Owner: frankie567
• License: mit
• Created: 2020-03-08T15:35:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-11T12:00:18.000Z (about 1 year ago)
• Last Synced: 2024-09-20T07:32:18.170Z (4 months ago)
• Topics: deployment, github-actions, grafana
• Language: TypeScript
• Size: 1.73 MB
• Stars: 15
• Watchers: 3
• Forks: 7
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Grafana annotation action



  



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

![Grafana annotation result on a dashboard](/screenshot.png?raw=true)

## Usage

```yaml

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 ?](https://grafana.com/docs/grafana/latest/http_api/auth/#create-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](https://github.com/frankie567/grafana-annotation-action/blob/master/LICENSE)