Skip to content

Commit

Permalink
chore: fixed changelog syntax to match promu rules
Browse files Browse the repository at this point in the history
  • Loading branch information
FUSAKLA committed Aug 12, 2019
1 parent aebf80f commit 8f1c134
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
23 changes: 9 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand All @@ -53,15 +48,15 @@ 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.

## Changed
- Refactored HTTP server middleware.

## [0.1.0] - 2019-06-25
## 0.1.0 / 2019-06-25

Initial release

11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Prometheus Gitlab Notifier

[![CircleCI](https://circleci.com/gh/FUSAKLA/prometheus-gitlab-notifier.svg?style=svg)](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)

Expand Down Expand Up @@ -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.

0 comments on commit 8f1c134

Please sign in to comment.