From ce13a040b8a0421e60a1c8b76e409f19a93679d5 Mon Sep 17 00:00:00 2001
From: justusbunsi <sk.bunsenbrenner@gmail.com>
Date: Sun, 22 May 2022 14:25:03 +0200
Subject: [PATCH] Introduce changelog

Signed-off-by: Steven Kriegler <sk.bunsenbrenner@gmail.com>
---
 CHANGELOG.md   | 33 +++++++++++++++++++++++++++++++++
 README.md      |  5 +++++
 helm/README.md |  4 ++++
 3 files changed, 42 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..ab9182b
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,33 @@
+# Changelog
+
+## v0.2.0
+
+### 🤖 Application
+
+- Add webhook secret validation
+- Improve configuration file flexibility
+- Stop log output for `/ping` and `/favicon.ico` endpoints
+
+### 🐳 Docker image
+
+- Add `GITEA_SQ_BOT_CONFIG_PATH` environment variable
+
+### ☸️ Helm Chart
+
+- Add `.Values.app.configLocationOverride` parameter
+- Bump default image tag to `v0.2.0`
+
+## v0.1.1
+
+### ☸️ Helm Chart
+
+- Bump default image tag to `v0.1.1`
+
+### 👻 Maintenance
+
+- Bump Golang version to 1.18
+- Update dependencies to newest versions
+
+## v0.1.0
+
+Initial release
diff --git a/README.md b/README.md
index efb8c47..be3fcb3 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@ Luckily, both endpoints have a proper REST API to communicate with each others.
     - [SonarQube](#sonarqube)
     - [Gitea](#gitea)
     - [CI system](#ci-system)
+  - [Changelog](#changelog)
   - [Contributing](#contributing)
   - [License](#license)
   - [Screenshots](#screenshots)
@@ -102,6 +103,10 @@ To mitigate that situation, the bot will look inside the `properties` object for
 key can contain the actual commit hash to use for updating the status in Gitea.  
 See [SonarQube docs](https://docs.sonarqube.org/latest/project-administration/webhooks) for details.
 
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md) for a complete list of changes.
+
 ## Contributing
 
 Expected workflow is: Fork -> Patch -> Push -> Pull Request
diff --git a/helm/README.md b/helm/README.md
index 3cd5ccc..20ba017 100644
--- a/helm/README.md
+++ b/helm/README.md
@@ -26,6 +26,10 @@ You have to modify the `app.configuration` values. Otherwise, the bot won't star
 to your Gitea instance. See [config.example.yaml](https://codeberg.org/justusbunsi/gitea-sonarqube-bot/src/branch/main/config/config.example.yaml)
 for full configuration options.
 
+## Changelog
+
+You can find a full changelog in the [main repository](https://codeberg.org/justusbunsi/gitea-sonarqube-bot/src/branch/main/CHANGELOG.md) of this project.
+
 ## Parameters
 
 ### Common parameters