{"id":21971152,"url":"https://github.com/squiddy/gitlab-deployment-annotations","last_synced_at":"2025-06-29T17:34:32.630Z","repository":{"id":142143910,"uuid":"241692076","full_name":"squiddy/gitlab-deployment-annotations","owner":"squiddy","description":"Provides a grafana datasource to get annotations for each deployment in gitlab.","archived":false,"fork":false,"pushed_at":"2023-03-06T23:57:11.000Z","size":90,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-24T19:47:59.313Z","etag":null,"topics":["gitlab","grafana","grafana-annotations"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/squiddy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-19T18:19:45.000Z","updated_at":"2024-10-23T08:59:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf4968c8-599c-446b-a495-4a94c855daf8","html_url":"https://github.com/squiddy/gitlab-deployment-annotations","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/squiddy/gitlab-deployment-annotations","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squiddy%2Fgitlab-deployment-annotations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squiddy%2Fgitlab-deployment-annotations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squiddy%2Fgitlab-deployment-annotations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squiddy%2Fgitlab-deployment-annotations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/squiddy","download_url":"https://codeload.github.com/squiddy/gitlab-deployment-annotations/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squiddy%2Fgitlab-deployment-annotations/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262638146,"owners_count":23341241,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitlab","grafana","grafana-annotations"],"created_at":"2024-11-29T14:48:56.864Z","updated_at":"2025-06-29T17:34:32.590Z","avatar_url":"https://github.com/squiddy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Annotations for grafana from gitlab deployments\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![Go](https://github.com/squiddy/gitlab-deployment-annotations/workflows/Go/badge.svg)\n\nProvides a grafana datasource to get annotations for each deployment in\ngitlab. Useful to see whether code you deployed had any impact.\n\n![Screenshot](extra/screenshot.png)\n\n## Usage\n\n```shell\n$ go build\n$ export GITLAB_URL=https://gitlab.example.com\n$ export GITLAB_TOKEN=apitoken \n$ export HTTP_ADDRESS=:8080\n$ ./gitlab-deployment-annotations\n```\n\nLog into grafana (`http://localhost:3000`) and add a SimpleJSON datasource\nand point it to your datasource, e.g. ``http://localhost:8080``\n\nAdd annotations to a dashboard using your datasource and configure the query\n(which accepts JSON), which allows you to select the project you want to\ndisplay, for example:\n\n```json\n{\"project_id\": 16, \"environment\": \"Live\"}\n```\n\n## Development\n\n1. Build a grafana container image with the simple-json-datasource plugin\npreinstalled using this Dockerfile:\n\n```Dockerfile\nFROM grafana/grafana\nRUN grafana-cli --pluginsDir \"$GF_PATHS_PLUGINS\" plugins install grafana-simple-json-datasource\n```\n\n`$ docker build -t gf .`\n\n2. Run a local instance of grafana\n\n`$ docker run --net host gf`\n\n3. Run and configure the datasource (see usage)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquiddy%2Fgitlab-deployment-annotations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquiddy%2Fgitlab-deployment-annotations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquiddy%2Fgitlab-deployment-annotations/lists"}