From 8f1c134acb05a19370211aa9b86e7bd1c6dfee94 Mon Sep 17 00:00:00 2001 From: Martin Chodur <m.chodur@seznam.cz> Date: Tue, 13 Aug 2019 01:57:06 +0200 Subject: [PATCH] chore: fixed changelog syntax to match promu rules --- CHANGELOG.md | 23 +++++++++-------------- README.md | 11 +++++++++-- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48899ce..b606b58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,17 +1,12 @@ -# Changelog -All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## Unreleased -## [Unreleased] - -## [0.7.0] - 2019-08-13 +## 0.7.0 / 2019-08-13 ## Changed - **The used port has changed from `9288` to `9629`** to align with [the port allocation politics of Prometheus integrations](https://github.com/prometheus/prometheus/wiki/Default-port-allocations). -## [0.6.0] - 2019-07-17 +## 0.6.0 / 2019-07-17 >**! Warning:** This release significantly changes logic of creating Gitlab issues and labeling scheme. Please read more about the new grouping feature. @@ -28,23 +23,23 @@ This applies only for issues younger than by default `1h` which can be controlle Every appended issue gets new scoped label `appended-alerts::<numer>` with number of times it was appended. - Readme notes about contributing and release. -## [0.5.0] - 2019-07-10 +## 0.5.0 / 2019-07-10 ## Added - Added dynamic label addition from the alert labels using flag `dynamic.issue.label.name` -## [0.4.1] - 2019-06-27 +## 0.4.1 / 2019-06-27 ## Fixed - Metric `app_build_info` is now initialized to value `1` -## [0.4.0] - 2019-06-27 +## 0.4.0 / 2019-06-27 ## Added - Added time to log messages - Added metric `app_build_info` with info about version of the app, build etc. -## [0.3.0] - 2019-06-26 +## 0.3.0 / 2019-06-26 ## Changed - Removed Gitlab call from readiness probe since the alerts @@ -53,7 +48,7 @@ are just enqueued and retrying should take care of that. ## Added - Check on startup that Gitlab is reachable. -## [0.2.0] - 2019-06-26 +## 0.2.0 / 2019-06-26 ## Added: - Added `status_code` to metrics and access log. @@ -61,7 +56,7 @@ are just enqueued and retrying should take care of that. ## Changed - Refactored HTTP server middleware. -## [0.1.0] - 2019-06-25 +## 0.1.0 / 2019-06-25 Initial release diff --git a/README.md b/README.md index fa62230..37b6631 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # Prometheus Gitlab Notifier +[](https://circleci.com/gh/FUSAKLA/prometheus-gitlab-notifier) + Tool which implements [Alertmanager](https://github.com/prometheus/alertmanager) webhook notifier -and creates Gitlab issue with the alert metadata. +and creates Gitlab issue based on the the alert. It allows you to define own issue template using the Go template, labeling scheme +of the resulting issue and group the alerts to a singe issue to avoid flooding yourself with identical issues. + +> This is probably possible in the Ultimate version of GitLab using +> the [Prometheus integration](https://docs.gitlab.com/ee/user/project/integrations/prometheus.html#setting-up-alerts-for-prometheus-metrics-ultimate), +> so if you have the possibility maybe first try that. For new features or changes check out the [CHANGELOG.md](./CHANGELOG.md) @@ -87,6 +94,6 @@ Example kubernetes manifests can be found at [kubernetes/](./kubernetes) **Contributing:** 1. Implement your changes and test them on your own testing repository. -1. Add note about changes made to the [CHANGELOG.md](CHANGELOG.md) `[Unreleased]` section. +1. Add note about changes made to the [CHANGELOG.md](CHANGELOG.md) `Unreleased` section. 1. Create PR and apply for CR from maintainers. 1. Get it merged. -- GitLab