{"id":21045188,"url":"https://github.com/fullpipe/herald","last_synced_at":"2026-05-16T15:35:39.355Z","repository":{"id":71274215,"uuid":"382449711","full_name":"fullpipe/herald","owner":"fullpipe","description":"Notify someone from some place about your success","archived":false,"fork":false,"pushed_at":"2021-10-31T09:11:04.000Z","size":595,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-20T17:36:12.899Z","etag":null,"topics":["grafana","grafana-annotations","notifications"],"latest_commit_sha":null,"homepage":"","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/fullpipe.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":"2021-07-02T19:56:00.000Z","updated_at":"2021-12-02T14:57:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"542fb70b-74bf-4bce-bcfe-13b9e11ad2d8","html_url":"https://github.com/fullpipe/herald","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullpipe%2Fherald","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullpipe%2Fherald/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullpipe%2Fherald/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullpipe%2Fherald/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fullpipe","download_url":"https://codeload.github.com/fullpipe/herald/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243489835,"owners_count":20299001,"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":["grafana","grafana-annotations","notifications"],"created_at":"2024-11-19T14:20:29.367Z","updated_at":"2025-10-10T05:06:58.848Z","avatar_url":"https://github.com/fullpipe.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# herald\n\nNotify someone from some place about your success\n\n## Install\n\n```bash\ngo install github.com/fullpipe/herald@latest\n```\n\n## Usage\n\n```bash\nherald help\n```\n\nFor example we want to notify grafana from local git repository\n\n```bash\nexport GRAFANA_API_KEY=abirvalg\n\nherald git grafana \\\n    --host https://grafana.example.com:3000 \\\n    --api-key ${GRAFANA_API_KEY} \\\n    --tag TASK-123 --tag release --tag foo-project \\\n\n# or you could modify message\nherald git grafana \\\n    --host https://grafana.example.com:3000 \\\n    --api-key ${GRAFANA_API_KEY} \\\n    --tag TASK-123 --tag release --tag foo-project \\\n    -m \"Project {{.project}} deployed. Going home.\"\n```\n\n| Add anotations                    | Feel the difference         | \n| ----------                        | :----------                 | \n| ![!](/assets/grafana-2.png)       | ![!](/assets/grafana-1.png) | \n\n## Places\n\nPlace tries to generate project metadata if possible.\nYou could find available place options by `herald PLACE help`\n\n| Place      | Description                              | \n| ---------- | :----------                              | \n| nowhere    | set meta as you want                     | \n| git        | reads meta from local git repository     |\n| gitlab     | reads meta from gitlab ci env vars       |\n\n### Metadata\n\nYou could use metadata in message templates. For example:\n\n```gotpl\nProject {{.project}} deployed\n\nProject: {{ or .project \"none\"}}\nURL: {{ or .url \"none\"}}\nBranch: {{ or .branch \"none\"}}\nCommitSHA: {{ or .sha \"none\"}}\nAuthor: {{ or .author \"none\"}}\n```\n\n## Targets\n\nIt's where you will see your success. \nYou could find available target options by `herald nowhere TARGET --help`.\n\n| Target        | Description                              | Required options       |\n| ----------    | :----------                              | :-----------           |\n| cli           | just prints out to your terminal         |                        |\n| grafana       | creates grafana annotation with tags     | `--host`, `--api-key`  |\n| slack         | send message to Slack channel            | `--webhook`            |\n\n## TODO:\n\n- ci\n- wrap in docker container\n- error handling\n- lint\n- commit message as meta.Description?\n- more targets\n  - telegram\n  - ...\n- more places\n  - github actions\n  - ...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffullpipe%2Fherald","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffullpipe%2Fherald","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffullpipe%2Fherald/lists"}